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-key header. - 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, INLINECODE4 - Databases:
modules/mysql.md, modules/postgres.md, modules/redis.md, modules/mongo.md, INLINECODE9 - Networking/TLS:
modules/domain.md, modules/redirects.md, modules/certificates.md, INLINECODE13 - Platform settings/security/backups:
modules/settings.md, modules/security.md, INLINECODE16 - Git providers:
modules/github.md, modules/gitlab.md, modules/bitbucket.md, modules/gitea.md, INLINECODE21
Standard execution flow (required)
- 1. 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: INLINECODE22
- API snapshot: INLINECODE23
- Auth/profile source: Dokploy user profile token + INLINECODE24
Dokploy API 技能
使用此技能通过其API架构和生成的领域模块来操作Dokploy。
范围约束
- - 仅当任务明确涉及Dokploy时使用此技能。
- 除非涉及Dokploy端点，否则不要将此技能用于通用的Docker/Kubernetes指导。
- 使用x-api-key标头进行身份验证。
- 优先采用最小化、可逆的变更。
路由（模块优先）
从modules/_index.md开始，然后仅加载最小匹配的模块。
常见路由：
- - 应用/部署：modules/application.md、modules/deployment.md、modules/rollback.md
- 数据库：modules/mysql.md、modules/postgres.md、modules/redis.md、modules/mongo.md、modules/mariadb.md
- 网络/TLS：modules/domain.md、modules/redirects.md、modules/certificates.md、modules/port.md
- 平台设置/安全/备份：modules/settings.md、modules/security.md、modules/backup.md
- Git提供商：modules/github.md、modules/gitlab.md、modules/bitbucket.md、modules/gitea.md、modules/gitprovider.md
标准执行流程（必需）
- 1. 分类意图并根据操作族选择模块。
- 首先解析标识符，使用读取/列表/搜索端点。
- 预检检查：必填字段、范围、目标是否存在、依赖影响。
- 最小化变更，使用所需的最小负载。
- 验证结果，使用读取/状态/搜索端点。
- 必要时恢复，使用可用的回滚/重新部署/重启操作。
除非用户意图明确，否则不要执行破坏性操作。
变更安全策略
对于创建/更新/删除/部署/停止/重启操作，始终强制执行：
- - 变更前检查
- 变更后验证
- 报告使用的确切操作ID
- 失败时包含清晰的回滚/恢复下一步操作
如果必填字段未知，请停止并从相关读取/列表端点获取。
密钥处理
- - 切勿在用户可见的输出中回显原始API密钥或令牌。
- 在日志和摘要中隐藏密钥。
- 优先使用环境/安全配置存储，而非内联字面量。
参考
- - 领域索引：modules/_index.md
- API快照：openapi.json
- 认证/配置文件来源：Dokploy用户配置文件令牌 + x-api-key
