Dokploy
Generated

Deployment

GET
/deployment.all

Deployment all

/deployment.all

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

applicationId
Required
string

Minimum length: 1
curl -X GET "https://your-dokploy-instance.com/api/deployment.all?applicationId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/deployment.allByCompose

Deployment all By Compose

/deployment.allByCompose

The Authorization access token

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/deployment.allByCompose?composeId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/deployment.allByServer

Deployment all By Server

/deployment.allByServer

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

serverId
Required
string

Minimum length: 1
curl -X GET "https://your-dokploy-instance.com/api/deployment.allByServer?serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/deployment.allByType

Deployment all By Type

/deployment.allByType

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

id
Required
string

Minimum length: 1

type
Required
string

Value in: "application" | "compose" | "server" | "schedule" | "previewDeployment" | "backup" | "volumeBackup"
curl -X GET "https://your-dokploy-instance.com/api/deployment.allByType?id=string&type=application" \
  -H "Authorization: <token>"

Successful response

{}

POST
/deployment.killProcess

Deployment kill Process

/deployment.killProcess

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

deploymentId
Required
string

Minimum length: 1
curl -X POST "https://your-dokploy-instance.com/api/deployment.killProcess" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "deploymentId": "string"
  }'

Successful response

{}

Previous

Compose

Next

Destination