Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Nettalco/dokploy/llms.txt

Use this file to discover all available pages before exploring further.

The Deployments API provides read and management access to every deployment record in Dokploy. You can list deployments per service, per server, or across all services in a centralized view. The API also covers preview deployments (spin-ups triggered by Git pull requests), the BullMQ queue, and rollback operations that restore a previous Docker image.

​
Endpoints

MethodEndpointDescription
GET/deployment.allList all deployments for an application
GET/deployment.allByComposeList all deployments for a Compose stack
GET/deployment.allByServerList deployments on a specific server
GET/deployment.allCentralizedList all deployments across every service
GET/deployment.queueListGet the current deployment job queue
GET/deployment.allByTypeFilter deployments by service type
POST/deployment.killProcessKill a running deployment process
POST/deployment.removeDeploymentDelete a deployment record
GET/previewDeployment.allList all preview deployments for an app
GET/previewDeployment.oneFetch a single preview deployment
POST/previewDeployment.redeployRedeploy a preview deployment
POST/previewDeployment.deleteDelete a preview deployment
POST/rollback.rollbackRoll back to a previous deployment image
POST/rollback.deleteDelete a rollback record

​
Key Endpoints

​
GET /deployment.all

Retrieve the full deployment history for a single application.
​
applicationId
string
required
ID of the application whose deployments to list.
​
deploymentId
string
Unique ID of the deployment.
​
status
string
Deployment status: running, done, error, or queued.
​
createdAt
string
ISO timestamp of when the deployment was created.
​
title
string
Optional deployment label.
​
logPath
string
Path to the deployment log file on the server.
curl -G 'https://your-instance.com/api/deployment.all' \
  -H 'x-api-key: YOUR_API_KEY' \
  --data-urlencode 'applicationId=app_xyz789'

​
GET /deployment.allCentralized

Retrieve deployments across all services — applications and Compose stacks — in a single paginated response. Useful for building an organization-wide activity feed.
​
page
number
Page number (default: 1).
​
limit
number
Results per page (default: 10).
curl -G 'https://your-instance.com/api/deployment.allCentralized' \
  -H 'x-api-key: YOUR_API_KEY' \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=20'

​
POST /deployment.killProcess

Forcefully terminate a deployment that is stuck or running unexpectedly long.
​
deploymentId
string
required
ID of the deployment to kill.
​
serverId
string
Server ID if the deployment is on a remote server.
curl -X POST 'https://your-instance.com/api/deployment.killProcess' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "deploymentId": "dep_abc123"
  }'

​
POST /rollback.rollback

Roll back an application to a previously deployed Docker image. Rollbacks are only available when rollback support is enabled on the application and a previous image tag exists.
​
applicationId
string
required
ID of the application to roll back.
​
rollbackId
string
required
ID of the rollback record to restore.
curl -X POST 'https://your-instance.com/api/rollback.rollback' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "applicationId": "app_xyz789",
    "rollbackId": "rbk_001"
  }'

​
GET /previewDeployment.all

List all preview deployments for an application, typically one per open pull request.
​
applicationId
string
required
ID of the parent application.
​
previewDeploymentId
string
Unique ID of the preview deployment.
​
branch
string
Git branch or PR reference used for this preview.
​
domain
string
Assigned preview domain URL.
​
previewStatus
string
Status: running, done, error, or idle.
curl -G 'https://your-instance.com/api/previewDeployment.all' \
  -H 'x-api-key: YOUR_API_KEY' \
  --data-urlencode 'applicationId=app_xyz789'

​
Notes

Poll deployment.queueList to monitor pending jobs before triggering a new deployment — this prevents queue overflow on busy servers.
Preview deployments require the application to have isPreviewDeploymentsActive set to true. Configure this via application.update.

Build docs developers (and LLMs) love

Get started for freeTalk to us