Docker

Docker get Containers

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

serverId?string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.getContainers"

curl -X GET "https://your-dokploy-instance.com/api/docker.getContainers"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker get Server Health

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

serverId?string

sinceHours?integer

Range1 <= value <= 168

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.getServerHealth"

curl -X GET "https://your-dokploy-instance.com/api/docker.getServerHealth"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker restart Container

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/docker.restartContainer" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/docker.restartContainer" \  -H "Content-Type: application/json" \  -d '{    "containerId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker start Container

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/docker.startContainer" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/docker.startContainer" \  -H "Content-Type: application/json" \  -d '{    "containerId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker stop Container

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/docker.stopContainer" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/docker.stopContainer" \  -H "Content-Type: application/json" \  -d '{    "containerId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker kill Container

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/docker.killContainer" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/docker.killContainer" \  -H "Content-Type: application/json" \  -d '{    "containerId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker remove Container

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/docker.removeContainer" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/docker.removeContainer" \  -H "Content-Type: application/json" \  -d '{    "containerId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker get Config

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.getConfig?containerId=string"

curl -X GET "https://your-dokploy-instance.com/api/docker.getConfig?containerId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker get Containers By App Name Match

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

appType?string

Value in"stack" | "docker-compose"

appName*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.getContainersByAppNameMatch?appName=string"

curl -X GET "https://your-dokploy-instance.com/api/docker.getContainersByAppNameMatch?appName=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker get Containers By App Label

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

appName*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

type*string

Value in"standalone" | "swarm"

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.getContainersByAppLabel?appName=string&type=standalone"

curl -X GET "https://your-dokploy-instance.com/api/docker.getContainersByAppLabel?appName=string&type=standalone"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker get Stack Containers By App Name

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

appName*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.getStackContainersByAppName?appName=string"

curl -X GET "https://your-dokploy-instance.com/api/docker.getStackContainersByAppName?appName=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker get Service Containers By App Name

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

appName*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.getServiceContainersByAppName?appName=string"

curl -X GET "https://your-dokploy-instance.com/api/docker.getServiceContainersByAppName?appName=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker upload File To Container

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

multipart/form-data

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

file*file

Formatbinary

destinationPath*string

Match^[a-zA-Z0-9.\-_/]+$

Length1 <= length

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/docker.uploadFileToContainer" \
  -F containerId="string" \
  -F file="string" \
  -F destinationPath="string"

curl -X POST "https://your-dokploy-instance.com/api/docker.uploadFileToContainer" \  -F containerId="string" \  -F file="string" \  -F destinationPath="string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker list Container Files

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

path*string

Length1 <= length <= 4096

serverId?string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.listContainerFiles?containerId=string&path=string"

curl -X GET "https://your-dokploy-instance.com/api/docker.listContainerFiles?containerId=string&path=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker read Container File

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

path*string

Length1 <= length <= 4096

serverId?string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.readContainerFile?containerId=string&path=string"

curl -X GET "https://your-dokploy-instance.com/api/docker.readContainerFile?containerId=string&path=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker write Container File

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

path*string

Length1 <= length <= 4096

content*string

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/docker.writeContainerFile" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "string",
    "path": "string",
    "content": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/docker.writeContainerFile" \  -H "Content-Type: application/json" \  -d '{    "containerId": "string",    "path": "string",    "content": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker delete Container File

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

containerId*string

Match^[a-zA-Z0-9.\-_]+$

Length1 <= length

path*string

Length1 <= length <= 4096

serverId?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/docker.deleteContainerFile" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "string",
    "path": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/docker.deleteContainerFile" \  -H "Content-Type: application/json" \  -d '{    "containerId": "string",    "path": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Docker get Events

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

serverId?string

minutes?number

Default15

Range1 <= value <= 1440

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/docker.getEvents"

curl -X GET "https://your-dokploy-instance.com/api/docker.getEvents"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`