快速入门

Flashduty Open API 快速入门指南

Open API 用于访问和操作 Flashduty 的实体数据，比如查看和管理配置等。使用 API 与您登录 Flashduty 控制台 后进行页面操作本质上是相同的。

如果您想把自研监控系统的告警推送到 Flashduty，请参考 自定义告警事件。

​

请求规范

---

​

请求地址

所有 API 只接受 HTTPS 协议进行访问，且只有一个 Endpoint：

https://api.flashcat.cloud

​

Headers

大部分请求使用 POST 方法，并使用 JSON Payload 传参。请确保设置正确的 Content-Type：

Content-Type: application/json

​

字符编码

所有 API 均使用 UTF-8 编码。

---

​

认证方式

---

所有 Open API 使用 APP Key 进行鉴权。

​

获取 APP Key

1. 登录控制台

   登录 Flashduty 控制台

2. 创建 APP Key

   进入 账户设置 → APP Key 页面，输入名称，点击添加按钮完成创建

每一个 APP Key 都代表一个独立用户，拥有该用户的全部操作权限，请妥善保存，避免泄露。

​

使用示例

将 APP Key 作为 query string 参数传入：

https://api.flashcat.cloud/path?app_key=YOUR_APP_KEY

cURL

curl -X POST 'https://api.flashcat.cloud/your/api/path?app_key=YOUR_APP_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"param": "value"}'

---

​

响应结构

---

所有请求响应均为 JSON 格式，遵循统一结构：

字段	类型	必选	描述
request_id	string	✅	请求 ID，用于链路追踪
error	object		错误描述，仅当出现错误时返回
data	any		数据内容，具体格式参考各 API 定义

​

响应示例

成功响应

{
  "request_id": "abc123456",
  "data": {
    "id": "user_001",
    "name": "example"
  }
}

错误响应

{
  "request_id": "abc123456",
  "error": {
    "code": "InvalidParameter",
    "message": "参数 name 不能为空"
  }
}

​

Error 对象结构

字段	类型	必选	描述
code	string	✅	错误码，详见使用限制
message	string		错误描述