Deployments

Overview

Deployments in Dokploy track the build and deployment history of your applications and compose services. Each deployment contains logs, status, and metadata about the build process.

Get Application Deployments

Retrieve all deployments for a specific application.

string

required

The unique identifier of the application.

Response

Returns an array of deployment objects with details about each deployment including:

Deployment ID and status
Creation timestamp
Title and description
Build logs
Commit information (if from Git)

cURL

curl -X GET "https://your-dokploy-instance.com/api/deployment.all?applicationId=app-123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Compose Deployments

Retrieve all deployments for a Docker Compose application.

string

required

The unique identifier of the compose application.

cURL

curl -X GET "https://your-dokploy-instance.com/api/deployment.allByCompose?composeId=compose-123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Server Deployments

Get all deployments for applications running on a specific server.

string

required

The server ID to query deployments for.

cURL

curl -X GET "https://your-dokploy-instance.com/api/deployment.allByServer?serverId=server-123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get All Deployments (Centralized)

Retrieve all deployments across your organization.

Response

Returns a centralized view of all deployments for applications and services you have access to.

cURL

curl -X GET "https://your-dokploy-instance.com/api/deployment.allCentralized" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Deployment Queue

View the current deployment queue showing pending and in-progress builds.

Response

Returns an array of queued jobs with:

Job ID and name
Current state (waiting, active, completed, failed)
Timestamps (queued, started, finished)
Service path information
Failure reason (if applicable)

cURL

curl -X GET "https://your-dokploy-instance.com/api/deployment.queueList" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Deployments by Type

Retrieve deployments for a specific service by type.

string

required

The service type: application, compose, postgres, mysql, mariadb, mongo, or redis.

string

required

The service ID to get deployments for.

cURL

curl -X GET "https://your-dokploy-instance.com/api/deployment.allByType?type=application&id=app-123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Kill Deployment Process

Force stop a running deployment.

string

required

The ID of the deployment to terminate.

This will forcefully kill the deployment process. Use with caution as it may leave the application in an inconsistent state.

cURL

curl -X POST "https://your-dokploy-instance.com/api/deployment.killProcess" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "deploymentId": "deploy-123"
  }'

Delete Deployment

Remove a deployment from the history.

string

required

The ID of the deployment to delete.

cURL

curl -X POST "https://your-dokploy-instance.com/api/deployment.removeDeployment" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "deploymentId": "deploy-123"
  }'

Deployment Status

Deployments can have the following statuses:

string

Deployment is queued but not started.

string

Deployment is currently in progress.

string

Deployment completed successfully.

string

Deployment failed with errors.

Deployment Workflow

A typical deployment goes through these stages:

Queued - Deployment is added to the queue
Running - Build process starts
- Clone repository (if from Git)
- Build Docker image
- Push to registry (if configured)
- Update container configuration
Deploy - Start new containers
Health Check - Verify application is running
Done - Deployment complete

Monitoring Deployments

View Logs

Deployment logs are included in the deployment response and contain:

Build output
Docker commands
Error messages
Timestamps for each step

Rollback

To rollback a deployment:

Get the list of deployments
Find a previous successful deployment
Use the rollback endpoint (if enabled) or redeploy the previous version

Example: Get Recent Deployments

curl -X GET "https://your-dokploy-instance.com/api/deployment.all?applicationId=app-123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Getting Started

Applications

Databases

Docker

Projects & Deployments

Monitoring

Administration

Overview

Get Application Deployments

Response

Get Compose Deployments

Get Server Deployments

Get All Deployments (Centralized)

Response

Get Deployment Queue

Response

Get Deployments by Type

Kill Deployment Process

Delete Deployment

Deployment Status

Deployment Workflow

Monitoring Deployments

View Logs

Rollback

​Overview

​Get Application Deployments

​Response

​Get Compose Deployments

​Get Server Deployments

​Get All Deployments (Centralized)

​Response

​Get Deployment Queue

​Response

​Get Deployments by Type

​Kill Deployment Process

​Delete Deployment

​Deployment Status

​Deployment Workflow

​Monitoring Deployments

​View Logs

​Rollback

Overview

Get Application Deployments

Response

Get Compose Deployments

Get Server Deployments

Get All Deployments (Centralized)

Response

Get Deployment Queue

Response

Get Deployments by Type

Kill Deployment Process

Delete Deployment

Deployment Status

Deployment Workflow

Monitoring Deployments

View Logs

Rollback