Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
a57ac9d
docs: sync monit-agent target guides
UlricQin Jul 22, 2026
7794866
docs: extend shell approval window
UlricQin Jul 22, 2026
66ac6bc
docs: focus agent guide on user workflows
UlricQin Jul 22, 2026
db43967
Guide the user to install a higher version of Monitoredge
UlricQin Jul 22, 2026
f178786
Merge pull request #200 from flashcatcloud/doc-review/2026-07-22-moni…
UlricQin Jul 22, 2026
c9093ca
upgrade monit-agent version
UlricQin Jul 22, 2026
9a26dc6
upgrade monitagent version to 0.1.2
UlricQin Jul 22, 2026
547bc74
upgrade monitagent version
UlricQin Jul 22, 2026
7f8b32c
docs(api): sync monit tool contracts
ysyneu Jul 23, 2026
d4747e0
Merge pull request #202 from flashcatcloud/automation/api-review-api-…
ysyneu Jul 23, 2026
452cb73
docs: sync source-backed review findings
ysyneu Jul 23, 2026
2038d1a
docs: add ServiceDeskPlus request list API
pijiang3 Jul 23, 2026
011f3e8
Merge branch 'codex/sdp-request-list-api-doc'
pijiang3 Jul 23, 2026
6a16ddc
Merge pull request #203 from flashcatcloud/automation/doc-review-2026…
ysyneu Jul 23, 2026
6863a87
docs: add ServiceDeskPlus request list to nav
pijiang3 Jul 23, 2026
b1c8c7f
docs: refine ServiceDeskPlus linked incidents title
pijiang3 Jul 23, 2026
8c45a30
Merge remote-tracking branch 'origin/main'
pijiang3 Jul 23, 2026
0094e73
docs: add custom change event protocol
pijiang3 Jul 23, 2026
d45cbba
upgrade monitagent to version: 0.1.5
UlricQin Jul 23, 2026
9c1bcac
Merge branch 'main' of https://github.com/flashcatcloud/flashduty-docs
UlricQin Jul 23, 2026
861b45c
upgrade monitagent to version: 0.1.6
UlricQin Jul 23, 2026
71e4ec1
docs(api): sync public api contracts
ysyneu Jul 24, 2026
d5cc88f
docs: sync source-backed review findings
ysyneu Jul 24, 2026
5ba9366
Merge pull request #204 from flashcatcloud/automation/api-review-api-…
ysyneu Jul 24, 2026
dada683
Merge pull request #205 from flashcatcloud/automation/doc-review-2026…
ysyneu Jul 24, 2026
140bc8c
docs: add AI SRE credit package agreement
ysyneu Jul 26, 2026
02ce7a8
docs: clarify AI SRE credit billing terms
ysyneu Jul 26, 2026
bd0d6f2
docs: correct the AI SRE credit package agreement against the impleme…
ysyneu Jul 26, 2026
4bdef85
docs(ai-sre): state that enabling does not retroactively bill the fre…
ysyneu Jul 26, 2026
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
244 changes: 27 additions & 217 deletions api-reference/monitors.openapi.en.json

Large diffs are not rendered by default.

244 changes: 27 additions & 217 deletions api-reference/monitors.openapi.zh.json

Large diffs are not rendered by default.

