dokploy/apps/api/README.md

npm install
npm run dev

open http://localhost:3000

Environment Variables

The API server requires the following environment variables for configuration:

Inngest Configuration

Required for the GET /jobs endpoint to list deployment jobs:

• INNGEST_BASE_URL - The base URL for the Inngest instance

  • Self-hosted: http://localhost:8288
  • Production: https://dev-inngest.dokploy.com

• INNGEST_SIGNING_KEY - The signing key for authenticating with Inngest

Optional configuration for filtering and pagination:

• INNGEST_EVENTS_RECEIVED_AFTER (optional) - An RFC3339 timestamp to filter events received after a specific date (e.g., 2024-01-01T00:00:00Z). If unset, no date filter is applied.

• INNGEST_JOBS_MAX_EVENTS (optional) - Maximum number of events to fetch when listing jobs. Default is 100, maximum is 10000. Used for pagination with cursor.

Lemon Squeezy Integration

• LEMON_SQUEEZY_API_KEY - API key for Lemon Squeezy integration
• LEMON_SQUEEZY_STORE_ID - Store ID for Lemon Squeezy integration

Docker Configuration

Dokploy automatically detects Docker sockets in the following priority order:

1. DOCKER_HOST environment variable (if set)
2. Rancher Desktop socket (~/.rd/docker.sock)
3. Standard Docker socket (/var/run/docker.sock)

This automatic detection means that Docker Desktop, Rancher Desktop, Colima, and other Docker alternatives work out-of-the-box without manual configuration.

Optional Environment Variables:

