DevOps & CloudDocumentedScanned

dokploy

Manage Dokploy deployments, projects, applications, and domains via the Dokploy API.

Share:

Installation

npx clawhub@latest install dokploy

View the full skill documentation and source below.

Documentation

Dokploy Skill

Interact with Dokploy's API to manage projects, applications, domains, and deployments.

Prerequisites

  • Dokploy instance running with API access

  • API Key generated from /settings/profile → "API/CLI Section"

  • Set the DOKPLOY_API_URL environment variable (default: ) ## Configuration Set these environment variables or use the config command: __CODE_BLOCK_0__ ## Projects ### List all projects __CODE_BLOCK_1__ ### Get project details __CODE_BLOCK_2__ ### Create a new project __CODE_BLOCK_3__ ### Update a project __CODE_BLOCK_4__ ### Delete a project __CODE_BLOCK_5__ ## Applications ### List applications in a project __CODE_BLOCK_6__ ### Get application details __CODE_BLOCK_7__ ### Create an application __CODE_BLOCK_8__ **Application types:** docker, git, compose ### Trigger deployment __CODE_BLOCK_9__ ### Get deployment logs __CODE_BLOCK_10__ ### List deployments __CODE_BLOCK_11__ ### Update application __CODE_BLOCK_12__ ### Delete an application __CODE_BLOCK_13__ ## Domains ### List domains for an application __CODE_BLOCK_14__ ### Get domain details __CODE_BLOCK_15__ ### Add a domain to an application __CODE_BLOCK_16__ ### Update a domain __CODE_BLOCK_17__ ### Delete a domain __CODE_BLOCK_18__ ## Environment Variables ### List environment variables for an application __CODE_BLOCK_19__ ### Set environment variable __CODE_BLOCK_20__ ### Delete environment variable __CODE_BLOCK_21__ ## Utility Commands ### Check API connection __CODE_BLOCK_22__ ### View current config __CODE_BLOCK_23__ ## API Reference Base URL: $DOKPLOY_API_URL/api | Endpoint | Method | Description | |----------|--------|-------------| | /project.all | GET | List all projects | | /project.create | POST | Create project | | /project.byId | GET | Get project by ID | | /project.update | PATCH | Update project | | /project.delete | DELETE | Delete project | | /application.all | GET | List applications | | /application.create | POST | Create application | | /application.byId | GET | Get application by ID | | /application.update | PATCH | Update application | | /application.delete | DELETE | Delete application | | /application.deploy | POST | Trigger deployment | | /deployment.all | GET | List deployments | | /deployment.byId | GET | Get deployment by ID | | /deployment.logs | GET | Get deployment logs | | /domain.all | GET | List domains | | /domain.create | POST | Create domain | | /domain.update | PATCH | Update domain | | /domain.delete | DELETE | Delete domain | ## Notes - All API calls require the x-api-key header - Use jq` for JSON parsing in scripts

    • Some operations require admin permissions

    • Deployment is asynchronous — use status endpoint to check progress