1. pipeline
Certd开放接口文档
  • 介绍
    • Certd开放接口介绍
  • 开放接口
    • openapi
      • 获取证书
      • 发送通知
  • 用户级别
    • pipeline-access
      • 查询授权配置分页列表
      • 查询授权配置列表
      • 添加授权配置
      • 更新授权配置
      • 查询授权配置详情
      • 删除授权配置
      • 查询授权插件定义
      • 获取授权配置明文密钥
      • 查询授权类型字典
      • 查询授权配置简单信息
      • 根据ID列表获取授权配置字典
    • pipeline-cname
      • 查询CNAME提供商列表
      • 查询CNAME记录分页列表
      • 查询CNAME记录列表
      • 添加CNAME记录
      • 更新CNAME记录
      • 查询CNAME记录详情
      • 删除CNAME记录
      • 批量删除CNAME记录
      • 根据域名获取CNAME记录
      • 验证CNAME记录
      • 重置CNAME记录状态
      • 导入CNAME记录
    • monitor
      • 查询站点监控分页列表
      • 查询站点监控列表
      • 添加站点监控
      • 更新站点监控
      • 查询站点监控详情
      • 删除站点监控
      • 批量删除站点监控
      • 检查站点监控
      • 检查所有站点监控
      • 导入站点监控
      • 修改IP检查设置
      • 修改禁用状态
      • 获取站点监控设置
      • 保存站点监控设置
      • 查询站点IP分页列表
      • 查询站点IP列表
      • 添加站点IP
      • 更新站点IP
      • 查询站点IP详情
      • 删除站点IP
      • 检查站点IP
      • 检查所有站点IP
      • 同步站点IP
      • 导入站点IP
    • pipeline-cert
      • 获取证书
      • 读取证书详情
    • pipeline-dns-provider
      • 查询DNS提供商列表
      • 查询DNS提供商类型字典
    • pipeline-notification
      • 查询通知配置分页列表
      • 查询通知配置列表
      • 添加通知配置
      • 更新通知配置
      • 查询通知配置详情
      • 删除通知配置
      • 查询通知插件定义
      • 查询通知类型字典
      • 查询通知配置简单信息
      • 查询默认通知配置ID
      • 设置默认通知配置
      • 获取或创建默认通知配置
      • 查询通知配置选项
    • pipeline
      • 查询流水线分页列表
        POST
      • 根据ID列表获取流水线简单信息
        POST
      • 新增/更新流水线
        POST
      • 删除流水线
        POST
      • 禁用流水线
        POST
      • 查询流水线详情
        POST
      • 触发流水线执行
        POST
      • 取消流水线执行
        POST
      • 查询流水线数量
        POST
      • 批量删除流水线
        POST
      • 刷新Webhook密钥
        POST
    • pipeline-group
      • 查询流水线分组分页列表
      • 查询流水线分组列表
      • 添加流水线分组
      • 更新流水线分组
      • 查询流水线分组详情
      • 删除流水线分组
      • 查询所有流水线分组
    • pipeline-plugin
      • 查询插件列表
      • 查询插件分组
      • 查询插件分组列表
      • 根据类型获取插件定义
      • 获取插件配置
    • dashboard
      • 查询仪表盘统计数据
  1. pipeline

新增/更新流水线

开发环境
http://127.0.0.1:7001
开发环境
http://127.0.0.1:7001
POST
/api/pi/pipeline/save
authOnly

请求参数

Authorization
在 header 添加参数
x-certd-token
示例:
x-certd-token: ********************
Body 参数application/json必填

