Dokploy

Compose

Compose create

POST
/compose.create

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

name*string
Length1 <= length
description?string|null
environmentId*string
composeType?string
Value in"docker-compose" | "stack"
appName?string
serverId?string|null
composeFile?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "environmentId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose one

GET
/compose.one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

composeId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/compose.one?composeId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose update

POST
/compose.update

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
name?string
Length1 <= length
appName?string
description?string|null
env?string|null
composeFile?string
refreshToken?string|null
sourceType?string
Value in"git" | "github" | "gitlab" | "bitbucket" | "gitea" | "raw"
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
Length1 <= length
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?|null
githubId?string|null
gitlabId?string|null
bitbucketId?string|null
giteaId?string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.update" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose delete

POST
/compose.delete

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
deleteVolumes*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.delete" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string",    "deleteVolumes": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose clean Queues

POST
/compose.cleanQueues

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.cleanQueues" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose kill Build

POST
/compose.killBuild

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.killBuild" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose load Services

GET
/compose.loadServices

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

composeId*string
Length1 <= length
type?not unknown|string
Default"cache"

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/compose.loadServices?composeId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose load Mounts By Service

GET
/compose.loadMountsByService

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

composeId*string
Length1 <= length
serviceName*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/compose.loadMountsByService?composeId=string&serviceName=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose fetch Source Type

POST
/compose.fetchSourceType

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.fetchSourceType" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose randomize Compose

POST
/compose.randomizeCompose

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
suffix?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.randomizeCompose" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose isolated Deployment

POST
/compose.isolatedDeployment

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
suffix?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.isolatedDeployment" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose get Converted Compose

GET
/compose.getConvertedCompose

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

composeId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/compose.getConvertedCompose?composeId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose deploy

POST
/compose.deploy

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
title?string
description?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.deploy" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose redeploy

POST
/compose.redeploy

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
title?string
description?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.redeploy" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose stop

POST
/compose.stop

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.stop" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose start

POST
/compose.start

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.start" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose get Default Command

GET
/compose.getDefaultCommand

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

composeId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/compose.getDefaultCommand?composeId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose refresh Token

POST
/compose.refreshToken

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.refreshToken" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose deploy Template

POST
/compose.deployTemplate

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

environmentId*string
serverId?string
id*string
baseUrl?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.deployTemplate" \  -H "Content-Type: application/json" \  -d '{    "environmentId": "string",    "id": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose templates

GET
/compose.templates

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

baseUrl?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/compose.templates"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose get Tags

GET
/compose.getTags

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

baseUrl?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/compose.getTags"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose disconnect Git Provider

POST
/compose.disconnectGitProvider

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.disconnectGitProvider" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose move

POST
/compose.move

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
targetEnvironmentId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.move" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string",    "targetEnvironmentId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose process Template

POST
/compose.processTemplate

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

base64*string
composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.processTemplate" \  -H "Content-Type: application/json" \  -d '{    "base64": "string",    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose import

POST
/compose.import

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

base64*string
composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.import" \  -H "Content-Type: application/json" \  -d '{    "base64": "string",    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Compose cancel Deployment

POST
/compose.cancelDeployment

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

composeId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/compose.cancelDeployment" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Cluster

Previous Page

Deployment

Next Page