Dokploy

Compose

POST
/compose.create

Compose create

/compose.create

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

descriptionstring | null

projectId
Required
string

composeTypestring

Value in: "docker-compose" | "stack"

appNamestring

serverIdstring | null

curl -X POST "http://your-dokploy-instance.com/api/compose.create" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "projectId": "string",
    "composeType": "docker-compose",
    "appName": "string",
    "serverId": "string"
  }'

Successful response

GET
/compose.one

Compose one

/compose.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1
curl -X GET "http://your-dokploy-instance.com/api/compose.one?composeId=string" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/compose.update

Compose update

/compose.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

namestring

Minimum length: 1

appNamestring

descriptionstring | null

envstring | null

composeFilestring

refreshTokenstring | null

sourceTypestring

Value in: "git" | "github" | "gitlab" | "bitbucket" | "raw"

composeTypestring

Value in: "docker-compose" | "stack"

repositorystring | null

ownerstring | null

branchstring | null

autoDeployboolean | null

gitlabProjectIdnumber | null

gitlabRepositorystring | null

gitlabOwnerstring | null

gitlabBranchstring | null

gitlabPathNamespacestring | null

bitbucketRepositorystring | null

bitbucketOwnerstring | null

bitbucketBranchstring | null

customGitUrlstring | null

customGitBranchstring | null

customGitSSHKeyIdstring | null

commandstring

composePathstring

Minimum length: 1

suffixstring

randomizeboolean

composeStatusstring

Value in: "idle" | "running" | "done" | "error"

projectIdstring

createdAtstring

githubIdstring | null

gitlabIdstring | null

bitbucketIdstring | null

curl -X POST "http://your-dokploy-instance.com/api/compose.update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string",
    "name": "string",
    "appName": "string",
    "description": "string",
    "env": "string",
    "composeFile": "string",
    "refreshToken": "string",
    "sourceType": "git",
    "composeType": "docker-compose",
    "repository": "string",
    "owner": "string",
    "branch": "string",
    "autoDeploy": true,
    "gitlabProjectId": 0,
    "gitlabRepository": "string",
    "gitlabOwner": "string",
    "gitlabBranch": "string",
    "gitlabPathNamespace": "string",
    "bitbucketRepository": "string",
    "bitbucketOwner": "string",
    "bitbucketBranch": "string",
    "customGitUrl": "string",
    "customGitBranch": "string",
    "customGitSSHKeyId": "string",
    "command": "string",
    "composePath": "string",
    "suffix": "string",
    "randomize": true,
    "composeStatus": "idle",
    "projectId": "string",
    "createdAt": "string",
    "githubId": "string",
    "gitlabId": "string",
    "bitbucketId": "string"
  }'

Successful response

POST
/compose.delete

Compose delete

/compose.delete

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/compose.delete" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

Successful response

POST
/compose.cleanQueues

Compose clean Queues

/compose.cleanQueues

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/compose.cleanQueues" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

Successful response

GET
/compose.loadServices

Compose load Services

/compose.loadServices

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1

typeAny properties in not unknown, string

Default: "cache"
curl -X GET "http://your-dokploy-instance.com/api/compose.loadServices?composeId=string&type=cache" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/compose.fetchSourceType

Compose fetch Source Type

/compose.fetchSourceType

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/compose.fetchSourceType" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

Successful response

POST
/compose.randomizeCompose

Compose randomize Compose

/compose.randomizeCompose

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

Minimum length: 1

suffixstring

curl -X POST "http://your-dokploy-instance.com/api/compose.randomizeCompose" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string",
    "suffix": "string"
  }'

Successful response

GET
/compose.getConvertedCompose

Compose get Converted Compose

/compose.getConvertedCompose

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1
curl -X GET "http://your-dokploy-instance.com/api/compose.getConvertedCompose?composeId=string" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/compose.deploy

Compose deploy

/compose.deploy

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/compose.deploy" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

Successful response

POST
/compose.redeploy

Compose redeploy

/compose.redeploy

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/compose.redeploy" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

Successful response

POST
/compose.stop

Compose stop

/compose.stop

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/compose.stop" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

Successful response

GET
/compose.getDefaultCommand

Compose get Default Command

/compose.getDefaultCommand

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1
curl -X GET "http://your-dokploy-instance.com/api/compose.getDefaultCommand?composeId=string" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/compose.refreshToken

Compose refresh Token

/compose.refreshToken

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

composeId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/compose.refreshToken" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

Successful response

POST
/compose.deployTemplate

Compose deploy Template

/compose.deployTemplate

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

projectId
Required
string

id
Required
string

Minimum length: 1

serverIdstring

curl -X POST "http://your-dokploy-instance.com/api/compose.deployTemplate" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "string",
    "id": "string",
    "serverId": "string"
  }'

Successful response

GET
/compose.templates

Compose templates

/compose.templates

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

curl -X GET "http://your-dokploy-instance.com/api/compose.templates" \
  -H "Authorization: Bearer <token>"

Successful response

GET
/compose.getTags

Compose get Tags

/compose.getTags

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

curl -X GET "http://your-dokploy-instance.com/api/compose.getTags" \
  -H "Authorization: Bearer <token>"

Successful response