示例
{
    "id": 0,
    "title": "string",
    "content": "\n// 流水线配置示例,实际传送时要去掉注释\n{\n  \"title\": \"handsfree.work证书自动化\", //标题\n  \"runnableType\": \"pipeline\", //类型,固定为pipeline\n  \"projectId\": 1, // 项目ID, 未开启企业模式,无需传递\n  \"type\": \"cert\", // 流水线类型,cert:证书自动化, custom :自定义流水线\n  \"from\": \"\", // 来源,cert:证书自动化, upload :证书托管\n  \"stages\": [  //流水线阶段,多个阶段串行执行\n    {\n      \"id\": \"edKopnpp2wvOCQ2vkV8Ii\" // 阶段ID, 由客户端生成,流水线内部全局唯一即可\n      \"title\": \"证书申请阶段\", //阶段标题\n      \"runnableType\": \"stage\", // 类型标识\n      \"tasks\": [ // 任务列表,多个任务并行执行\n        {\n          \"id\": \"Lb8I7Dj10cGh6gqIIkmKv\" // 任务ID, 由客户端生成,流水线内部全局唯一即可\n          \"title\": \"证书申请任务\", // 任务标题\n          \"runnableType\": \"task\", // 类型标识\n          \"steps\": [ // 步骤列表,同一个任务下的多个步骤串行执行\n            {\n              \"id\": \"zc8X1L2f0N0KgbrqFU3gz\" // 步骤ID, 由客户端生成,流水线内部全局唯一即可\n              \"type\": \"CertApply\", // 插件类型\n              \"title\": \"申请证书\", // 步骤标题\n              \"runnableType\": \"step\", // 类型标识\n              \"input\": { //输入参数 ,根据插件的配置有不同的参数,具体参数建议通过浏览器F12进行查看\n                \"renewDays\": 15,\n              },\n              \"strategy\": { // 策略\n                \"runStrategy\": 0 // 运行策略,0:正常执行,1:成功后跳过\n              },\n            }\n          ],\n        }\n      ],\n    }\n  ],\n  \"triggers\": [ // 触发器配置\n    {\n      \"id\": \"pt3865qfIAkULBS5sOQf7\", // 触发器ID, 由客户端生成,流水线内部全局唯一即可\n      \"title\": \"定时触发\",\n      \"type\": \"timer\", // 触发器类型,timer:定时触发\n      \"props\": {\n        \"cron\": \"0 34 5 * * *\" // 定时表达式\n      },\n    }\n  ],\n  \"notifications\": [ // 通知配置\n    {\n      \"id\": \"5pb1gZTnDEjdHkR5tDd6g\" // 通知ID, 由客户端生成,流水线内部全局唯一即可\n      \"title\": \"使用默认通知\",// 通知标题\n      \"type\": \"custom\", // 通知类型,固定为custom \n      \"when\": [ // 触发条件,error:错误时触发,turnToSuccess:失败转成功后触发,success: 成功时触发\n        \"error\",\n        \"turnToSuccess\"\n      ],\n      \"notificationId\": 0, // 通知ID, 0为使用默认通知\n    }\n  ],\n}",
    "keepHistoryCount": 0,
    "groupId": 0,
    "remark": "string",
    "status": "string",
    "disabled": true,
    "type": "string",
    "webhookKey": "string",
    "from": "string",
    "order": 0,
    "projectId": 0,
    "validTime": 0,
    "addToMonitorEnabled": true,
    "addToMonitorDomains": "string"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'http://127.0.0.1:7001/api/pi/pipeline/save' \
--header 'x-certd-token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "id": 0,
    "title": "string",
    "content": "\n// 流水线配置示例,实际传送时要去掉注释\n{\n  \"title\": \"handsfree.work证书自动化\", //标题\n  \"runnableType\": \"pipeline\", //类型,固定为pipeline\n  \"projectId\": 1, // 项目ID, 未开启企业模式,无需传递\n  \"type\": \"cert\", // 流水线类型,cert:证书自动化, custom :自定义流水线\n  \"from\": \"\", // 来源,cert:证书自动化, upload :证书托管\n  \"stages\": [  //流水线阶段,多个阶段串行执行\n    {\n      \"id\": \"edKopnpp2wvOCQ2vkV8Ii\" // 阶段ID, 由客户端生成,流水线内部全局唯一即可\n      \"title\": \"证书申请阶段\", //阶段标题\n      \"runnableType\": \"stage\", // 类型标识\n      \"tasks\": [ // 任务列表,多个任务并行执行\n        {\n          \"id\": \"Lb8I7Dj10cGh6gqIIkmKv\" // 任务ID, 由客户端生成,流水线内部全局唯一即可\n          \"title\": \"证书申请任务\", // 任务标题\n          \"runnableType\": \"task\", // 类型标识\n          \"steps\": [ // 步骤列表,同一个任务下的多个步骤串行执行\n            {\n              \"id\": \"zc8X1L2f0N0KgbrqFU3gz\" // 步骤ID, 由客户端生成,流水线内部全局唯一即可\n              \"type\": \"CertApply\", // 插件类型\n              \"title\": \"申请证书\", // 步骤标题\n              \"runnableType\": \"step\", // 类型标识\n              \"input\": { //输入参数 ,根据插件的配置有不同的参数,具体参数建议通过浏览器F12进行查看\n                \"renewDays\": 15,\n              },\n              \"strategy\": { // 策略\n                \"runStrategy\": 0 // 运行策略,0:正常执行,1:成功后跳过\n              },\n            }\n          ],\n        }\n      ],\n    }\n  ],\n  \"triggers\": [ // 触发器配置\n    {\n      \"id\": \"pt3865qfIAkULBS5sOQf7\", // 触发器ID, 由客户端生成,流水线内部全局唯一即可\n      \"title\": \"定时触发\",\n      \"type\": \"timer\", // 触发器类型,timer:定时触发\n      \"props\": {\n        \"cron\": \"0 34 5 * * *\" // 定时表达式\n      },\n    }\n  ],\n  \"notifications\": [ // 通知配置\n    {\n      \"id\": \"5pb1gZTnDEjdHkR5tDd6g\" // 通知ID, 由客户端生成,流水线内部全局唯一即可\n      \"title\": \"使用默认通知\",// 通知标题\n      \"type\": \"custom\", // 通知类型,固定为custom \n      \"when\": [ // 触发条件,error:错误时触发,turnToSuccess:失败转成功后触发,success: 成功时触发\n        \"error\",\n        \"turnToSuccess\"\n      ],\n      \"notificationId\": 0, // 通知ID, 0为使用默认通知\n    }\n  ],\n}",
    "keepHistoryCount": 0,
    "groupId": 0,
    "remark": "string",
    "status": "string",
    "disabled": true,
    "type": "string",
    "webhookKey": "string",
    "from": "string",
    "order": 0,
    "projectId": 0,
    "validTime": 0,
    "addToMonitorEnabled": true,
    "addToMonitorDomains": "string"
}'

返回响应

🟢200
OK
该响应没有 Body
修改于 2026-03-15 09:52:30
上一页
根据ID列表获取流水线简单信息
下一页
删除流水线
Built with