Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,176 changes: 1,159 additions & 17 deletions api-reference/on-call.openapi.en.json

Large diffs are not rendered by default.

1,176 changes: 1,159 additions & 17 deletions api-reference/on-call.openapi.zh.json

Large diffs are not rendered by default.

1,176 changes: 1,159 additions & 17 deletions api-reference/openapi.en.json

Large diffs are not rendered by default.

1,176 changes: 1,159 additions & 17 deletions api-reference/openapi.zh.json

Large diffs are not rendered by default.

104 changes: 86 additions & 18 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1679,6 +1679,38 @@
"source": "/channel/inhibit/rule/update",
"destination": "/zh/api-reference/on-call/channels/channel-inhibit-rule-update"
},
{
"source": "/channel/integration/create",
"destination": "/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-create"
},
{
"source": "/channel/integration/delete",
"destination": "/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-delete"
},
{
"source": "/channel/integration/disable",
"destination": "/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-disable"
},
{
"source": "/channel/integration/enable",
"destination": "/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-enable"
},
{
"source": "/channel/integration/info",
"destination": "/zh/api-reference/on-call/dedicated-integrations/channel-integration-read-info"
},
{
"source": "/channel/integration/key/rotate",
"destination": "/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-rotate-key"
},
{
"source": "/channel/integration/list",
"destination": "/zh/api-reference/on-call/dedicated-integrations/channel-integration-read-list"
},
{
"source": "/channel/integration/update",
"destination": "/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-update"
},
{
"source": "/channel/list",
"destination": "/zh/api-reference/on-call/channels/channel-list"
Expand Down Expand Up @@ -4170,18 +4202,36 @@
"group": "集成中心",
"icon": "plug",
"pages": [
{
"group": "公共集成",
"pages": [
"POST /integration/type/list",
"POST /integration/list",
"POST /integration/info",
"POST /integration/create",
"POST /integration/update",
"POST /integration/delete",
"POST /integration/enable",
"POST /integration/disable",
"POST /integration/key/rotate"
]
},
{
"group": "专属集成",
"pages": [
"POST /channel/integration/list",
"POST /channel/integration/info",
"POST /channel/integration/create",
"POST /channel/integration/update",
"POST /channel/integration/delete",
"POST /channel/integration/enable",
"POST /channel/integration/disable",
"POST /channel/integration/key/rotate"
]
},
"POST /webhook/history/list",
"POST /webhook/history/detail",
"POST /datasource/im/person/try-link",
"POST /integration/type/list",
"POST /integration/list",
"POST /integration/info",
"POST /integration/create",
"POST /integration/update",
"POST /integration/delete",
"POST /integration/enable",
"POST /integration/disable",
"POST /integration/key/rotate",
"POST /alert/email/preview"
]
},
Expand Down Expand Up @@ -5948,18 +5998,36 @@
"group": "Integrations",
"icon": "plug",
"pages": [
{
"group": "Public integrations",
"pages": [
"POST /integration/type/list",
"POST /integration/list",
"POST /integration/info",
"POST /integration/create",
"POST /integration/update",
"POST /integration/delete",
"POST /integration/enable",
"POST /integration/disable",
"POST /integration/key/rotate"
]
},
{
"group": "Dedicated integrations",
"pages": [
"POST /channel/integration/list",
"POST /channel/integration/info",
"POST /channel/integration/create",
"POST /channel/integration/update",
"POST /channel/integration/delete",
"POST /channel/integration/enable",
"POST /channel/integration/disable",
"POST /channel/integration/key/rotate"
]
},
"POST /webhook/history/list",
"POST /webhook/history/detail",
"POST /datasource/im/person/try-link",
"POST /integration/type/list",
"POST /integration/list",
"POST /integration/info",
"POST /integration/create",
"POST /integration/update",
"POST /integration/delete",
"POST /integration/enable",
"POST /integration/disable",
"POST /integration/key/rotate",
"POST /alert/email/preview"
]
},
Expand Down
48 changes: 35 additions & 13 deletions en/openapi/api-catalog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ title: "API catalog"
description: "Complete list of Flashduty Open API endpoints, organized by product module with links to detailed documentation"
---

