Compose

POST

/compose.create

Compose create

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`name`
Required
string

Minimum length: 1

`description`string | null

`environmentId`
Required
string

`composeType`string

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

`appName`string

`serverId`string | null

`composeFile`string

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

Successful response

{}

GET

/compose.one

Compose one

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.update

Compose update

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

`name`string

Minimum length: 1

`appName`string

`description`string | null

`env`string | null

`composeFile`string

`refreshToken`string | null

`sourceType`string

`composeType`string

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

`repository`string | null

`owner`string | null

`branch`string | null

`autoDeploy`boolean | null

`gitlabProjectId`number | null

`gitlabRepository`string | null

`gitlabOwner`string | null

`gitlabBranch`string | null

`gitlabPathNamespace`string | null

`bitbucketRepository`string | null

`bitbucketOwner`string | null

`bitbucketBranch`string | null

`giteaRepository`string | null

`giteaOwner`string | null

`giteaBranch`string | null

`customGitUrl`string | null

`customGitBranch`string | null

`customGitSSHKeyId`string | null

`command`string

`enableSubmodules`boolean

`composePath`string

Minimum length: 1

`suffix`string

`randomize`boolean

`isolatedDeployment`boolean

`isolatedDeploymentsVolume`boolean

`triggerType`string | null

Value in: "push" | "tag"

`composeStatus`string

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

`environmentId`string

`createdAt`string

`watchPaths`array<string> | null

`githubId`string | null

`gitlabId`string | null

`bitbucketId`string | null

`giteaId`string | null

curl -X POST "https://your-dokploy-instance.com/api/compose.update" \
  -H "Authorization: <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",
    "giteaRepository": "string",
    "giteaOwner": "string",
    "giteaBranch": "string",
    "customGitUrl": "string",
    "customGitBranch": "string",
    "customGitSSHKeyId": "string",
    "command": "string",
    "enableSubmodules": true,
    "composePath": "string",
    "suffix": "string",
    "randomize": true,
    "isolatedDeployment": true,
    "isolatedDeploymentsVolume": true,
    "triggerType": "push",
    "composeStatus": "idle",
    "environmentId": "string",
    "createdAt": "string",
    "watchPaths": [
      "string"
    ],
    "githubId": "string",
    "gitlabId": "string",
    "bitbucketId": "string",
    "giteaId": "string"
  }'

Successful response

{}

POST

/compose.delete

Compose delete

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

`deleteVolumes`
Required
boolean

curl -X POST "https://your-dokploy-instance.com/api/compose.delete" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string",
    "deleteVolumes": true
  }'

Successful response

{}

POST

/compose.cleanQueues

Compose clean Queues

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.killBuild

Compose kill Build

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

GET

/compose.loadServices

Compose load Services

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`composeId`
Required
string

Minimum length: 1

`type`Any properties in not unknown, string

Default: "cache"

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

Successful response

{}

GET

/compose.loadMountsByService

Compose load Mounts By Service

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`composeId`
Required
string

Minimum length: 1

`serviceName`
Required
string

Minimum length: 1

curl -X GET "https://your-dokploy-instance.com/api/compose.loadMountsByService?composeId=string&serviceName=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/compose.fetchSourceType

Compose fetch Source Type

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.randomizeCompose

Compose randomize Compose

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

`suffix`string

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

Successful response

{}

POST

/compose.isolatedDeployment

Compose isolated Deployment

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

`suffix`string

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

Successful response

{}

GET

/compose.getConvertedCompose

Compose get Converted Compose

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.deploy

Compose deploy

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

`title`string

`description`string

curl -X POST "https://your-dokploy-instance.com/api/compose.deploy" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string",
    "title": "string",
    "description": "string"
  }'

Successful response

{}

POST

/compose.redeploy

Compose redeploy

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

`title`string

`description`string

curl -X POST "https://your-dokploy-instance.com/api/compose.redeploy" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string",
    "title": "string",
    "description": "string"
  }'

Successful response

{}

POST

/compose.stop

Compose stop

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.start

Compose start

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

GET

/compose.getDefaultCommand

Compose get Default Command

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.refreshToken

Compose refresh Token

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.deployTemplate

Compose deploy Template

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`environmentId`
Required
string

`serverId`string

`id`
Required
string

`baseUrl`string

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

Successful response

{}

GET

/compose.templates

Compose templates

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`baseUrl`string

