← 返回 Skills 市场
achals-iglu

Dokploy API

作者 Achal Singhal · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ 安全检测通过
154
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install dokploy-api
功能描述
Use for Dokploy-specific API operations (apps, deployments, databases, domains, backups, settings) when tasks explicitly involve Dokploy. Route requests to d...
使用说明 (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-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, 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)

  1. Classify intent and choose module by operation family.
  2. Resolve identifiers first using read/list/search endpoints.
  3. Preflight checks: required fields, scope, target existence, dependency impact.
  4. Mutate minimally with the smallest payload required.
  5. Verify outcome using read/status/search endpoints.
  6. 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
安全使用建议
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).
功能分析
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.
能力评估
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.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install dokploy-api
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /dokploy-api 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
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.
元数据
Slug dokploy-api
版本 1.0.0
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 1
常见问题

Dokploy API 是什么?

Use for Dokploy-specific API operations (apps, deployments, databases, domains, backups, settings) when tasks explicitly involve Dokploy. Route requests to d... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 154 次。

如何安装 Dokploy API?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install dokploy-api」即可一键安装,无需额外配置。

Dokploy API 是免费的吗?

是的,Dokploy API 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。

Dokploy API 支持哪些平台?

Dokploy API 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 Dokploy API?

由 Achal Singhal(@achals-iglu)开发并维护,当前版本 v1.0.0。

💬 留言讨论