Dokploy
Generated

Docker

GET
/docker.getContainers

Docker get Containers

/docker.getContainers

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

serverIdstring

curl -X GET "https://your-dokploy-instance.com/api/docker.getContainers?serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/docker.restartContainer

Docker restart Container

/docker.restartContainer

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

containerId
Required
string

Minimum length: 1Pattern: "^[a-zA-Z0-9.\\-_]+$"
curl -X POST "https://your-dokploy-instance.com/api/docker.restartContainer" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "string"
  }'

Successful response

{}

GET
/docker.getConfig

Docker get Config

/docker.getConfig

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

containerId
Required
string

Minimum length: 1Pattern: "^[a-zA-Z0-9.\\-_]+$"

serverIdstring

curl -X GET "https://your-dokploy-instance.com/api/docker.getConfig?containerId=string&serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/docker.getContainersByAppNameMatch

Docker get Containers By App Name Match

/docker.getContainersByAppNameMatch

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

appTypeAny properties in string, string

appName
Required
string

Minimum length: 1Pattern: "^[a-zA-Z0-9.\\-_]+$"

serverIdstring

curl -X GET "https://your-dokploy-instance.com/api/docker.getContainersByAppNameMatch?appType=stack&appName=string&serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/docker.getContainersByAppLabel

Docker get Containers By App Label

/docker.getContainersByAppLabel

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

appName
Required
string

Minimum length: 1Pattern: "^[a-zA-Z0-9.\\-_]+$"

serverIdstring

type
Required
string

Value in: "standalone" | "swarm"
curl -X GET "https://your-dokploy-instance.com/api/docker.getContainersByAppLabel?appName=string&serverId=string&type=standalone" \
  -H "Authorization: <token>"

Successful response

{}

GET
/docker.getStackContainersByAppName

Docker get Stack Containers By App Name

/docker.getStackContainersByAppName

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

appName
Required
string

Minimum length: 1Pattern: "^[a-zA-Z0-9.\\-_]+$"

serverIdstring

curl -X GET "https://your-dokploy-instance.com/api/docker.getStackContainersByAppName?appName=string&serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/docker.getServiceContainersByAppName

Docker get Service Containers By App Name

/docker.getServiceContainersByAppName

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

appName
Required
string

Minimum length: 1Pattern: "^[a-zA-Z0-9.\\-_]+$"

serverIdstring

curl -X GET "https://your-dokploy-instance.com/api/docker.getServiceContainersByAppName?appName=string&serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

Previous

Destination

Next

Domain