Applications API Overview

Comprehensive API reference for managing applications in Dokploy - create, deploy, and manage containerized applications with multiple source providers

The Applications API provides complete control over your containerized applications in Dokploy. Deploy from GitHub, GitLab, Bitbucket, Gitea, Docker registries, or custom Git repositories.

Core Concepts

Application Lifecycle

Applications in Dokploy follow a complete lifecycle:

• Create: Initialize a new application with basic configuration
• Configure: Set up source providers, build settings, and environment variables
• Deploy: Build and deploy your application
• Manage: Start, stop, reload, and monitor running applications
• Update: Modify configuration and redeploy
• Delete: Remove applications and clean up resources

Application Status

Applications can be in one of four states:

• idle - Application is not running
• running - Application is currently building or deploying
• done - Application is successfully deployed and running
• error - Application encountered an error during deployment

Source Types

Dokploy supports multiple source types for deploying applications:

• github - Deploy from GitHub repositories
• gitlab - Deploy from GitLab repositories
• bitbucket - Deploy from Bitbucket repositories
• gitea - Deploy from Gitea repositories
• docker - Deploy from Docker images in registries
• git - Deploy from custom Git repositories with SSH keys
• drop - Deploy by uploading a ZIP file

Build Types

Applications can be built using different build strategies:

• nixpacks (default) - Automatic buildpack detection
• dockerfile - Use Dockerfile for building
• heroku_buildpacks - Heroku buildpacks support
• paketo_buildpacks - Cloud Native Buildpacks
• railpack - Specialized Rails buildpack
• static - Static site deployment

Available Endpoints

Application Management

Create Application

Create a new application with basic configuration

Get Application

Retrieve detailed information about an application

Update Application

Update application settings and configuration

Delete Application

Remove an application and clean up resources

Deployment Operations

Deploy Application

Trigger a new deployment from source

Redeploy Application

Rebuild and redeploy the current version

Cancel Deployment

Cancel an in-progress deployment

Application Control

Start Application

Start a stopped application container

Stop Application

Stop a running application container

Reload Application

Reload application configuration without redeploying

Authentication

All Application API endpoints require authentication using a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Base URL

All API requests should be made to:

https://your-dokploy-instance.com/api

Common Parameters

Application ID

Most endpoints require an applicationId parameter to identify the specific application:

{
  "applicationId": "cm5r8k9p00001xyz"
}

Environment ID

When creating applications, you must specify an environmentId to associate the application with a project environment:

{
  "environmentId": "cm5r8k9p00002xyz"
}

Response Format

API responses return JSON objects with relevant data. Error responses follow this format:

{
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}

Rate Limiting

API requests are subject to rate limiting based on your Dokploy instance configuration. Check the response headers for rate limit information.

Next Steps

Create Your First Application

Learn how to create applications via the API

Deploy Applications

Trigger deployments and manage the deployment lifecycle