• DOCKER_HOST (optional) - Specifies a custom Docker socket path (e.g., unix:///path/to/docker.sock). When set, this takes priority over automatic socket detection.

• DOCKER_API_VERSION (optional) - Specifies which Docker API version to use when connecting to the Docker daemon. If not set, the Docker client uses the default API version.

Remote Docker Host Configuration:

For connecting to remote Docker daemons, use the following variables:

• DOKPLOY_DOCKER_HOST (optional) - Specifies the remote Docker daemon host to connect to (e.g., tcp://remote-host).

• DOKPLOY_DOCKER_PORT (optional) - Specifies the port for connecting to the remote Docker daemon.

Note: DOKPLOY_DOCKER_HOST and DOKPLOY_DOCKER_PORT are intended for remote Docker host configurations. For local Docker installations, the automatic socket detection handles connection setup without requiring these variables.

API Endpoints

GET /jobs

Lists deployment jobs (Inngest runs) for a specified server.

Query Parameters:

• serverId (required) - The ID of the server to list deployment jobs for

Response: Returns an array of deployment job objects with the same shape as BullMQ queue jobs:

[
  {
    "id": "string",
    "name": "string",
    "data": {},
    "timestamp": 0,
    "processedOn": 0,
    "finishedOn": 0,
    "failedReason": "string",
    "state": "string"
  }
]

Error Responses:

• 400 - serverId is not provided
• 503 - INNGEST_BASE_URL is not configured
• 200 - Empty array on other errors

This endpoint is used by the UI to display deployment queue information in the dashboard.

POST /drop-deployment

Upload and deploy application code via ZIP file.

Content-Type: multipart/form-data

Form Fields:

• applicationId (required) - The ID of the application to deploy
• zip (required) - A ZIP file containing the application code
• dropBuildPath (optional) - Custom build path within the ZIP file

Response: Initiates a deployment using the uploaded ZIP file.

Example:

curl -X POST https://your-dokploy-instance.com/api/drop-deployment \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "applicationId=YOUR_APP_ID" \
  -F "zip=@/path/to/your/app.zip" \
  -F "dropBuildPath=optional/build/path"

Search Endpoints

The following search endpoints provide flexible querying capabilities with pagination support. All search endpoints respect member permissions, returning only resources the user has access to.

application.search

Search applications across name, appName, description, repository, owner, and dockerImage fields.

Query Parameters:

• q (optional string) - General search term that searches across name, appName, description, repository, owner, and dockerImage
• name (optional string) - Filter by application name
• appName (optional string) - Filter by app name
• description (optional string) - Filter by description
• repository (optional string) - Filter by repository
• owner (optional string) - Filter by owner
• dockerImage (optional string) - Filter by Docker image
• projectId (optional string) - Filter by project ID
• environmentId (optional string) - Filter by environment ID
• limit (number, default 20, min 1, max 100) - Maximum number of results
• offset (number, default 0, min 0) - Pagination offset

Response:

{
  "items": [
    {
      "applicationId": "string",
      "name": "string",
      "appName": "string",
      "description": "string",
      "environmentId": "string",
      "applicationStatus": "string",
      "sourceType": "string",
      "createdAt": "string"
    }
  ],
  "total": 0
}

compose.search

Search compose services with filtering by name, appName, and description.

Query Parameters:

• q (optional string) - General search term across name, appName, description
• name (optional string) - Filter by name
• appName (optional string) - Filter by app name
• description (optional string) - Filter by description
• projectId (optional string) - Filter by project ID
• environmentId (optional string) - Filter by environment ID
• limit (number, default 20, min 1, max 100) - Maximum results
• offset (number, default 0, min 0) - Pagination offset

Response:

{
  "items": [
    {
      "composeId": "string",
      "name": "string",
      "appName": "string",
      "description": "string",
      "environmentId": "string",
      "composeStatus": "string",
      "sourceType": "string",
      "createdAt": "string"
    }
  ],
  "total": 0
}

environment.search

Search environments by name and description.

Query Parameters:

• q (optional string) - General search term across name and description
• name (optional string) - Filter by name
• description (optional string) - Filter by description
• projectId (optional string) - Filter by project ID
• limit (number, default 20, min 1, max 100) - Maximum results
• offset (number, default 0, min 0) - Pagination offset

Response:

{
  "items": [
    {
      "environmentId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "env": "string",
      "projectId": "string",
      "isDefault": true
    }
  ],
  "total": 0
}

project.search

Search projects by name and description.

Query Parameters:

• q (optional string) - General search term across name and description
• name (optional string) - Filter by name
• description (optional string) - Filter by description
• limit (number, default 20, min 1, max 100) - Maximum results
• offset (number, default 0, min 0) - Pagination offset

Response:

{
  "items": [
    {
      "projectId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "organizationId": "string",
      "env": "string"
    }
  ],
  "total": 0
}

Database Service Search Endpoints

The following database services all share the same search interface:

• postgres.search
• mysql.search
• mariadb.search
• mongo.search
• redis.search

Query Parameters:

• q (optional string) - General search term across name, appName, description
• name (optional string) - Filter by name
• appName (optional string) - Filter by app name
• description (optional string) - Filter by description
• projectId (optional string) - Filter by project ID
• environmentId (optional string) - Filter by environment ID
• limit (number, default 20, min 1, max 100) - Maximum results
• offset (number, default 0, min 0) - Pagination offset

Response:

{
  "items": [
    {
      "postgresId": "string",
      "name": "string",
      "appName": "string",
      "description": "string",
      "environmentId": "string",
      "applicationStatus": "string",
      "createdAt": "string"
    }
  ],
  "total": 0
}

Note: The response shape is similar across all database services, with the ID field varying (e.g., mysqlId, mariadbId, mongoId, redisId).

Search Behavior:

• All searches use case-insensitive pattern matching with wildcards
• Results are ordered by creation date (descending)
• Members only see services they have access to
• Returns total count for pagination UI

Database Service Update Endpoints

All database services support update operations with flexible configuration options. The following database services share a common update interface:

• postgres.update (apiUpdatePostgres)
• mysql.update (apiUpdateMySql)
• mariadb.update (apiUpdateMariaDB)
• mongo.update (apiUpdateMongo)
• redis.update (apiUpdateRedis)

Common Parameters:

All database update endpoints accept their respective ID field (e.g., postgresId, mysqlId, mariadbId, mongoId, redisId) as a required parameter, along with optional configuration fields.

Optional Configuration:

• dockerImage (optional string) - Specifies a custom Docker image for the database service. This allows users to use specific versions or custom-built images instead of the default image for the database type. Available for all five database services (PostgreSQL, MySQL, MariaDB, MongoDB, and Redis).

Additional service-specific parameters are available depending on the database type. The dockerImage field provides enhanced configuration flexibility for advanced use cases such as version pinning or using specialized database distributions.

Whitelabeling Endpoints

The whitelabeling endpoints allow enterprise/self-hosted Dokploy instances to customize branding, logos, colors, and UI appearance. These endpoints are only available in self-hosted mode (not cloud).

whitelabeling.get

Get the current whitelabeling configuration.

Requirements:

• Enterprise license required
• Only available for self-hosted (not cloud)

Response: Returns the whitelabeling configuration object or null if not configured.

{
  "appName": "string | null",
  "appDescription": "string | null",
  "logoUrl": "string | null",
  "faviconUrl": "string | null",
  "primaryColor": "string | null",
  "customCss": "string | null",
  "loginLogoUrl": "string | null",
  "supportUrl": "string | null",
  "docsUrl": "string | null",
  "errorPageTitle": "string | null",
  "errorPageDescription": "string | null",
  "metaTitle": "string | null",
  "footerText": "string | null"
}

whitelabeling.update

Update the whitelabeling configuration.

Requirements:

• Enterprise license required
• Owner role required
• Only available for self-hosted (not cloud)

Input:

{
  "whitelabelingConfig": {
    "appName": "string | null",
    "appDescription": "string | null",
    "logoUrl": "string | null",
    "faviconUrl": "string | null",
    "primaryColor": "string | null",
    "customCss": "string | null",
    "loginLogoUrl": "string | null",
    "supportUrl": "string | null",
    "docsUrl": "string | null",
    "errorPageTitle": "string | null",
    "errorPageDescription": "string | null",
    "metaTitle": "string | null",
    "footerText": "string | null"
  }
}

Response:

{
  "success": true
}

whitelabeling.reset

Reset whitelabeling configuration to default values (all fields set to null).

Requirements:

• Enterprise license required
• Owner role required
• Only available for self-hosted (not cloud)

Response:

{
  "success": true
}

whitelabeling.getPublic

Public endpoint to fetch whitelabeling configuration. This endpoint can be accessed without authentication, allowing the whitelabeling settings to be applied globally (including on the login page before auth).

Requirements:

• No authentication required
• Only available for self-hosted (not cloud)

Response: Returns the whitelabeling configuration object or null if not configured. Response shape is identical to whitelabeling.get.