curl -X GET "https://your-dokploy-instance.com/api/compose.templates?baseUrl=string" \
  -H "Authorization: <token>"

Successful response

{}

GET

/compose.getTags

Compose get Tags

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`baseUrl`string

curl -X GET "https://your-dokploy-instance.com/api/compose.getTags?baseUrl=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/compose.disconnectGitProvider

Compose disconnect Git Provider

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.move

Compose move

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

`targetEnvironmentId`
Required
string

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

Successful response

{}

POST

/compose.processTemplate

Compose process Template

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`base64`
Required
string

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.import

Compose import

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`base64`
Required
string

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/compose.cancelDeployment

Compose cancel Deployment

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`composeId`
Required
string

Minimum length: 1

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

Successful response

{}

Body

Authorization<token>

nameRequiredstring

descriptionstring | null

environmentIdRequiredstring

composeTypestring

appNamestring

serverIdstring | null

composeFilestring

Response

TypeScript

Query

Authorization<token>

composeIdRequiredstring

Response

TypeScript

Body

Authorization<token>

composeIdRequiredstring

namestring

appNamestring

descriptionstring | null

envstring | null

composeFilestring

refreshTokenstring | null

sourceTypestring

composeTypestring

repositorystring | null

ownerstring | null

branchstring | null

autoDeployboolean | null

gitlabProjectIdnumber | null

gitlabRepositorystring | null

gitlabOwnerstring | null

gitlabBranchstring | null

gitlabPathNamespacestring | null

bitbucketRepositorystring | null

bitbucketOwnerstring | null

bitbucketBranchstring | null

giteaRepositorystring | null

giteaOwnerstring | null

giteaBranchstring | null

customGitUrlstring | null

customGitBranchstring | null

customGitSSHKeyIdstring | null

commandstring

enableSubmodulesboolean

composePathstring

suffixstring

randomizeboolean

isolatedDeploymentboolean

isolatedDeploymentsVolumeboolean

triggerTypestring | null

composeStatusstring

environmentIdstring

createdAtstring

watchPathsarray<string> | null

githubIdstring | null

gitlabIdstring | null

bitbucketIdstring | null

giteaIdstring | null

Response

TypeScript

Body

Authorization<token>

composeIdRequiredstring

deleteVolumesRequiredboolean

Response

TypeScript

Body

Authorization<token>

composeIdRequiredstring

Response

TypeScript

Body

Authorization<token>

composeIdRequiredstring

Response

TypeScript

`Authorization`<token>

`name`
Required
string

`description`string | null

`environmentId`
Required
string

`composeType`string

`appName`string

`serverId`string | null

`composeFile`string

`Authorization`<token>

`composeId`
Required
string

`Authorization`<token>

`composeId`
Required
string

`name`string

`appName`string

`description`string | null

`env`string | null

`composeFile`string

`refreshToken`string | null

`sourceType`string

`composeType`string

`repository`string | null

`owner`string | null

`branch`string | null

`autoDeploy`boolean | null

`gitlabProjectId`number | null

`gitlabRepository`string | null

`gitlabOwner`string | null

`gitlabBranch`string | null

`gitlabPathNamespace`string | null

`bitbucketRepository`string | null

`bitbucketOwner`string | null

`bitbucketBranch`string | null

`giteaRepository`string | null

`giteaOwner`string | null

`giteaBranch`string | null

`customGitUrl`string | null

`customGitBranch`string | null

`customGitSSHKeyId`string | null

`command`string

`enableSubmodules`boolean

`composePath`string

`suffix`string

`randomize`boolean

`isolatedDeployment`boolean

`isolatedDeploymentsVolume`boolean

`triggerType`string | null

`composeStatus`string

`environmentId`string

`createdAt`string

`watchPaths`array<string> | null

`githubId`string | null

`gitlabId`string | null

`bitbucketId`string | null

`giteaId`string | null

`Authorization`<token>

`composeId`
Required
string

`deleteVolumes`
Required
boolean

`Authorization`<token>

`composeId`
Required
string

`Authorization`<token>

`composeId`
Required
string

`Authorization`<token>

`composeId`
Required
string

`type`Any properties in not unknown, string

`Authorization`<token>

`composeId`
Required
string

`serviceName`
Required
string

`Authorization`<token>

`composeId`
Required
string

`Authorization`<token>

`composeId`
Required
string

`suffix`string

`Authorization`<token>

`composeId`
Required
string

`suffix`string

`Authorization`<token>

`composeId`
Required
string