Create Application

Create a new application in a specific environment. This endpoint initializes an application with basic configuration that can be further customized with source providers and build settings.

Endpoint

POST /application.create

Request Body

string

required

Display name for the application

string

required

ID of the environment where the application will be created

string

Internal application name used for Docker containers and routing. If not provided, will be auto-generated from the display name.

string

Optional description of the application

string

Server ID where the application will be deployed (required for cloud deployments)

Response

Returns the created application object with generated applicationId and default configuration.

string

Unique identifier for the created application

string

Display name of the application

string

Internal application name

string

ID of the parent environment

string

Current status: idle, running, done, or error

string

Default source type (initially github)

string

Default build type (initially nixpacks)

string

ISO 8601 timestamp of creation

Example Request

curl -X POST https://your-dokploy-instance.com/api/application.create \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Web App",
    "appName": "my-web-app",
    "description": "Production web application",
    "environmentId": "env_abc123",
    "serverId": "server_xyz789"
  }'

Example Response

{
  "applicationId": "app_def456",
  "name": "My Web App",
  "appName": "my-web-app",
  "description": "Production web application",
  "environmentId": "env_abc123",
  "serverId": "server_xyz789",
  "applicationStatus": "idle",
  "sourceType": "github",
  "buildType": "nixpacks",
  "createdAt": "2024-03-06T10:30:00.000Z",
  "env": null,
  "buildArgs": null,
  "memoryLimit": null,
  "cpuLimit": null
}

Get Application

Retrieve details of a specific application including its configuration, deployment status, and Git provider access status.

Endpoint

GET /application.one

Query Parameters

string

required

ID of the application to retrieve

Response

Returns the complete application object with all configuration details.

string

Unique identifier for the application

string

Display name of the application

string

Internal application name

string

Current status: idle, running, done, or error

string

Source provider: github, gitlab, bitbucket, gitea, docker, git, or drop

string

Build system: dockerfile, nixpacks, heroku_buildpacks, paketo_buildpacks, railpack, or static

string

Repository name (for Git-based sources)

string

Repository owner or organization

string

Git branch to deploy from

string

Path within repository to build from

string

Path to Dockerfile (for dockerfile build type)

string

Docker image name (for docker source type)

string

Environment variables as key=value pairs

string

Build-time arguments

string

Memory limit (e.g., “512m”, “1g”)

string

Memory reservation

string

CPU limit

string

CPU reservation

boolean

Whether the current user has access to the configured Git provider

string

Git provider name if access is not available

object

Parent environment details

array

Array of deployment records

Example Request

curl -X GET "https://your-dokploy-instance.com/api/application.one?applicationId=app_def456" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
  "applicationId": "app_def456",
  "name": "My Web App",
  "appName": "my-web-app",
  "description": "Production web application",
  "applicationStatus": "done",
  "sourceType": "github",
  "buildType": "nixpacks",
  "repository": "my-repo",
  "owner": "my-org",
  "branch": "main",
  "buildPath": "/",
  "env": "NODE_ENV=production\nPORT=3000",
  "memoryLimit": "1g",
  "cpuLimit": "1",
  "hasGitProviderAccess": true,
  "unauthorizedProvider": null,
  "createdAt": "2024-03-06T10:30:00.000Z",
  "environment": {
    "environmentId": "env_abc123",
    "name": "Production",
    "project": {
      "projectId": "proj_123",
      "name": "My Project"
    }
  },
  "deployments": [
    {
      "deploymentId": "deploy_123",
      "status": "success",
      "createdAt": "2024-03-06T12:00:00.000Z"
    }
  ]
}

Update Application

Update application configuration including name, description, resource limits, and various deployment settings.

Endpoint

POST /application.update

Request Body

string

required

ID of the application to update

string

New display name

string

New internal name

string

Updated description

string

Environment variables (newline-separated KEY=VALUE pairs)

string

Memory limit (e.g., “512m”, “2g”)

string

Memory reservation

string

CPU limit (e.g., “0.5”, “2”)

string

CPU reservation

string

Custom command to run

array

Command arguments

boolean

Enable automatic deployments on Git push

boolean

Clear build cache on next deployment

number

Number of replicas (for Swarm mode)

Example Request

curl -X POST https://your-dokploy-instance.com/api/application.update \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "app_def456",
    "name": "My Updated Web App",
    "description": "Updated production application",
    "memoryLimit": "2g",
    "cpuLimit": "1.5",
    "autoDeploy": true
  }'

Example Response

{
  "success": true
}

Search Applications

Search and filter applications across your organization with pagination support.

Endpoint

GET /application.search

Query Parameters

string

Search term to match against name, appName, description, repository, owner, or dockerImage

string

Filter by application name

string

Filter by internal app name

string

Filter by description

string

Filter by repository name

string

Filter by repository owner

string

Filter by Docker image name

string

Filter by project ID

string

Filter by environment ID

number

default:"20"

Maximum number of results (1-100)

number

default:"0"

Number of results to skip

Response

array

Array of matching applications

number

Total number of matching applications

Example Request

curl -X GET "https://your-dokploy-instance.com/api/application.search?q=web&limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
  "items": [
    {
      "applicationId": "app_def456",
      "name": "My Web App",
      "appName": "my-web-app",
      "description": "Production web application",
      "environmentId": "env_abc123",
      "applicationStatus": "done",
      "sourceType": "github",
      "createdAt": "2024-03-06T10:30:00.000Z"
    },
    {
      "applicationId": "app_ghi789",
      "name": "Web API",
      "appName": "web-api",
      "description": "REST API service",
      "environmentId": "env_abc123",
      "applicationStatus": "idle",
      "sourceType": "docker",
      "createdAt": "2024-03-05T14:20:00.000Z"
    }
  ],
  "total": 2
}

Getting Started

Applications

Databases

Docker

Projects & Deployments

Monitoring

Administration

Create Application