281 changes: 279 additions & 2 deletions api-reference/on-call.openapi.en.json
Original file line number Diff line number Diff line change
Expand Up @@ -8075,6 +8075,99 @@
}
}
},
"/incident/sdp/request/list": {
"post": {
"operationId": "incident-service-desk-plus-request-read-list",
"summary": "Get ServiceDeskPlus linked incidents",
"description": "List synchronization mappings between ServiceDeskPlus requests and Flashduty incidents.",
"tags": [
"On-call/Incidents"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Read** (`on-call`) |\n\n## Usage\n\n- Use this endpoint to inspect synchronization mappings between ServiceDeskPlus requests and Flashduty incidents, including the external request link and sync status.\n- When `incident_id` is not provided, `start_time` and `end_time` are required Unix-second timestamps; the time window cannot exceed 30 days.\n- `status` accepts only `success` and `failed`, representing successful and failed synchronization records.\n- Results are sorted by the internal record ID. Set `asc` to `true` for ascending order; otherwise records are returned descending. Pass the returned `search_after_ctx` to continue pagination.",
"href": "/en/api-reference/on-call/incidents/incident-service-desk-plus-request-read-list",
"metadata": {
"sidebarTitle": "Get ServiceDeskPlus linked incidents"
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SuccessEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ServiceDeskPlusRequestListResponse"
}
}
}
]
},
"example": {
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"created_at": 1779514631,
"status": "success",
"request_id": "100000000001",
"request_link": "https://servicedesk.example.com/app/itdesk/ui/requests/100000000001/details",
"integration_id": 98765,
"incident_id": "685d7f4e51b9a9a6d4d0c123",
"incident_title": "Checkout API 5xx rate increased",
"channel_id": 12345,
"channel_name": "Payments"
}
],
"total": 1,
"has_next_page": false,
"search_after_ctx": ""
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"500": {
"$ref": "#/components/responses/ServerError"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceDeskPlusRequestListRequest"
},
"example": {
"start_time": 1779513600,
"end_time": 1779600000,
"status": "success",
"channel_ids": [
12345
],
"limit": 20
}
}
}
}
}
},
"/insight/alert/topk-by-label": {
"post": {
"operationId": "insightTopkAlertsByLabel",
Expand Down Expand Up @@ -11903,12 +11996,12 @@
"get": {
"operationId": "statusPageChangeList",
"summary": "List status page events",
"description": "List events (incidents and maintenances) for a status page.",
"description": "List status page events with only publicly visible affected components.",
"tags": [
"On-call/Status pages"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Hidden affected components are omitted. Events remain in the result when none are visible, with an empty `affected_components` array.",
"href": "/en/api-reference/on-call/status-pages/status-page-change-list",
"metadata": {
"sidebarTitle": "List status page events"
Expand Down Expand Up @@ -26208,6 +26301,11 @@
"type": "string",
"description": "Feishu app message template source."
},
"feishu_app_card_table_enabled": {
"type": "boolean",
"default": false,
"description": "Render alert labels as a table in Feishu app cards."
},
"dingtalk_app": {
"type": "string",
"description": "DingTalk app message template source."
Expand Down Expand Up @@ -26288,6 +26386,7 @@
"wecom",
"feishu",
"feishu_app",
"feishu_app_card_table_enabled",
"dingtalk_app",
"wecom_app",
"slack_app",
Expand Down Expand Up @@ -26354,6 +26453,10 @@
"type": "string",
"description": "Feishu app message template source."
},
"feishu_app_card_table_enabled": {
"type": "boolean",
"description": "Whether alert labels use table rendering in Feishu app cards."
},
"dingtalk_app": {
"type": "string",
"description": "DingTalk app message template source."
Expand Down Expand Up @@ -26564,6 +26667,13 @@
"type": "string",
"description": "Feishu app message template source."
},
"feishu_app_card_table_enabled": {
"type": [
"boolean",
"null"
],
"description": "When set, enable or disable table rendering for alert labels in Feishu app cards. Omit to keep the existing setting."
},
"dingtalk_app": {
"type": "string",
"description": "DingTalk app message template source."
Expand Down Expand Up @@ -29351,6 +29461,173 @@
}
}
}
},
"ServiceDeskPlusRequestListRequest": {
"type": "object",
"description": "Filters for listing ServiceDeskPlus request synchronization records. A time window is optional when querying by incident ID; otherwise provide a Unix-second window no longer than 30 days.",
"properties": {
"start_time": {
"type": "integer",
"format": "int64",
"minimum": 0,
"description": "Window start, Unix seconds. Optional when `incident_id` is provided."
},
"end_time": {
"type": "integer",
"format": "int64",
"minimum": 0,
"description": "Window end, Unix seconds. Must be greater than or equal to `start_time`. Optional when `incident_id` is provided."
},
"status": {
"type": "string",
"enum": [
"success",
"failed"
],
"description": "Synchronization status filter."
},
"channel_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Channel IDs to filter by."
},
"integration_id": {
"type": "integer",
"format": "int64",
"minimum": 0,
"description": "ServiceDeskPlus integration ID."
},
"incident_id": {
"type": "string",
"maxLength": 64,
"description": "Flashduty incident ID. When set, the time window can be omitted."
},
"request_id": {
"type": "string",
"maxLength": 64,
"description": "ServiceDeskPlus request ID."
},
"asc": {
"type": "boolean",
"description": "When `true`, sort by internal record ID ascending; otherwise descending."
},
"p": {
"type": "integer",
"format": "int64",
"minimum": 0,
"description": "Page number starting at 1. Ignored when `search_after_ctx` is set."
},
"limit": {
"type": "integer",
"format": "int64",
"minimum": 0,
"maximum": 100,
"default": 20,
"description": "Page size. Defaults to 20; maximum 100."
},
"search_after_ctx": {
"type": "string",
"description": "Cursor returned by the previous page."
}
}
},
"ServiceDeskPlusRequestMappingItem": {
"type": "object",
"description": "A synchronization mapping between a ServiceDeskPlus request and a Flashduty incident.",
"required": [
"created_at",
"status",
"request_id",
"request_link",
"integration_id",
"incident_id",
"incident_title",
"channel_id",
"channel_name"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64",
"description": "Mapping record creation time, Unix seconds."
},
"status": {
"type": "string",
"enum": [
"success",
"failed"
],
"description": "Synchronization status."
},
"request_id": {
"type": "string",
"description": "ServiceDeskPlus request ID."
},
"request_link": {
"type": "string",
"description": "ServiceDeskPlus request detail URL."
},
"integration_id": {
"type": "integer",
"format": "int64",
"description": "ServiceDeskPlus integration ID."
},
"incident_id": {
"type": "string",
"description": "Associated Flashduty incident ID."
},
"incident_title": {
"type": "string",
"description": "Associated incident title."
},
"channel_id": {
"type": "integer",
"format": "int64",
"description": "Channel ID for the incident."
},
"channel_name": {
"type": "string",
"description": "Channel name for the incident."
},
"error_message": {
"type": "string",
"description": "Error message when synchronization failed. Usually absent on successful records."
}
}
},
"ServiceDeskPlusRequestListResponse": {
"type": "object",
"description": "Paginated list of ServiceDeskPlus request synchronization records.",
"required": [
"items",
"total",
"has_next_page"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceDeskPlusRequestMappingItem"
},
"description": "Synchronization records on the current page."
},
"total": {
"type": "integer",
"format": "int64",
"description": "Total number of matching records, capped at 1,000 for counting."
},
"has_next_page": {
"type": "boolean",
"description": "True when more results are available."
},
"search_after_ctx": {
"type": "string",
"description": "Cursor for the next page. Empty when no more data is available."
}
}
}
}
}
Expand Down
Loading