Deployment
Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
applicationId*string
Length
1 <= lengthResponse Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/deployment.all?applicationId=string"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
composeId*string
Length
1 <= lengthResponse Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/deployment.allByCompose?composeId=string"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
serverId*string
Length
1 <= lengthResponse Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/deployment.allByServer?serverId=string"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
id*string
Length
1 <= lengthtype*string
Value in
"application" | "compose" | "server" | "schedule" | "previewDeployment" | "backup" | "volumeBackup"Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/deployment.allByType?id=string&type=application"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
deploymentId*string
Length
1 <= length[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/deployment.killProcess" \ -H "Content-Type: application/json" \ -d '{ "deploymentId": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}