Flashduty Open API provides **383** endpoints covering five major modules: On-call, Monitors, RUM, AI SRE, and Platform. All endpoints use unified authentication and request specifications. See [Quick Start](/en/openapi/introduction) for details.
Flashduty Open API provides **392** endpoints covering five major modules: On-call, Monitors, RUM, AI SRE, and Platform. All endpoints use unified authentication and request specifications. See [Quick Start](/en/openapi/introduction) for details.

<Note>
All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated through APP Key through query string.
</Note>

<Accordion title="On-call (206 endpoints)">
<Accordion title="On-call (215 endpoints)">

### Incidents

Expand Down Expand Up @@ -129,24 +129,46 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated th
| POST | [`/alert/pipeline/preview`](/en/api-reference/on-call/alerts/alert-read-pipeline-preview) | Preview alert pipeline processing |
| POST | [`/alert-event/list`](/en/api-reference/on-call/alerts/alert-event-read-list) | List raw alert events |

### Integrations
### Public integrations

The `/integration/*` management APIs cover public (account-level) integrations, including supported IM and webhook types. Channel-owned dedicated integrations are not part of this public API surface. `/integration/list` and `/integration/info` return stored settings with each saved secret as `******`, and the integration key as is.
`/integration/*` manages public (account-level) integrations, including supported IM and webhook types. Use `/channel/integration/*` for channel-owned dedicated integrations. List and info return complete integration keys and mask saved configuration secrets as `******`.

| Method | Endpoint | Description |
| :--- | :--- | :--- |
| POST | [`/integration/type/list`](/en/api-reference/on-call/integrations/integration-api-read-type-list) | List integration types |
| POST | [`/integration/list`](/en/api-reference/on-call/integrations/integration-api-read-list) | List public integrations |
| POST | [`/integration/info`](/en/api-reference/on-call/integrations/integration-api-read-info) | Get public integration detail |
| POST | [`/integration/create`](/en/api-reference/on-call/integrations/integration-api-write-create) | Create public integration |
| POST | [`/integration/update`](/en/api-reference/on-call/integrations/integration-api-write-update) | Update public integration |
| POST | [`/integration/delete`](/en/api-reference/on-call/integrations/integration-api-write-delete) | Delete public integration |
| POST | [`/integration/enable`](/en/api-reference/on-call/integrations/integration-api-write-enable) | Enable public integration |
| POST | [`/integration/disable`](/en/api-reference/on-call/integrations/integration-api-write-disable) | Disable public integration |
| POST | [`/integration/key/rotate`](/en/api-reference/on-call/integrations/integration-api-write-rotate-key) | Rotate public integration key |

### Dedicated integrations

`/channel/integration/*` manages channel-owned dedicated integrations. Queries require **Channels Read** or **Channels Manage**; writes require **Channels Manage**. You also need the corresponding access to the target channel; integration-center permissions do not grant access to this API group.

The App Key's `api_scopes` must allow the operation. Private channels are visible to the account owner, an Admin, the channel creator, or members of the owning or managing teams; writes follow channel management access. Queries return the complete integration key and mask saved configuration secrets as `******`.

| Method | Endpoint | Description |
| :--- | :--- | :--- |
| POST | [`/channel/integration/list`](/en/api-reference/on-call/dedicated-integrations/channel-integration-read-list) | List dedicated integrations |
| POST | [`/channel/integration/info`](/en/api-reference/on-call/dedicated-integrations/channel-integration-read-info) | Get dedicated integration detail |
| POST | [`/channel/integration/create`](/en/api-reference/on-call/dedicated-integrations/channel-integration-write-create) | Create dedicated integration |
| POST | [`/channel/integration/update`](/en/api-reference/on-call/dedicated-integrations/channel-integration-write-update) | Update dedicated integration |
| POST | [`/channel/integration/delete`](/en/api-reference/on-call/dedicated-integrations/channel-integration-write-delete) | Delete dedicated integration |
| POST | [`/channel/integration/enable`](/en/api-reference/on-call/dedicated-integrations/channel-integration-write-enable) | Enable dedicated integration |
| POST | [`/channel/integration/disable`](/en/api-reference/on-call/dedicated-integrations/channel-integration-write-disable) | Disable dedicated integration |
| POST | [`/channel/integration/key/rotate`](/en/api-reference/on-call/dedicated-integrations/channel-integration-write-rotate-key) | Rotate dedicated integration key |

