Dokploy 技能

通过 Dokploy 的 API 管理项目、应用、域名和部署。

前置条件

1. 1. Dokploy 实例 正在运行并开放 API 访问
2. API 密钥 从 /settings/profile → API/CLI 部分 生成
3. 设置 DOKPLOYAPIURL 环境变量（默认值：http://localhost:3000）

配置

设置以下环境变量或使用配置命令：

bash

Dokploy 实例 URL

export DOKPLOYAPIURL=https://your-dokploy-instance.com

您的 API 令牌

export DOKPLOYAPIKEY=your-generated-api-key

或运行配置命令

dokploy-config set --url https://your-dokploy-instance.com --key your-api-key

项目

列出所有项目

bash dokploy-project list

获取项目详情

bash dokploy-project get <项目ID>

创建新项目

bash dokploy-project create --name 我的项目 --description 此处填写描述

更新项目

bash dokploy-project update <项目ID> --name 新名称 --description 已更新

删除项目

bash dokploy-project delete <项目ID>

应用

列出项目中的应用

bash dokploy-app list --project <项目ID>

获取应用详情

bash dokploy-app get <应用ID>

创建应用

bash dokploy-app create \ --project <项目ID> \ --name my-app \ --type docker \ --image nginx:latest

应用类型： docker、git、compose

触发部署

bash dokploy-app deploy <应用ID>

获取部署日志

bash dokploy-app logs <应用ID> --deployment <部署ID>

列出部署记录

bash dokploy-app deployments <应用ID>

更新应用

bash dokploy-app update <应用ID> --name 新名称 --env KEY=VALUE

删除应用

bash dokploy-app delete <应用ID>

域名

列出应用的域名

bash dokploy-domain list --application <应用ID>

获取域名详情

bash dokploy-domain get <域名ID>

为应用添加域名

bash dokploy-domain create \ --application <应用ID> \ --domain app.example.com \ --path / \ --port 80

更新域名

bash dokploy-domain update <域名ID> --domain new.example.com

删除域名

bash dokploy-domain delete <域名ID>

环境变量

列出应用的环境变量

bash dokploy-app env list <应用ID>

设置环境变量

bash dokploy-app env set <应用ID> --key DATABASE_URL --value postgres://...

删除环境变量

bash dokploy-app env delete <应用ID> --key DATABASE_URL

实用命令

检查 API 连接

bash dokploy-status

查看当前配置

bash dokploy-config show

API 参考

基础 URL：$DOKPLOYAPIURL/api

端点	方法	描述
/project.all	GET	列出所有项目
/project.create

POST | 创建项目 |
| /project.byId | GET | 按 ID 获取项目 |
| /project.update | PATCH | 更新项目 |
| /project.delete | DELETE | 删除项目 |
| /application.all | GET | 列出应用 |
| /application.create | POST | 创建应用 |
| /application.byId | GET | 按 ID 获取应用 |
| /application.update | PATCH | 更新应用 |
| /application.delete | DELETE | 删除应用 |
| /application.deploy | POST | 触发部署 |
| /deployment.all | GET | 列出部署记录 |
| /deployment.byId | GET | 按 ID 获取部署 |
| /deployment.logs | GET | 获取部署日志 |
| /domain.all | GET | 列出域名 |
| /domain.create | POST | 创建域名 |
| /domain.update | PATCH | 更新域名 |
| /domain.delete | DELETE | 删除域名 |

备注

• - 所有 API 调用都需要 x-api-key 请求头
• 在脚本中使用 jq 进行 JSON 解析
• 部分操作需要管理员权限
• 部署是异步的——请使用状态端点检查进度