Skip to content

Commit 1eeac8d

Browse files
authored
Merge pull request #274 from flashcatcloud/codex/monit-query-data-openapi
docs(api): document structured monitor queries
2 parents 3e838ff + 74a1859 commit 1eeac8d

11 files changed

Lines changed: 1410 additions & 18 deletions

File tree

‎api-reference/monitors.openapi.en.json‎

Lines changed: 349 additions & 2 deletions
Large diffs are not rendered by default.

‎api-reference/monitors.openapi.zh.json‎

Lines changed: 349 additions & 2 deletions
Large diffs are not rendered by default.

‎api-reference/openapi.en.json‎

Lines changed: 349 additions & 2 deletions
Large diffs are not rendered by default.

‎api-reference/openapi.zh.json‎

Lines changed: 349 additions & 2 deletions
Large diffs are not rendered by default.

‎docs.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2463,6 +2463,7 @@
24632463
"group": "诊断分析",
24642464
"icon": "stethoscope",
24652465
"pages": [
2466+
"POST /monit/query/data",
24662467
"POST /monit/query/rows",
24672468
"POST /monit/query/diagnose",
24682469
"POST /monit/tools/catalog",
@@ -3813,6 +3814,7 @@
38133814
"group": "Diagnostics",
38143815
"icon": "stethoscope",
38153816
"pages": [
3817+
"POST /monit/query/data",
38163818
"POST /monit/query/rows",
38173819
"POST /monit/query/diagnose",
38183820
"POST /monit/tools/catalog",

‎en/home.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Integrate Flashduty through Open API and Webhooks for automation and custom deve
162162
Authentication, request specs, error handling
163163
</Card>
164164
<Card title="API Catalog" icon="list" href="/en/openapi/api-catalog">
165-
All 336 endpoints organized by module
165+
All 337 endpoints organized by module
166166
</Card>
167167
<Card title="About Pagination" icon="file-lines" href="/en/openapi/pagination">
168168
Traditional and cursor pagination

‎en/on-call/quickstart/comparison.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Platform is the shared foundation underneath the four products above: how data g
184184
| **External Incident Submission** | ✅ Customers or partners can submit incidents **without logging in**, via a standalone page or API, with automatic escalation policy matching | Only supports email-to-incident, no structured form | Teams serving external customers can plug customer-reported issues directly into the handling process |
185185
| **Link Integration** | ✅ One-click jump to CMDB or internal systems by hostname and other labels | — | |
186186
| **Custom Webhooks (Outbound)** | Custom payload format, configurable retry conditions and automatic retries, signature-free verification, **full call-history tracing** (status codes, retry counts, request/response detail), subscribable by event type or source | Fixed payload format, fixed retry policy (3 retries, not configurable), no self-service call-history lookup | |
187-
| **Open APIs** | ✅ 336 endpoints covering On-call, Monitors, RUM, AI SRE, and platform management | ✅ | Both provide rich APIs with detailed documentation |
187+
| **Open APIs** | ✅ 337 endpoints covering On-call, Monitors, RUM, AI SRE, and platform management | ✅ | Both provide rich APIs with detailed documentation |
188188

189189
<Tip>
190190
**Integration-on-demand commitment**: If a commercial or open-source tool you rely on isn't in our integration list yet, contact us — as long as you need it, we commit to fast turnaround support.
@@ -229,7 +229,7 @@ Before reaching the team, alerts pass through routing, filtering, and transforma
229229

230230
| Tool | Flashduty | PagerDuty |
231231
| --- | --- | --- |
232-
| **[Open API](/en/openapi/api-catalog)** | 336 endpoints covering On-call, Monitors, RUM, AI SRE, and platform management, with bilingual docs | ✅ Full-featured REST API, mature documentation |
232+
| **[Open API](/en/openapi/api-catalog)** | 337 endpoints covering On-call, Monitors, RUM, AI SRE, and platform management, with bilingual docs | ✅ Full-featured REST API, mature documentation |
233233
| **[CLI](/en/developer/cli)** | 335 API operation commands + built-in Agent Skills, ready to hand directly to AI coding tools like Claude Code, Cursor, and Codex | No official CLI actively promoted: the community's most-used `pagerduty-cli` is an employee's personal project (officially not endorsed, and the author has announced it's archived); the official go-pagerduty library ships a limited `pd` command-line tool |
234234
| **SDK** | [Go SDK](/en/developer/go-sdk): a go-github-style wrapper covering 336 API operations across 39 services | PagerDuty officially maintains go-pagerduty, python-pagerduty, and other client libraries |
235235
| **[Terraform Provider](/en/developer/terraform)** | 12 resource types + 13 data source types, managing collaboration spaces, escalation policies, schedules, and more as IaC | ✅ Official Terraform Provider, mature ecosystem |

‎en/openapi/api-catalog.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "API Catalog"
33
description: "Complete list of Flashduty Open API endpoints, organized by product module with links to detailed documentation"
44
---
55

6-
Flashduty Open API provides **336** 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.
6+
Flashduty Open API provides **337** 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.
77

88
<Note>
99
All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated via APP Key through query string.
@@ -269,7 +269,7 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi
269269

270270
</Accordion>
271271

272-
<Accordion title="Monitors (41 endpoints)">
272+
<Accordion title="Monitors (42 endpoints)">
273273

274274
### Alert rules
275275

@@ -320,6 +320,7 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi
320320

321321
| Method | Endpoint | Description |
322322
| :--- | :--- | :--- |
323+
| POST | [`/monit/query/data`](/en/api-reference/monitors/diagnostics/monit-read-query-data) | Query structured data |
323324
| POST | [`/monit/query/rows`](/en/api-reference/monitors/diagnostics/monit-read-query-rows) | Query data source rows |
324325
| POST | [`/monit/query/diagnose`](/en/api-reference/monitors/diagnostics/monit-read-query-diagnose) | Diagnose data source |
325326
| POST | [`/monit/tools/catalog`](/en/api-reference/monitors/diagnostics/monit-read-tools-catalog) | List target tool catalog |

‎zh/home.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ AI SRE 已全量开放**公测**,无需申请,登录控制台即可使用,
163163
认证方式、请求规范、错误处理
164164
</Card>
165165
<Card title="API 总览" icon="list" href="/zh/openapi/api-catalog">
166-
全部 336 个接口,按模块分类
166+
全部 337 个接口,按模块分类
167167
</Card>
168168
<Card title="关于分页" icon="file-lines" href="/zh/openapi/pagination">
169169
传统分页与游标分页机制

‎zh/on-call/quickstart/comparison.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ PagerDuty AIOps 在超大规模事件关联场景上打磨多年,能力成熟
184184
| **外部故障提交** | ✅ 客户或合作伙伴**免登录**通过独立页面或 API 提交故障,自动匹配分派策略 | 仅支持邮件转 incident,无结构化表单 | 对外提供服务的团队可直接把客户报障接入处置流程 |
185185
| **Link 集成** | ✅ 按 hostname 等标签一键跳转 CMDB 或内部系统 | — | |
186186
| **自定义 Webhook(出站)** | 自定义 Payload 格式、重试条件与自动重试、免密验证,**完整调用历史追溯**(状态码、重试次数、请求响应详情),可按事件类型或来源订阅 | Payload 格式固定,重试策略固定(3 次不可配置),无自助调用历史查询 | |
187-
| **Open APIs** | ✅ 336 个接口,覆盖 On-call、Monitors、RUM、AI SRE 与平台管理 | ✅ | 两者均提供丰富的 API 和详细文档 |
187+
| **Open APIs** | ✅ 337 个接口,覆盖 On-call、Monitors、RUM、AI SRE 与平台管理 | ✅ | 两者均提供丰富的 API 和详细文档 |
188188

189189
<Tip>
190190
**集成按需支持承诺**:如果您常用的商业软件或开源服务尚未在集成列表中,请联系我们——只要您需要,我们承诺快速支持。
@@ -229,7 +229,7 @@ PagerDuty AIOps 在超大规模事件关联场景上打磨多年,能力成熟
229229

230230
| 工具 | Flashduty | PagerDuty |
231231
| --- | --- | --- |
232-
| **[Open API](/zh/openapi/api-catalog)** | 336 个接口,覆盖 On-call、Monitors、RUM、AI SRE 与平台管理,双语文档 | ✅ REST API 完善,文档成熟 |
232+
| **[Open API](/zh/openapi/api-catalog)** | 337 个接口,覆盖 On-call、Monitors、RUM、AI SRE 与平台管理,双语文档 | ✅ REST API 完善,文档成熟 |
233233
| **[CLI](/zh/developer/cli)** | 335 个 API 操作命令 + 内置 Agent Skills,可直接配给 Claude Code、Cursor、Codex 等 AI 编程工具 | 无官方力推的完整 CLI:社区最常用的 `pagerduty-cli` 为员工个人项目(官方声明不背书、作者已宣布归档),官方 go-pagerduty 库附带功能有限的 `pd` 命令行小工具 |
234234
| **SDK** | [Go SDK](/zh/developer/go-sdk):go-github 风格封装,覆盖 336 个 API 操作、39 个服务 | 官方维护 go-pagerduty、python-pagerduty 等客户端库 |
235235
| **[Terraform Provider](/zh/developer/terraform)** | 12 类资源 + 13 类数据源,IaC 管理协作空间、分派策略、值班表等 | ✅ 官方 Terraform Provider,生态成熟 |

0 commit comments

Comments
 (0)