### Integration utilities

| Method | Endpoint | Description |
| :--- | :--- | :--- |
| POST | [`/webhook/history/list`](/en/api-reference/on-call/integrations/webhook-history-list) | List webhook delivery history |
| POST | [`/webhook/history/detail`](/en/api-reference/on-call/integrations/webhook-history-detail) | Get webhook delivery detail |
| POST | [`/datasource/im/person/try-link`](/en/api-reference/on-call/integrations/datasource-im-person-try-link) | Attempt IM person linking |
| POST | [`/integration/type/list`](/en/api-reference/on-call/integrations/integration-api-read-type-list) | List integration types |
| POST | [`/integration/list`](/en/api-reference/on-call/integrations/integration-api-read-list) | List integrations |
| POST | [`/integration/info`](/en/api-reference/on-call/integrations/integration-api-read-info) | Get integration detail |
| POST | [`/integration/create`](/en/api-reference/on-call/integrations/integration-api-write-create) | Create integration |
| POST | [`/integration/update`](/en/api-reference/on-call/integrations/integration-api-write-update) | Update integration |
| POST | [`/integration/delete`](/en/api-reference/on-call/integrations/integration-api-write-delete) | Delete integration |
| POST | [`/integration/enable`](/en/api-reference/on-call/integrations/integration-api-write-enable) | Enable integration |
| POST | [`/integration/disable`](/en/api-reference/on-call/integrations/integration-api-write-disable) | Disable integration |
| POST | [`/integration/key/rotate`](/en/api-reference/on-call/integrations/integration-api-write-rotate-key) | Rotate integration key |
| POST | [`/alert/email/preview`](/en/api-reference/on-call/integrations/alert-read-email-preview) | Preview email-to-alert conversion |

### Schedules
Expand Down
48 changes: 35 additions & 13 deletions zh/openapi/api-catalog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ title: "API 目录"
description: "Flashduty Open API 接口完整列表,按产品模块组织并链接到详细文档"
---

Flashduty Open API 提供 **383** 个接口,覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见[快速开始](/zh/openapi/introduction)。
Flashduty Open API 提供 **392** 个接口,覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见[快速开始](/zh/openapi/introduction)。

<Note>
所有接口 URL 均以 `https://api.flashcat.cloud` 为 base,通过 query string 中的 APP Key 认证。
</Note>

<Accordion title="On-call(206 个接口)">
<Accordion title="On-call(215 个接口)">

### 故障管理

Expand Down Expand Up @@ -129,24 +129,46 @@ Flashduty Open API 提供 **383** 个接口,覆盖 On-call、Monitors、RUM、
| POST | [`/alert/pipeline/preview`](/zh/api-reference/on-call/alerts/alert-read-pipeline-preview) | 预览告警处理规则效果 |
| POST | [`/alert-event/list`](/zh/api-reference/on-call/alerts/alert-event-read-list) | 查询原始告警事件列表 |

### 集成中心
### 公共集成

`/integration/*` 管理接口用于公共(账户级)集成,包含支持的 IM 与 Webhook 类型,不包含协作空间专属集成。`/integration/list` 与 `/integration/info` 返回存储配置,其中已保存的密钥类值返回 `******`,集成 Key 按原值返回。
`/integration/*` 管理公共(账户级)集成,包含支持的 IM 和 Webhook 类型。协作空间专属集成使用 `/channel/integration/*`。列表和详情返回完整集成 Key,配置中已保存的密钥类值返回 `******`。

