← Back to Skills Marketplace
Dokploy API
by
Achal Singhal
· GitHub ↗
· v1.0.0
· MIT-0
154
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install dokploy-api
Description
Use for Dokploy-specific API operations (apps, deployments, databases, domains, backups, settings) when tasks explicitly involve Dokploy. Route requests to d...
README (SKILL.md)
Dokploy API Skill
Use this skill to operate Dokploy through its API schema and generated domain modules.
Scope guardrails
- Use this skill only when the task is explicitly about Dokploy.
- Do not use this skill for generic Docker/Kubernetes guidance unless Dokploy endpoints are involved.
- Authenticate with
x-api-keyheader. - Prefer minimal, reversible changes.
Routing (module-first)
Start at modules/_index.md, then load only the smallest matching module.
Common routes:
- Applications/deployments:
modules/application.md,modules/deployment.md,modules/rollback.md - Databases:
modules/mysql.md,modules/postgres.md,modules/redis.md,modules/mongo.md,modules/mariadb.md - Networking/TLS:
modules/domain.md,modules/redirects.md,modules/certificates.md,modules/port.md - Platform settings/security/backups:
modules/settings.md,modules/security.md,modules/backup.md - Git providers:
modules/github.md,modules/gitlab.md,modules/bitbucket.md,modules/gitea.md,modules/gitprovider.md
Standard execution flow (required)
- Classify intent and choose module by operation family.
- Resolve identifiers first using read/list/search endpoints.
- Preflight checks: required fields, scope, target existence, dependency impact.
- Mutate minimally with the smallest payload required.
- Verify outcome using read/status/search endpoints.
- Recover if needed using rollback/redeploy/restart operations where available.
Do not run destructive actions unless user intent is explicit.
Mutation safety policy
For create/update/delete/deploy/stop/restart actions, always enforce:
- inspect before mutate
- verify after mutate
- report exact operation IDs used
- include clear rollback/recovery next step on failure
If required fields are unknown, stop and fetch them from relevant read/list endpoints first.
Secret handling
- Never echo raw API keys or tokens in user-visible output.
- Redact secrets in logs and summaries.
- Prefer environment/secure config storage over inline literals.
References
- Domain index:
modules/_index.md - API snapshot:
openapi.json - Auth/profile source: Dokploy user profile token +
x-api-key
Usage Guidance
This package appears to be a coherent, read-and-call documentation bundle for the Dokploy API. Before installing/use: (1) confirm you will provide a valid x-api-key to the agent (and ask the author whether a separate 'user profile token' is also required, since SKILL.md mentions it but the manifest does not); (2) only enable the skill for tasks that explicitly involve your Dokploy instance — the skill can perform create/update/delete actions so require explicit intent for destructive operations; (3) avoid pasting raw API keys or tokens into chat — store them in the platform's secure credential store if possible and limit the key's permissions; (4) verify you trust the external base URL (https://dokploy.achals.me/api) and review the included openapi.json for the exact endpoints the agent will be able to call. If you want a stricter assessment, provide any runtime policy the platform uses for supplying the x-api-key/profile token (where those credentials will live and how they are scoped).
Capability Analysis
Type: OpenClaw Skill
Name: dokploy-api
Version: 1.0.0
This skill bundle is a comprehensive API integration for Dokploy, an open-source deployment platform. It provides modular access to a wide range of DevOps operations, including application management, database orchestration (Postgres, MySQL, etc.), and server configuration via SSH. While the skill handles high-risk data such as SSH keys (`sshkey.md`), API tokens (`user.md`), and command execution (`schedule.md`), these capabilities are strictly aligned with Dokploy's purpose as a PaaS manager. The `SKILL.md` file includes proactive safety instructions for the AI agent, such as mandatory secret redaction, 'inspect-before-mutate' policies, and reversible change preferences, indicating a focus on operational security rather than malice.
Capability Assessment
Purpose & Capability
Name/description, manifest, openapi.json, and the modular docs all align: this is a documentation-driven, instruction-only skill for calling Dokploy API endpoints. The listed modules and endpoints are coherent with the stated Dokploy operations.
Instruction Scope
SKILL.md stays within the Dokploy domain and prescribes safe, inspect-first flows (classify intent, resolve identifiers, preflight checks, verify after mutation). Minor note: SKILL.md refers to an 'Auth/profile source: Dokploy user profile token + x-api-key' but does not instruct the agent to read any specific local files or environment variables; this is a small documentation ambiguity rather than unexpected behavior.
Install Mechanism
No install spec and no code files that would be executed; the skill is instruction-only and therefore does not install additional packages or write to disk.
Credentials
Manifest declares API auth via x-api-key (apiKey in header) and SKILL.md repeats that. However SKILL.md also mentions a 'Dokploy user profile token' alongside x-api-key while requires.env lists none — this is a minor inconsistency to clarify (the runtime may expect the agent/platform to supply credentials). No unrelated credentials or excessive environment access are requested.
Persistence & Privilege
always is false and the skill is user-invocable. It does not request persistent system privileges or attempt to modify other skills or system-wide settings.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install dokploy-api - After installation, invoke the skill by name or use
/dokploy-api - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of Dokploy API skill.
- Enables interaction with Dokploy APIs for app, deployment, database, domain, backup, and settings management.
- Enforces strict scope: only use for Dokploy-specific tasks, not for general Docker/Kubernetes operations.
- Requires use of x-api-key authentication and prioritizes minimal, reversible mutations.
- Guides request routing through domain modules, starting from modules/_index.md.
- Implements safety-first mutation policy: inspect before mutate, verify after, and provide recovery steps.
- Ensures secrets are never exposed in output or logs.
Metadata
Frequently Asked Questions
What is Dokploy API?
Use for Dokploy-specific API operations (apps, deployments, databases, domains, backups, settings) when tasks explicitly involve Dokploy. Route requests to d... It is an AI Agent Skill for Claude Code / OpenClaw, with 154 downloads so far.
How do I install Dokploy API?
Run "/install dokploy-api" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Dokploy API free?
Yes, Dokploy API is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Dokploy API support?
Dokploy API is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Dokploy API?
It is built and maintained by Achal Singhal (@achals-iglu); the current version is v1.0.0.
More Skills