Dokploy
/install dokploy
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_URLenvironment variable (default:http://localhost:3000)
Configuration
Set these environment variables or use the config command:
# Dokploy instance URL
export DOKPLOY_API_URL="https://your-dokploy-instance.com"
# Your API token
export DOKPLOY_API_KEY="your-generated-api-key"
# Or run the config command
dokploy-config set --url "https://your-dokploy-instance.com" --key "your-api-key"
Projects
List all projects
dokploy-project list
Get project details
dokploy-project get \x3Cproject-id>
Create a new project
dokploy-project create --name "My Project" --description "Description here"
Update a project
dokploy-project update \x3Cproject-id> --name "New Name" --description "Updated"
Delete a project
dokploy-project delete \x3Cproject-id>
Applications
List applications in a project
dokploy-app list --project \x3Cproject-id>
Get application details
dokploy-app get \x3Capplication-id>
Create an application
dokploy-app create \
--project \x3Cproject-id> \
--name "my-app" \
--type "docker" \
--image "nginx:latest"
Application types: docker, git, compose
Trigger deployment
dokploy-app deploy \x3Capplication-id>
Get deployment logs
dokploy-app logs \x3Capplication-id> --deployment \x3Cdeployment-id>
List deployments
dokploy-app deployments \x3Capplication-id>
Update application
dokploy-app update \x3Capplication-id> --name "new-name" --env "KEY=VALUE"
Delete an application
dokploy-app delete \x3Capplication-id>
Domains
List domains for an application
dokploy-domain list --application \x3Capplication-id>
Get domain details
dokploy-domain get \x3Cdomain-id>
Add a domain to an application
dokploy-domain create \
--application \x3Capplication-id> \
--domain "app.example.com" \
--path "/" \
--port 80
Update a domain
dokploy-domain update \x3Cdomain-id> --domain "new.example.com"
Delete a domain
dokploy-domain delete \x3Cdomain-id>
Environment Variables
List environment variables for an application
dokploy-app env list \x3Capplication-id>
Set environment variable
dokploy-app env set \x3Capplication-id> --key "DATABASE_URL" --value "postgres://..."
Delete environment variable
dokploy-app env delete \x3Capplication-id> --key "DATABASE_URL"
Utility Commands
Check API connection
dokploy-status
View current config
dokploy-config show
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-keyheader - Use
jqfor JSON parsing in scripts - Some operations require admin permissions
- Deployment is asynchronous — use status endpoint to check progress
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install dokploy - After installation, invoke the skill by name or use
/dokploy - Provide required inputs per the skill's parameter spec and get structured output
What is Dokploy?
Manage Dokploy deployments, projects, applications, and domains via the Dokploy API. It is an AI Agent Skill for Claude Code / OpenClaw, with 2913 downloads so far.
How do I install Dokploy?
Run "/install dokploy" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Dokploy free?
Yes, Dokploy is completely free (open-source). You can download, install and use it at no cost.
Which platforms does Dokploy support?
Dokploy is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Dokploy?
It is built and maintained by JoshuaRileyDev (@joshuarileydev); the current version is v1.0.0.