| 方法 | 接口 | 描述 |
| :--- | :--- | :--- |
| POST | [`/integration/type/list`](/zh/api-reference/on-call/integrations/integration-api-read-type-list) | 查询集成类型列表 |
| POST | [`/integration/list`](/zh/api-reference/on-call/integrations/integration-api-read-list) | 查询公共集成列表 |
| POST | [`/integration/info`](/zh/api-reference/on-call/integrations/integration-api-read-info) | 查看公共集成详情 |
| POST | [`/integration/create`](/zh/api-reference/on-call/integrations/integration-api-write-create) | 创建公共集成 |
| POST | [`/integration/update`](/zh/api-reference/on-call/integrations/integration-api-write-update) | 更新公共集成 |
| POST | [`/integration/delete`](/zh/api-reference/on-call/integrations/integration-api-write-delete) | 删除公共集成 |
| POST | [`/integration/enable`](/zh/api-reference/on-call/integrations/integration-api-write-enable) | 启用公共集成 |
| POST | [`/integration/disable`](/zh/api-reference/on-call/integrations/integration-api-write-disable) | 禁用公共集成 |
| POST | [`/integration/key/rotate`](/zh/api-reference/on-call/integrations/integration-api-write-rotate-key) | 轮换公共集成 Key |

### 专属集成

`/channel/integration/*` 管理协作空间专属集成。查询要求**协作空间查看**或**协作空间管理**,写入要求**协作空间管理**。您还须拥有目标空间对应的数据权限;集成中心权限不授予本组接口访问权。

App Key 的 `api_scopes` 须允许对应操作。私有空间仅对账户所有者、Admin、空间创建者、所属团队和管理团队成员可见;写入按空间管理权限判断。查询返回完整集成 Key,配置中的已保存密钥类值返回 `******`。

| 方法 | 接口 | 描述 |
| :--- | :--- | :--- |
| POST | [`/channel/integration/list`](/zh/api-reference/on-call/dedicated-integrations/channel-integration-read-list) | 查询专属集成列表 |
| POST | [`/channel/integration/info`](/zh/api-reference/on-call/dedicated-integrations/channel-integration-read-info) | 查看专属集成详情 |
| POST | [`/channel/integration/create`](/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-create) | 创建专属集成 |
| POST | [`/channel/integration/update`](/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-update) | 更新专属集成 |
| POST | [`/channel/integration/delete`](/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-delete) | 删除专属集成 |
| POST | [`/channel/integration/enable`](/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-enable) | 启用专属集成 |
| POST | [`/channel/integration/disable`](/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-disable) | 禁用专属集成 |
| POST | [`/channel/integration/key/rotate`](/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-rotate-key) | 轮换专属集成 Key |

### 集成工具

| 方法 | 接口 | 描述 |
| :--- | :--- | :--- |
| POST | [`/webhook/history/list`](/zh/api-reference/on-call/integrations/webhook-history-list) | 查询 Webhook 推送历史 |
| POST | [`/webhook/history/detail`](/zh/api-reference/on-call/integrations/webhook-history-detail) | 获取 Webhook 推送详情 |
| POST | [`/datasource/im/person/try-link`](/zh/api-reference/on-call/integrations/datasource-im-person-try-link) | 尝试关联 IM 人员 |
| POST | [`/integration/type/list`](/zh/api-reference/on-call/integrations/integration-api-read-type-list) | 查询集成类型列表 |
| POST | [`/integration/list`](/zh/api-reference/on-call/integrations/integration-api-read-list) | 查询集成列表 |
| POST | [`/integration/info`](/zh/api-reference/on-call/integrations/integration-api-read-info) | 查询集成详情 |
| POST | [`/integration/create`](/zh/api-reference/on-call/integrations/integration-api-write-create) | 创建集成 |
| POST | [`/integration/update`](/zh/api-reference/on-call/integrations/integration-api-write-update) | 更新集成 |
| POST | [`/integration/delete`](/zh/api-reference/on-call/integrations/integration-api-write-delete) | 删除集成 |
| POST | [`/integration/enable`](/zh/api-reference/on-call/integrations/integration-api-write-enable) | 启用集成 |
| POST | [`/integration/disable`](/zh/api-reference/on-call/integrations/integration-api-write-disable) | 禁用集成 |
| POST | [`/integration/key/rotate`](/zh/api-reference/on-call/integrations/integration-api-write-rotate-key) | 轮换集成 Key |
| POST | [`/alert/email/preview`](/zh/api-reference/on-call/integrations/alert-read-email-preview) | 预览邮件转告警效果 |

### 值班排班
Expand Down
Loading