[TOC]
## 获取证书列表
~~~[api]
get:/v1/certs
string:page=1#当前页码
limit=10#单页显示数量
name#模糊搜索证书名称
des#模糊搜索备注
cert_type#证书类型,可选值为lets, zerossl,custom
integer:dnsapi#用到此dnsapi的证书
integer:expire#证书还有几天到期
boolean:enable#1为启用或者0为禁用
sync_state#证书同步状态,可选状态为done,pending,failed,process
issue_state#证书签发状态,可选状态为done,pending,failed,process
boolean:valid#指已经可以用于绑定网站的证书,即let's encrypt或zerossl证书已经签发好并同步,或者自上传的证书已经同步好
<<<
返回结果
{
"code": 0,
"count": 2,
"data": [{
"auto_renew": 1,
"create_at2": "2021-11-25 08:34:59",
"domain": "for-test.cdnfly.cn",
"enable": 1,
"expire_time2": null,
"id": 135,
"issue_state": "failed",
"name": "for-test.cdnfly.cn免费证书",
"retry_at2": "2021-11-25 08:50:10",
"start_time": null,
"sync_state": null,
"task_enable": 1,
"task_ret": "xxx",
"type": "lets",
"uid": 2,
"update_at": null,
"username": "jason"
},
{
"auto_renew": 1,
"create_at2": "2021-11-16 15:00:03",
"domain": "for-test.cdnfly.cn",
"enable": 1,
"expire_time2": "2022-02-14 23:59:59",
"id": 134,
"issue_state": null,
"name": "for-test.cdnfly.cn",
"retry_at2": null,
"start_time": null,
"sync_state": null,
"task_enable": null,
"task_ret": null,
"type": "custom",
"uid": 2,
"update_at": null,
"username": "jason"
}
]
}
~~~
## 添加单个或多个证书 (多个证书时,数据格式为数组)
~~~[api]
post:/v1/certs
*string:name#证书名称
des#备注
*type#证书类型,可选为custom、lets、zerossl
dnsapi#用于申请证书的dnsapi,通常用于通配符证书的申请
domain#申请证书的域名, 当证书类型为lets或zerossl时,此项必填
key#密钥内容,当证书类型为custom时,此项必填
cert#证书内容,当证书类型为custom时,此项必填
<<<
返回结果
{
"code": 0,
"data": "1",
"msg": "证书添加成功"
}
<<<
提交内容
{
"name": "for-test.cdnfly.cn证书",
"domain": "for-test.cdnfly.cn",
"type": "lets"
}
~~~
## 批量修改证书(提交的数据格式为数组)
~~~[api]
put:/v1/certs
integer:id#证书ID
string:name#证书名称
des#备注
type#证书类型,可选为custom、lets、zerossl
dnsapi#用于申请证书的dnsapi,通常用于通配符证书的申请
domain#申请证书的域名, 当证书类型为lets或zerossl时,此项必填
key#密钥内容,当证书类型为custom时,此项必填
cert#证书内容,当证书类型为custom时,此项必填
boolean:auto_renew#是否自动续签
boolean:enable#禁用或启用
reissue#设置为1时,表示需要重签证书
<<<
返回结果
{
"code": 0,
"data": "",
"msg": "更新证书成功"
}
<<<
提交内容
[{
"id": 1,
"enable": 0
}, {
"id": 2,
"enable": 0
}]
~~~
## 获取单个证书内容
~~~[api]
get:/v1/certs/<证书ID>
<<<
返回结果
{
"code": 0,
"data": {
"auto_renew": 1,
"cert": "xxx",
"create_at": null,
"des": "",
"dnsapi": null,
"domain": "for-test.cdnfly.cn",
"enable": 1,
"expire_time": null,
"id": 134,
"issue_task_id": null,
"key": "xxx",
"name": "for-test.cdnfly.cn",
"start_time": null,
"task_id": null,
"type": "custom",
"uid": 2,
"update_at": null,
"version": 1
},
"msg": null
}
~~~
## 修改单个证书
~~~[api]
put:/v1/certs/<证书ID>
string:name#证书名称
des#备注
type#证书类型,可选为custom、lets、zerossl
dnsapi#用于申请证书的dnsapi,通常用于通配符证书的申请
domain#申请证书的域名, 当证书类型为lets或zerossl时,此项必填
key#密钥内容,当证书类型为custom时,此项必填
cert#证书内容,当证书类型为custom时,此项必填
boolean:auto_renew#是否自动续签
boolean:enable#禁用或启用
reissue#设置为1时,表示需要重签证书
<<<
返回结果
{
"code": 0,
"data": "",
"msg": "更新证书成功"
}
<<<
提交内容
{
"name": "新名称"
}
~~~
## 删除证书
~~~[api]
delete:/v1/certs/<证书ID,多个以逗号分隔>
<<<
返回结果
{
"code": 0,
"data": "",
"msg": "证书删除成功"
}
~~~
- Cdnfly介绍
- 功能介绍
- 性能数据
- 安装说明
- 管理员文档
- 快速开始
- 节点管理
- DNS设置
- 线路分组
- CC参数配置
- 套餐管理
- 全局配置
- 充值设置
- SMTP设置
- 用户文档
- 网站管理
- 新增网站
- 网站编辑
- 缓存配置
- 刷新预热
- 证书管理
- CC规则
- ACL管理
- 四层转发
- 新增转发
- 转发编辑
- API文档
- 使用介绍
- 用户端
- 用户相关
- 帐号登录 /v1/login
- 重置用户密码 /v1/reset-pass
- 获取邮箱验证码 /v1/email-captcha
- 获取手机验证码 /v1/phone-captcha
- 获取、修改用户信息、注册用户 /v1/user
- 实名认证 /v1/user/certify
- 网站相关
- 网站管理 /v1/sites
- 网站分组 /v1/site-groups
- 网站证书 /v1/certs
- 申请证书的dnsapi /v1/dnsapis
- 网站ACL /v1/acls
- CC规则匹配器 /v1/cc-matchs
- CC规则过滤器 /v1/cc-filters
- CC规则组 /v1/cc-rules
- 网站任务(刷新预热、解锁、日志下载) /v1/jobs
- 四层相关
- 四层转发 /v1/streams
- 转发分组 /v1/stream-groups
- 套餐相关
- 在售套餐分组 /v1/package-groups
- 在售套餐 /v1/packages
- 在售升级包 /v1/package-ups
- 用户套餐 /v1/user-packages
- 用户套餐升级包 /v1/user-package/<package_id>/upgrades
- 套餐用量查询 /v1/user-package/<package_id>/usage
- 监控数据
- 网站实时统计 /v1/monitor/site/realtime
- 网站资源排行 /v1/monitor/site/top
- 网站黑名单 /v1/monitor/site/blackip
- 网站实时访问日志 /v1/monitor/site/access-log
- 用量查询 /v1/monitor/usage
- 转发实时统计 /v1/monitor/stream/realtime
- 转发资源排行 /v1/monitor/stream/top
- 消息相关
- 订阅消息 /v1/messages/sub
- 消息已读 /v1/messages/read
- 消息列表 /v1/messages
- 充值相关
- 微信充值 /v1/wxpay/preorder
- 支付宝充值 /v1/alipay/preorder
- 其它
- 订单查询 /v1/orders
- 获取系统配置 /v1/configs
- 登录日志 /v1/log/login
- 操作日志 /v1/log/op
- 用户端数据概览 /v1/user/overview
- api key管理 /v1/api-key
- 显示图片验证码 /v1/common/captcha
- 显示系统信息 /v1/common/sysinfo
- 注册信息 /v1/common/register-info
- 管理端
- 用户管理 /v1/users
- 用户充值 /v1/user/<用户ID>/recharge
- 区域管理 /v1/regions
- 节点管理 /v1/nodes
- 线路组管理 /v1/node-groups
- 线路管理 /v1/lines
- 基础套餐管理 /v1/packages
- 套餐组管理 /v1/package-groups
- 升级包管理 /v1/package-ups
- 用户套餐管理 /v1/user-packages
- api key管理 /v1/api-key
- FAQ