{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}
Automations
Run Automation rule
Run an Automation rule once right now, regardless of its triggers or enabled state.
{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}
A manual run does not require the rule to be enabled. It fails with 400 before any run is created if the rule’s configuration is invalid (for example a BYOC runner the rule’s scope may not use), or if the only enabled trigger is the war room trigger (such a rule has no web console run).
A personal rule whose owner has left the account is disabled automatically and the call returns 400.
At most one manual run per rule per minute; a second call within that window returns 429 with code: "RequestTooFrequently".
Manage rights: a personal rule (team_id=0) can be managed only by its owner; a team rule only by members of that team. Account owners and admins get no exemption and must join the team.
While another update, delete, or manual run of the same rule is in progress, the call fails with HTTP 423 and code: "RequestLocked"; retry later.
The call returns once the agent session has started, not when the run finishes. Track completion with List Automation runs (trigger_kind=manual).
run.session_id is omitted for rules that execute in an IM chat (execution_place=im).
APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.
Rule ID, from the list returned by POST /safari/automation/rule/list.
Response
Success
Standard response envelope used by every Flashduty public API. On success data contains the endpoint-specific payload and error is absent. On failure error is present and data is absent. request_id is always present and is also mirrored in the Flashcat-Request-Id response header.
Result of manually running an Automation rule outside its schedule.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Flashduty Docs","description":"Flashduty 官方文档,涵盖 On-call 告警响应、Monitors 监控、RUM 与 AI SRE 的配置指南、集成方式和 API 参考。","colors":{"primary":"#8B5CF6","light":"#8B5CF6","dark":"#8B5CF6"},"logo":{"light":"https://mintcdn.com/flashduty-com/FpfuLufyi4FJe6mQ/logo/saas-logo.svg?fit=max\u0026auto=format\u0026n=FpfuLufyi4FJe6mQ\u0026q=85\u0026s=1656361bf7575f7275615ac9191db061","dark":"https://mintcdn.com/flashduty-com/FpfuLufyi4FJe6mQ/logo/saas-logo-white.svg?fit=max\u0026auto=format\u0026n=FpfuLufyi4FJe6mQ\u0026q=85\u0026s=744bbbd3bb703e9db8183af2ee98f185","href":"https://flashduty.com/"},"favicon":"https://mintcdn.com/flashduty-com/FpfuLufyi4FJe6mQ/logo/saas-favicon.png?fit=max\u0026auto=format\u0026n=FpfuLufyi4FJe6mQ\u0026q=85\u0026s=377e85b5ba71d5351ee7f84b5d70b1e1","navbar":{"links":[{"icon":"code","href":"/zh/openapi/introduction","label":"API Reference"}],"primary":{"type":"button","label":"Console","href":"https://console.flashcat.cloud"}},"seo":{"metatags":{"canonical":"https://docs.flashduty.com"},"organization":{"id":"https://flashduty.com/#organization","name":"Flashduty","legalName":"北京快猫星云科技有限公司","url":"https://flashduty.com/","logo":"https://docs.flashduty.com/logo/saas-logo.svg","sameAs":["https://github.com/flashcatcloud"]},"indexing":"all"},"styling":{"latex":true},"navigation":{"languages":[{"language":"zh","footer":{"socials":{"github":"https://github.com/flashcatcloud"},"links":[{"header":"Flashduty","items":[{"label":"官网","href":"https://www.flashduty.com/zh"},{"label":"定价","href":"https://www.flashduty.com/zh/pricing"},{"label":"集成目录","href":"https://www.flashduty.com/zh/integrations"},{"label":"博客","href":"https://www.flashduty.com/zh/now/blog"}]},{"header":"支持","items":[{"label":"联系我们","href":"https://www.flashduty.com/zh/contact"},{"label":"安全与合规","href":"https://www.flashduty.com/zh/legal/security"},{"label":"服务 SLA","href":"/zh/compliance/service-sla"}]},{"header":"法律","items":[{"label":"服务条款","href":"/zh/compliance/terms-of-service"},{"label":"用户协议","href":"/zh/compliance/user-agreement"},{"label":"隐私政策","href":"/zh/compliance/privacy-policy"},{"label":"退款政策","href":"/zh/compliance/refund-policy"}]}]},"navbar":{"links":[{"icon":"code","href":"/zh/openapi/introduction","label":"API 参考"}],"primary":{"type":"button","label":"控制台","href":"https://console.flashcat.cloud"}},"href":"zh/home"},{"language":"en","footer":{"socials":{"github":"https://github.com/flashcatcloud"},"links":[{"header":"Flashduty","items":[{"label":"Website","href":"https://www.flashduty.com/en"},{"label":"Pricing","href":"https://www.flashduty.com/en/pricing"},{"label":"Integrations","href":"https://www.flashduty.com/en/integrations"},{"label":"Blog","href":"https://www.flashduty.com/en/now/blog"}]},{"header":"Support","items":[{"label":"Contact us","href":"https://www.flashduty.com/en/contact"},{"label":"Security","href":"https://www.flashduty.com/en/legal/security"},{"label":"Service SLA","href":"/en/compliance/service-sla"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"/en/compliance/terms-of-service"},{"label":"User Agreement","href":"/en/compliance/user-agreement"},{"label":"Privacy Policy","href":"/en/compliance/privacy-policy"},{"label":"Refund Policy","href":"/en/compliance/refund-policy"}]}]},"navbar":{"links":[{"icon":"code","href":"/en/openapi/introduction","label":"API Reference"}],"primary":{"type":"button","label":"Console","href":"https://console.flashcat.cloud"}},"href":"en/home"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flashduty-com","hasAudioNarration":false,"actualSubdomain":"flashduty-com","customDomains":["docs.flashduty.com"],"gitSource":{"type":"github","owner":"flashcatcloud","repo":"flashduty-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"3e95add8-1f6c-492b-981c-42bb4ff66315","liveDeploymentHistoryId":"6adaff38f4b49ade1f1e32e2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adaff38f4b49ade1f1e32e2"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adb1f5e146446953a9d9b72","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"en","tag":"On-call","count":609},{"language":"zh","tag":"On-call","count":609},{"language":"en","tag":"API Reference","count":388},{"language":"zh","tag":"API 参考","count":388},{"language":"en","tag":"Integrations","count":366},{"language":"zh","tag":"集成中心","count":366},{"language":"en","tag":"Alert Integration","count":295},{"language":"zh","tag":"告警集成","count":295},{"language":"en","tag":"RUM","count":124},{"language":"zh","tag":"RUM","count":124},{"language":"en","tag":"AI SRE","count":70},{"language":"en","tag":"Monitors","count":70},{"language":"zh","tag":"AI SRE","count":70},{"language":"zh","tag":"Monitors","count":70},{"language":"zh","tag":"故障管理","count":65},{"language":"en","tag":"Incidents","count":55},{"language":"en","tag":"Change Integration","count":40},{"language":"en","tag":"SDK Integration","count":40},{"language":"zh","tag":"变更集成","count":40},{"language":"zh","tag":"SDK 接入","count":40}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/api-reference/ai-sre/automations/automation-rule-write-run","slug":"/en/api-reference/ai-sre/automations/automation-rule-write-run","pageMetadata":{"title":"Run Automation rule","description":"Run an Automation rule once right now, regardless of its triggers or enabled state.","deprecated":null,"version":null,"sidebarTitle":"Run Automation rule","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/rule/run","href":"/en/api-reference/ai-sre/automations/automation-rule-write-run","autogeneratedByOpenApi":true,"hidden":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Run an Automation rule once right now, regardless of its triggers or enabled state.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`restrictions`,children:`Restrictions`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Aspect`}),_jsx(_components.th,{children:`Value`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Rate limits`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`100 requests/minute`}),`; `,_jsx(_components.strong,{children:`5 requests/second`}),` per account`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Permissions`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Automation Manage`}),` (`,_jsx(_components.code,{children:`ai-sre`}),`)`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`usage`,children:`Usage`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`A manual run does not require the rule to be enabled. It fails with `,_jsx(_components.code,{children:`400`}),` before any run is created if the rule’s configuration is invalid (for example a BYOC runner the rule’s scope may not use), or if the only enabled trigger is the war room trigger (such a rule has no web console run).`]}),`\n`,_jsxs(_components.li,{children:[`A personal rule whose owner has left the account is disabled automatically and the call returns `,_jsx(_components.code,{children:`400`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`At most one manual run per rule per minute; a second call within that window returns `,_jsx(_components.code,{children:`429`}),` with `,_jsx(_components.code,{children:`code: \"RequestTooFrequently\"`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Manage rights: a personal rule (`,_jsx(_components.code,{children:`team_id=0`}),`) can be managed only by its owner; a team rule only by members of that team. Account owners and admins get no exemption and must join the team.`]}),`\n`,_jsxs(_components.li,{children:[`While another update, delete, or manual run of the same rule is in progress, the call fails with HTTP `,_jsx(_components.code,{children:`423`}),` and `,_jsx(_components.code,{children:`code: \"RequestLocked\"`}),`; retry later.`]}),`\n`,_jsxs(_components.li,{children:[`The call returns once the agent session has started, not when the run finishes. Track completion with List Automation runs (`,_jsx(_components.code,{children:`trigger_kind=manual`}),`).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`run.session_id`}),` is omitted for rules that execute in an IM chat (`,_jsx(_components.code,{children:`execution_place=im`}),`).`]}),`\n`,_jsx(_components.li,{children:`Every call is recorded in the account audit log.`}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run Automation rule","description":"Run an Automation rule once right now, regardless of its triggers or enabled state.","deprecated":null,"version":null,"sidebarTitle":"Run Automation rule","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/rule/run","href":"/en/api-reference/ai-sre/automations/automation-rule-write-run","autogeneratedByOpenApi":true,"hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Restrictions","slug":"restrictions","depth":2,"children":[]},{"title":"Usage","slug":"usage","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"automation-rule-write-run","summary":"Run Automation rule","description":"Run an Automation rule once right now, regardless of its triggers or enabled state.","tags":["AI SRE/Automations"],"security":["0cd27ea7-7a25-410c-9645-eaf3e2dbfc95"],"x-mint":{"content":"## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **100 requests/minute**; **5 requests/second** per account |\n| Permissions | **Automation Manage** (`ai-sre`) |\n\n## Usage\n\n- A manual run does not require the rule to be enabled. It fails with `400` before any run is created if the rule's configuration is invalid (for example a BYOC runner the rule's scope may not use), or if the only enabled trigger is the war room trigger (such a rule has no web console run).\n- A personal rule whose owner has left the account is disabled automatically and the call returns `400`.\n- At most one manual run per rule per minute; a second call within that window returns `429` with `code: \"RequestTooFrequently\"`.\n- Manage rights: a personal rule (`team_id=0`) can be managed only by its owner; a team rule only by members of that team. Account owners and admins get no exemption and must join the team.\n- While another update, delete, or manual run of the same rule is in progress, the call fails with HTTP `423` and `code: \"RequestLocked\"`; retry later.\n- The call returns once the agent session has started, not when the run finishes. Track completion with List Automation runs (`trigger_kind=manual`).\n- `run.session_id` is omitted for rules that execute in an IM chat (`execution_place=im`).\n- Every call is recorded in the account audit log.\n","href":"/en/api-reference/ai-sre/automations/automation-rule-write-run","metadata":{"sidebarTitle":"Run Automation rule"}},"responses":{"200":"7f2c1792-7519-4a66-88ad-0f5798ffd488","400":"f2842573-be83-41db-9ba2-33435e710d34","401":"af06ce2a-fc5e-4322-a58b-6ccd99fa392d","403":"b8224d2d-3866-4e40-965a-14f35a39edc6","429":"241461d2-c44b-4ec5-94a3-bb8adc12bf2a","500":"f0dc2eb2-f8f1-4c6e-9c1a-53b4dfb1c72f"},"requestBody":"1c04e1ba-4c2a-45e4-a7fe-bea0e106845d","method":"post","type":"path","servers":["c70255cb-a433-44fd-acf3-2539d45126be"],"path":"/safari/automation/rule/run","baseUrlOptions":["https://api.flashcat.cloud"],"title":"Run Automation rule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rule_id":{"type":"string","description":"Rule ID, from the list returned by `POST /safari/automation/rule/list`.","isRequired":true,"uniqueKey":"rule_id","typeLabel":"string"}},"required":["rule_id"],"uniqueKey":"","typeLabel":"object"},"example":{"rule_id":"arule_7NnLzY2Qp8xS4kUaV3mR6b"},"examples":{"Example":{"title":"Example","value":{"rule_id":"arule_7NnLzY2Qp8xS4kUaV3mR6b"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"7f2c1792-7519-4a66-88ad-0f5798ffd488":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Standard response envelope used by every Flashduty public API. On success `data` contains the endpoint-specific payload and `error` is absent. On failure `error` is present and `data` is absent. `request_id` is always present and is also mirrored in the `Flashcat-Request-Id` response header.","required":["request_id"],"properties":{"request_id":{"type":"string","description":"Unique ID for this request. Mirrored in the Flashcat-Request-Id header. Include it when reporting issues.","example":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"error":{"type":"object","description":"Error payload inside the response envelope. Present only on non-2xx responses.","properties":{"code":{"type":"string","description":"Error code. Every failed response sets `error.code` to one of these stable strings; branch on it rather than on the HTTP status.\n\n| Code | HTTP | Meaning |\n|---|---|---|\n| `OK` | 200 | Reserved; never returned on a failed request. |\n| `InvalidParameter` | 400 | A parameter is missing, has the wrong type, or failed validation; `message` usually names the field. |\n| `BadRequest` | 400 | The request breaks a business rule or conflicts with the current state of an object; `message` says which. |\n| `InvalidContentType` | 400 | The body is not sent as `application/json`. |\n| `ResourceNotFound` | 400 | The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404. |\n| `NoLicense` | 400 | The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient. |\n| `ReferenceExist` | 400 | The object is still referenced by other objects, so it cannot be deleted. |\n| `Unauthorized` | 401 | The APP Key is missing, invalid, or deleted. |\n| `BalanceNotEnough` | 402 | Console-only (billing); not returned by Open API operations. |\n| `AccessDenied` | 403 | The APP Key's permission scope or the creator's role does not allow this operation or object. |\n| `RouteNotFound` | 404 | No operation matches the HTTP method and path. |\n| `MethodNotAllowed` | 405 | The path exists but not for this HTTP method. |\n| `UndonedOrderExist` | 409 | Console-only (billing); not returned by Open API operations. |\n| `EntityTooLarge` | 413 | The request body exceeds the size limit. |\n| `RequestLocked` | 423 | Console-only (sign-in protection); not returned by Open API operations. |\n| `RequestVerifyRequired` | 428 | Console-only (verification code); not returned by Open API operations. |\n| `DangerousOperation` | 428 | Console-only (MFA for high-risk actions); not returned by Open API operations. |\n| `RequestTooFrequently` | 429 | A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying. |\n| `InternalError` | 500 | Unexpected server error; retry with backoff and include `request_id` when reporting. |\n| `ServiceUnavailable` | 503 | A backend dependency is overloaded or unavailable; retry with backoff. |","enum":["OK","InvalidParameter","BadRequest","InvalidContentType","ResourceNotFound","NoLicense","ReferenceExist","Unauthorized","BalanceNotEnough","AccessDenied","RouteNotFound","MethodNotAllowed","UndonedOrderExist","EntityTooLarge","RequestLocked","RequestVerifyRequired","DangerousOperation","RequestTooFrequently","InternalError","ServiceUnavailable"],"x-enumDescriptions":{"OK":"Reserved; never returned on a failed request.","InvalidParameter":"A parameter is missing, has the wrong type, or failed validation; `message` usually names the field.","BadRequest":"The request breaks a business rule or conflicts with the current state of an object; `message` says which.","InvalidContentType":"The body is not sent as `application/json`.","ResourceNotFound":"The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404.","NoLicense":"The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient.","ReferenceExist":"The object is still referenced by other objects, so it cannot be deleted.","Unauthorized":"The APP Key is missing, invalid, or deleted.","BalanceNotEnough":"Console-only (billing); not returned by Open API operations.","AccessDenied":"The APP Key's permission scope or the creator's role does not allow this operation or object.","RouteNotFound":"No operation matches the HTTP method and path.","MethodNotAllowed":"The path exists but not for this HTTP method.","UndonedOrderExist":"Console-only (billing); not returned by Open API operations.","EntityTooLarge":"The request body exceeds the size limit.","RequestLocked":"Console-only (sign-in protection); not returned by Open API operations.","RequestVerifyRequired":"Console-only (verification code); not returned by Open API operations.","DangerousOperation":"Console-only (MFA for high-risk actions); not returned by Open API operations.","RequestTooFrequently":"A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying.","InternalError":"Unexpected server error; retry with backoff and include `request_id` when reporting.","ServiceUnavailable":"A backend dependency is overloaded or unavailable; retry with backoff."},"example":"InvalidParameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message in the response language (`locale` / `lang` query parameter or `Accept-Language` header). May name the offending field; do not parse it.","example":"The specified parameter template_id is not valid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"},"data":{"type":"object","description":"Result of manually running an Automation rule outside its schedule.","required":["rule_id","trigger_kind","preflight"],"properties":{"rule_id":{"type":"string","description":"Rule ID that was run.","isRequired":true,"uniqueKey":"data.rule_id","typeLabel":"string"},"trigger_kind":{"type":"string","enum":["manual"],"description":"Always manual for this operation.","isRequired":true,"uniqueKey":"data.trigger_kind","typeLabel":"enum\u003cstring>"},"preflight":{"type":"object","description":"Readiness checks computed before a manual run is allowed to start.","properties":{"ok":{"type":"boolean","description":"Whether all readiness checks passed. Always `true` in a 200 response; a failed preflight returns an error instead.","isRequired":true,"uniqueKey":"data.preflight.ok","typeLabel":"boolean"},"checks":{"type":"array","items":{"type":"string","uniqueKey":"data.preflight.checks.items.[INDEX]","typeLabel":"string"},"description":"Names of the readiness checks performed, in order. Current fixed set: rule_loaded, actor_authorized, app_allowed, runtime_scope_resolved, rule_config_valid.","isRequired":true,"uniqueKey":"data.preflight.checks","typeLabel":"string[]"},"scope":{"type":"string","enum":["person","team"],"description":"Resolved run scope for this run; mirrors the rule's run_scope. One of: `person` (personal rule, runs as its creator), `team` (team rule, runs under the owning team).","isRequired":true,"uniqueKey":"data.preflight.scope","typeLabel":"enum\u003cstring>"},"owner_id":{"type":"integer","format":"int64","description":"Rule owner person ID.","isRequired":true,"uniqueKey":"data.preflight.owner_id","typeLabel":"integer\u003cint64>"},"team_id":{"type":"integer","format":"int64","description":"Rule's scope team ID; 0 means a personal rule.","isRequired":true,"uniqueKey":"data.preflight.team_id","typeLabel":"integer\u003cint64>"},"app_name":{"type":"string","description":"App the rule is scoped to. Currently always ai-sre; manual runs are only supported for that app.","isRequired":true,"uniqueKey":"data.preflight.app_name","typeLabel":"string"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"data.preflight.warnings.items.[INDEX]","typeLabel":"string"},"description":"Non-fatal warnings from preflight. Currently never populated, so the field is omitted.","uniqueKey":"data.preflight.warnings","typeLabel":"string[]"}},"required":["ok","checks","scope","owner_id","team_id","app_name"],"isRequired":true,"uniqueKey":"data.preflight","typeLabel":"object"},"run":{"type":"object","description":"Reference to the run started by a manual trigger.","properties":{"run_id":{"type":"string","description":"Run ID, always populated once a run is created.","isRequired":true,"uniqueKey":"data.run.run_id","typeLabel":"string"},"session_id":{"type":"string","description":"AI SRE session started for this run. Omitted when the rule executes in an IM chat (`execution_place=im`).","uniqueKey":"data.run.session_id","typeLabel":"string"}},"required":["run_id"],"uniqueKey":"data.run","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"request_id":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","data":{"rule_id":"arule_7NnLzY2Qp8xS4kUaV3mR6b","trigger_kind":"manual","preflight":{"ok":true,"checks":["rule_loaded","actor_authorized","app_allowed","runtime_scope_resolved","rule_config_valid"],"scope":"team","owner_id":80011,"team_id":123,"app_name":"ai-sre"},"run":{"run_id":"trun_5oDvqiG64uur6sBNsTc4u","session_id":"sess_f8oDvqiG64uur6sBNsTc4u"}}},"examples":{"Example":{"title":"Example","value":{"request_id":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","data":{"rule_id":"arule_7NnLzY2Qp8xS4kUaV3mR6b","trigger_kind":"manual","preflight":{"ok":true,"checks":["rule_loaded","actor_authorized","app_allowed","runtime_scope_resolved","rule_config_valid"],"scope":"team","owner_id":80011,"team_id":123,"app_name":"ai-sre"},"run":{"run_id":"trun_5oDvqiG64uur6sBNsTc4u","session_id":"sess_f8oDvqiG64uur6sBNsTc4u"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"f2842573-be83-41db-9ba2-33435e710d34":{"description":"Invalid request — usually a missing or malformed parameter.","content":{"application/json":{"schema":{"type":"object","description":"Response envelope for errors. `error` is required; `data` is absent.","properties":{"request_id":{"type":"string","example":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","description":"Unique trace ID of this request; include it when reporting issues so logs can be located.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"error":{"type":"object","description":"Error payload inside the response envelope. Present only on non-2xx responses.","properties":{"code":{"type":"string","description":"Error code. Every failed response sets `error.code` to one of these stable strings; branch on it rather than on the HTTP status.\n\n| Code | HTTP | Meaning |\n|---|---|---|\n| `OK` | 200 | Reserved; never returned on a failed request. |\n| `InvalidParameter` | 400 | A parameter is missing, has the wrong type, or failed validation; `message` usually names the field. |\n| `BadRequest` | 400 | The request breaks a business rule or conflicts with the current state of an object; `message` says which. |\n| `InvalidContentType` | 400 | The body is not sent as `application/json`. |\n| `ResourceNotFound` | 400 | The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404. |\n| `NoLicense` | 400 | The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient. |\n| `ReferenceExist` | 400 | The object is still referenced by other objects, so it cannot be deleted. |\n| `Unauthorized` | 401 | The APP Key is missing, invalid, or deleted. |\n| `BalanceNotEnough` | 402 | Console-only (billing); not returned by Open API operations. |\n| `AccessDenied` | 403 | The APP Key's permission scope or the creator's role does not allow this operation or object. |\n| `RouteNotFound` | 404 | No operation matches the HTTP method and path. |\n| `MethodNotAllowed` | 405 | The path exists but not for this HTTP method. |\n| `UndonedOrderExist` | 409 | Console-only (billing); not returned by Open API operations. |\n| `EntityTooLarge` | 413 | The request body exceeds the size limit. |\n| `RequestLocked` | 423 | Console-only (sign-in protection); not returned by Open API operations. |\n| `RequestVerifyRequired` | 428 | Console-only (verification code); not returned by Open API operations. |\n| `DangerousOperation` | 428 | Console-only (MFA for high-risk actions); not returned by Open API operations. |\n| `RequestTooFrequently` | 429 | A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying. |\n| `InternalError` | 500 | Unexpected server error; retry with backoff and include `request_id` when reporting. |\n| `ServiceUnavailable` | 503 | A backend dependency is overloaded or unavailable; retry with backoff. |","enum":["OK","InvalidParameter","BadRequest","InvalidContentType","ResourceNotFound","NoLicense","ReferenceExist","Unauthorized","BalanceNotEnough","AccessDenied","RouteNotFound","MethodNotAllowed","UndonedOrderExist","EntityTooLarge","RequestLocked","RequestVerifyRequired","DangerousOperation","RequestTooFrequently","InternalError","ServiceUnavailable"],"x-enumDescriptions":{"OK":"Reserved; never returned on a failed request.","InvalidParameter":"A parameter is missing, has the wrong type, or failed validation; `message` usually names the field.","BadRequest":"The request breaks a business rule or conflicts with the current state of an object; `message` says which.","InvalidContentType":"The body is not sent as `application/json`.","ResourceNotFound":"The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404.","NoLicense":"The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient.","ReferenceExist":"The object is still referenced by other objects, so it cannot be deleted.","Unauthorized":"The APP Key is missing, invalid, or deleted.","BalanceNotEnough":"Console-only (billing); not returned by Open API operations.","AccessDenied":"The APP Key's permission scope or the creator's role does not allow this operation or object.","RouteNotFound":"No operation matches the HTTP method and path.","MethodNotAllowed":"The path exists but not for this HTTP method.","UndonedOrderExist":"Console-only (billing); not returned by Open API operations.","EntityTooLarge":"The request body exceeds the size limit.","RequestLocked":"Console-only (sign-in protection); not returned by Open API operations.","RequestVerifyRequired":"Console-only (verification code); not returned by Open API operations.","DangerousOperation":"Console-only (MFA for high-risk actions); not returned by Open API operations.","RequestTooFrequently":"A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying.","InternalError":"Unexpected server error; retry with backoff and include `request_id` when reporting.","ServiceUnavailable":"A backend dependency is overloaded or unavailable; retry with backoff."},"example":"InvalidParameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message in the response language (`locale` / `lang` query parameter or `Accept-Language` header). May name the offending field; do not parse it.","example":"The specified parameter template_id is not valid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["request_id","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"missingParameter":{"title":"missingParameter","value":{"request_id":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","error":{"code":"InvalidParameter","message":"The specified parameter skill_id is not valid."}}}},"exampleType":"examples"}},"exampleType":"examples"},"af06ce2a-fc5e-4322-a58b-6ccd99fa392d":{"description":"Missing or invalid app_key.","content":{"application/json":{"schema":{"type":"object","description":"Response envelope for errors. `error` is required; `data` is absent.","properties":{"request_id":{"type":"string","example":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","description":"Unique trace ID of this request; include it when reporting issues so logs can be located.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"error":{"type":"object","description":"Error payload inside the response envelope. Present only on non-2xx responses.","properties":{"code":{"type":"string","description":"Error code. Every failed response sets `error.code` to one of these stable strings; branch on it rather than on the HTTP status.\n\n| Code | HTTP | Meaning |\n|---|---|---|\n| `OK` | 200 | Reserved; never returned on a failed request. |\n| `InvalidParameter` | 400 | A parameter is missing, has the wrong type, or failed validation; `message` usually names the field. |\n| `BadRequest` | 400 | The request breaks a business rule or conflicts with the current state of an object; `message` says which. |\n| `InvalidContentType` | 400 | The body is not sent as `application/json`. |\n| `ResourceNotFound` | 400 | The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404. |\n| `NoLicense` | 400 | The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient. |\n| `ReferenceExist` | 400 | The object is still referenced by other objects, so it cannot be deleted. |\n| `Unauthorized` | 401 | The APP Key is missing, invalid, or deleted. |\n| `BalanceNotEnough` | 402 | Console-only (billing); not returned by Open API operations. |\n| `AccessDenied` | 403 | The APP Key's permission scope or the creator's role does not allow this operation or object. |\n| `RouteNotFound` | 404 | No operation matches the HTTP method and path. |\n| `MethodNotAllowed` | 405 | The path exists but not for this HTTP method. |\n| `UndonedOrderExist` | 409 | Console-only (billing); not returned by Open API operations. |\n| `EntityTooLarge` | 413 | The request body exceeds the size limit. |\n| `RequestLocked` | 423 | Console-only (sign-in protection); not returned by Open API operations. |\n| `RequestVerifyRequired` | 428 | Console-only (verification code); not returned by Open API operations. |\n| `DangerousOperation` | 428 | Console-only (MFA for high-risk actions); not returned by Open API operations. |\n| `RequestTooFrequently` | 429 | A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying. |\n| `InternalError` | 500 | Unexpected server error; retry with backoff and include `request_id` when reporting. |\n| `ServiceUnavailable` | 503 | A backend dependency is overloaded or unavailable; retry with backoff. |","enum":["OK","InvalidParameter","BadRequest","InvalidContentType","ResourceNotFound","NoLicense","ReferenceExist","Unauthorized","BalanceNotEnough","AccessDenied","RouteNotFound","MethodNotAllowed","UndonedOrderExist","EntityTooLarge","RequestLocked","RequestVerifyRequired","DangerousOperation","RequestTooFrequently","InternalError","ServiceUnavailable"],"x-enumDescriptions":{"OK":"Reserved; never returned on a failed request.","InvalidParameter":"A parameter is missing, has the wrong type, or failed validation; `message` usually names the field.","BadRequest":"The request breaks a business rule or conflicts with the current state of an object; `message` says which.","InvalidContentType":"The body is not sent as `application/json`.","ResourceNotFound":"The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404.","NoLicense":"The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient.","ReferenceExist":"The object is still referenced by other objects, so it cannot be deleted.","Unauthorized":"The APP Key is missing, invalid, or deleted.","BalanceNotEnough":"Console-only (billing); not returned by Open API operations.","AccessDenied":"The APP Key's permission scope or the creator's role does not allow this operation or object.","RouteNotFound":"No operation matches the HTTP method and path.","MethodNotAllowed":"The path exists but not for this HTTP method.","UndonedOrderExist":"Console-only (billing); not returned by Open API operations.","EntityTooLarge":"The request body exceeds the size limit.","RequestLocked":"Console-only (sign-in protection); not returned by Open API operations.","RequestVerifyRequired":"Console-only (verification code); not returned by Open API operations.","DangerousOperation":"Console-only (MFA for high-risk actions); not returned by Open API operations.","RequestTooFrequently":"A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying.","InternalError":"Unexpected server error; retry with backoff and include `request_id` when reporting.","ServiceUnavailable":"A backend dependency is overloaded or unavailable; retry with backoff."},"example":"InvalidParameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message in the response language (`locale` / `lang` query parameter or `Accept-Language` header). May name the offending field; do not parse it.","example":"The specified parameter template_id is not valid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["request_id","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"missingAppKey":{"title":"missingAppKey","value":{"request_id":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","error":{"code":"Unauthorized","message":"You are unauthorized."}}}},"exampleType":"examples"}},"exampleType":"examples"},"b8224d2d-3866-4e40-965a-14f35a39edc6":{"description":"The app_key is valid, but its permission scope or the creator's role does not allow this operation or object.","content":{"application/json":{"schema":{"type":"object","description":"Response envelope for errors. `error` is required; `data` is absent.","properties":{"request_id":{"type":"string","example":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","description":"Unique trace ID of this request; include it when reporting issues so logs can be located.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"error":{"type":"object","description":"Error payload inside the response envelope. Present only on non-2xx responses.","properties":{"code":{"type":"string","description":"Error code. Every failed response sets `error.code` to one of these stable strings; branch on it rather than on the HTTP status.\n\n| Code | HTTP | Meaning |\n|---|---|---|\n| `OK` | 200 | Reserved; never returned on a failed request. |\n| `InvalidParameter` | 400 | A parameter is missing, has the wrong type, or failed validation; `message` usually names the field. |\n| `BadRequest` | 400 | The request breaks a business rule or conflicts with the current state of an object; `message` says which. |\n| `InvalidContentType` | 400 | The body is not sent as `application/json`. |\n| `ResourceNotFound` | 400 | The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404. |\n| `NoLicense` | 400 | The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient. |\n| `ReferenceExist` | 400 | The object is still referenced by other objects, so it cannot be deleted. |\n| `Unauthorized` | 401 | The APP Key is missing, invalid, or deleted. |\n| `BalanceNotEnough` | 402 | Console-only (billing); not returned by Open API operations. |\n| `AccessDenied` | 403 | The APP Key's permission scope or the creator's role does not allow this operation or object. |\n| `RouteNotFound` | 404 | No operation matches the HTTP method and path. |\n| `MethodNotAllowed` | 405 | The path exists but not for this HTTP method. |\n| `UndonedOrderExist` | 409 | Console-only (billing); not returned by Open API operations. |\n| `EntityTooLarge` | 413 | The request body exceeds the size limit. |\n| `RequestLocked` | 423 | Console-only (sign-in protection); not returned by Open API operations. |\n| `RequestVerifyRequired` | 428 | Console-only (verification code); not returned by Open API operations. |\n| `DangerousOperation` | 428 | Console-only (MFA for high-risk actions); not returned by Open API operations. |\n| `RequestTooFrequently` | 429 | A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying. |\n| `InternalError` | 500 | Unexpected server error; retry with backoff and include `request_id` when reporting. |\n| `ServiceUnavailable` | 503 | A backend dependency is overloaded or unavailable; retry with backoff. |","enum":["OK","InvalidParameter","BadRequest","InvalidContentType","ResourceNotFound","NoLicense","ReferenceExist","Unauthorized","BalanceNotEnough","AccessDenied","RouteNotFound","MethodNotAllowed","UndonedOrderExist","EntityTooLarge","RequestLocked","RequestVerifyRequired","DangerousOperation","RequestTooFrequently","InternalError","ServiceUnavailable"],"x-enumDescriptions":{"OK":"Reserved; never returned on a failed request.","InvalidParameter":"A parameter is missing, has the wrong type, or failed validation; `message` usually names the field.","BadRequest":"The request breaks a business rule or conflicts with the current state of an object; `message` says which.","InvalidContentType":"The body is not sent as `application/json`.","ResourceNotFound":"The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404.","NoLicense":"The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient.","ReferenceExist":"The object is still referenced by other objects, so it cannot be deleted.","Unauthorized":"The APP Key is missing, invalid, or deleted.","BalanceNotEnough":"Console-only (billing); not returned by Open API operations.","AccessDenied":"The APP Key's permission scope or the creator's role does not allow this operation or object.","RouteNotFound":"No operation matches the HTTP method and path.","MethodNotAllowed":"The path exists but not for this HTTP method.","UndonedOrderExist":"Console-only (billing); not returned by Open API operations.","EntityTooLarge":"The request body exceeds the size limit.","RequestLocked":"Console-only (sign-in protection); not returned by Open API operations.","RequestVerifyRequired":"Console-only (verification code); not returned by Open API operations.","DangerousOperation":"Console-only (MFA for high-risk actions); not returned by Open API operations.","RequestTooFrequently":"A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying.","InternalError":"Unexpected server error; retry with backoff and include `request_id` when reporting.","ServiceUnavailable":"A backend dependency is overloaded or unavailable; retry with backoff."},"example":"InvalidParameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message in the response language (`locale` / `lang` query parameter or `Accept-Language` header). May name the offending field; do not parse it.","example":"The specified parameter template_id is not valid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["request_id","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"accessDenied":{"title":"accessDenied","value":{"request_id":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","error":{"code":"AccessDenied","message":"Access Denied."}}}},"exampleType":"examples"}},"exampleType":"examples"},"241461d2-c44b-4ec5-94a3-bb8adc12bf2a":{"description":"Rate limit hit. Wait for the number of seconds in `Flashcat-Request-Rate-Limit-Delay`, then retry.","content":{"application/json":{"schema":{"type":"object","description":"Response envelope for errors. `error` is required; `data` is absent.","properties":{"request_id":{"type":"string","example":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","description":"Unique trace ID of this request; include it when reporting issues so logs can be located.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"error":{"type":"object","description":"Error payload inside the response envelope. Present only on non-2xx responses.","properties":{"code":{"type":"string","description":"Error code. Every failed response sets `error.code` to one of these stable strings; branch on it rather than on the HTTP status.\n\n| Code | HTTP | Meaning |\n|---|---|---|\n| `OK` | 200 | Reserved; never returned on a failed request. |\n| `InvalidParameter` | 400 | A parameter is missing, has the wrong type, or failed validation; `message` usually names the field. |\n| `BadRequest` | 400 | The request breaks a business rule or conflicts with the current state of an object; `message` says which. |\n| `InvalidContentType` | 400 | The body is not sent as `application/json`. |\n| `ResourceNotFound` | 400 | The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404. |\n| `NoLicense` | 400 | The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient. |\n| `ReferenceExist` | 400 | The object is still referenced by other objects, so it cannot be deleted. |\n| `Unauthorized` | 401 | The APP Key is missing, invalid, or deleted. |\n| `BalanceNotEnough` | 402 | Console-only (billing); not returned by Open API operations. |\n| `AccessDenied` | 403 | The APP Key's permission scope or the creator's role does not allow this operation or object. |\n| `RouteNotFound` | 404 | No operation matches the HTTP method and path. |\n| `MethodNotAllowed` | 405 | The path exists but not for this HTTP method. |\n| `UndonedOrderExist` | 409 | Console-only (billing); not returned by Open API operations. |\n| `EntityTooLarge` | 413 | The request body exceeds the size limit. |\n| `RequestLocked` | 423 | Console-only (sign-in protection); not returned by Open API operations. |\n| `RequestVerifyRequired` | 428 | Console-only (verification code); not returned by Open API operations. |\n| `DangerousOperation` | 428 | Console-only (MFA for high-risk actions); not returned by Open API operations. |\n| `RequestTooFrequently` | 429 | A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying. |\n| `InternalError` | 500 | Unexpected server error; retry with backoff and include `request_id` when reporting. |\n| `ServiceUnavailable` | 503 | A backend dependency is overloaded or unavailable; retry with backoff. |","enum":["OK","InvalidParameter","BadRequest","InvalidContentType","ResourceNotFound","NoLicense","ReferenceExist","Unauthorized","BalanceNotEnough","AccessDenied","RouteNotFound","MethodNotAllowed","UndonedOrderExist","EntityTooLarge","RequestLocked","RequestVerifyRequired","DangerousOperation","RequestTooFrequently","InternalError","ServiceUnavailable"],"x-enumDescriptions":{"OK":"Reserved; never returned on a failed request.","InvalidParameter":"A parameter is missing, has the wrong type, or failed validation; `message` usually names the field.","BadRequest":"The request breaks a business rule or conflicts with the current state of an object; `message` says which.","InvalidContentType":"The body is not sent as `application/json`.","ResourceNotFound":"The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404.","NoLicense":"The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient.","ReferenceExist":"The object is still referenced by other objects, so it cannot be deleted.","Unauthorized":"The APP Key is missing, invalid, or deleted.","BalanceNotEnough":"Console-only (billing); not returned by Open API operations.","AccessDenied":"The APP Key's permission scope or the creator's role does not allow this operation or object.","RouteNotFound":"No operation matches the HTTP method and path.","MethodNotAllowed":"The path exists but not for this HTTP method.","UndonedOrderExist":"Console-only (billing); not returned by Open API operations.","EntityTooLarge":"The request body exceeds the size limit.","RequestLocked":"Console-only (sign-in protection); not returned by Open API operations.","RequestVerifyRequired":"Console-only (verification code); not returned by Open API operations.","DangerousOperation":"Console-only (MFA for high-risk actions); not returned by Open API operations.","RequestTooFrequently":"A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying.","InternalError":"Unexpected server error; retry with backoff and include `request_id` when reporting.","ServiceUnavailable":"A backend dependency is overloaded or unavailable; retry with backoff."},"example":"InvalidParameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message in the response language (`locale` / `lang` query parameter or `Accept-Language` header). May name the offending field; do not parse it.","example":"The specified parameter template_id is not valid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["request_id","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"rateLimited":{"title":"rateLimited","value":{"request_id":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","error":{"code":"RequestTooFrequently","message":"Request too frequently."}}}},"exampleType":"examples"}},"headers":{"Flashcat-Request-Rate-Limit-Delay":{"description":"Seconds until the current rate-limit window resets. Absent when the request was rejected by the gateway's global protection limit.","schema":{"type":"integer","minimum":0}}},"exampleType":"examples"},"f0dc2eb2-f8f1-4c6e-9c1a-53b4dfb1c72f":{"description":"Unexpected server-side error. Include the request_id when reporting.","content":{"application/json":{"schema":{"type":"object","description":"Response envelope for errors. `error` is required; `data` is absent.","properties":{"request_id":{"type":"string","example":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","description":"Unique trace ID of this request; include it when reporting issues so logs can be located.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"error":{"type":"object","description":"Error payload inside the response envelope. Present only on non-2xx responses.","properties":{"code":{"type":"string","description":"Error code. Every failed response sets `error.code` to one of these stable strings; branch on it rather than on the HTTP status.\n\n| Code | HTTP | Meaning |\n|---|---|---|\n| `OK` | 200 | Reserved; never returned on a failed request. |\n| `InvalidParameter` | 400 | A parameter is missing, has the wrong type, or failed validation; `message` usually names the field. |\n| `BadRequest` | 400 | The request breaks a business rule or conflicts with the current state of an object; `message` says which. |\n| `InvalidContentType` | 400 | The body is not sent as `application/json`. |\n| `ResourceNotFound` | 400 | The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404. |\n| `NoLicense` | 400 | The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient. |\n| `ReferenceExist` | 400 | The object is still referenced by other objects, so it cannot be deleted. |\n| `Unauthorized` | 401 | The APP Key is missing, invalid, or deleted. |\n| `BalanceNotEnough` | 402 | Console-only (billing); not returned by Open API operations. |\n| `AccessDenied` | 403 | The APP Key's permission scope or the creator's role does not allow this operation or object. |\n| `RouteNotFound` | 404 | No operation matches the HTTP method and path. |\n| `MethodNotAllowed` | 405 | The path exists but not for this HTTP method. |\n| `UndonedOrderExist` | 409 | Console-only (billing); not returned by Open API operations. |\n| `EntityTooLarge` | 413 | The request body exceeds the size limit. |\n| `RequestLocked` | 423 | Console-only (sign-in protection); not returned by Open API operations. |\n| `RequestVerifyRequired` | 428 | Console-only (verification code); not returned by Open API operations. |\n| `DangerousOperation` | 428 | Console-only (MFA for high-risk actions); not returned by Open API operations. |\n| `RequestTooFrequently` | 429 | A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying. |\n| `InternalError` | 500 | Unexpected server error; retry with backoff and include `request_id` when reporting. |\n| `ServiceUnavailable` | 503 | A backend dependency is overloaded or unavailable; retry with backoff. |","enum":["OK","InvalidParameter","BadRequest","InvalidContentType","ResourceNotFound","NoLicense","ReferenceExist","Unauthorized","BalanceNotEnough","AccessDenied","RouteNotFound","MethodNotAllowed","UndonedOrderExist","EntityTooLarge","RequestLocked","RequestVerifyRequired","DangerousOperation","RequestTooFrequently","InternalError","ServiceUnavailable"],"x-enumDescriptions":{"OK":"Reserved; never returned on a failed request.","InvalidParameter":"A parameter is missing, has the wrong type, or failed validation; `message` usually names the field.","BadRequest":"The request breaks a business rule or conflicts with the current state of an object; `message` says which.","InvalidContentType":"The body is not sent as `application/json`.","ResourceNotFound":"The referenced object does not exist in this account or was deleted. Returned as HTTP 400, not 404.","NoLicense":"The account's plan does not include the feature, a plan quota is used up, the plan has expired, or credits are insufficient.","ReferenceExist":"The object is still referenced by other objects, so it cannot be deleted.","Unauthorized":"The APP Key is missing, invalid, or deleted.","BalanceNotEnough":"Console-only (billing); not returned by Open API operations.","AccessDenied":"The APP Key's permission scope or the creator's role does not allow this operation or object.","RouteNotFound":"No operation matches the HTTP method and path.","MethodNotAllowed":"The path exists but not for this HTTP method.","UndonedOrderExist":"Console-only (billing); not returned by Open API operations.","EntityTooLarge":"The request body exceeds the size limit.","RequestLocked":"Console-only (sign-in protection); not returned by Open API operations.","RequestVerifyRequired":"Console-only (verification code); not returned by Open API operations.","DangerousOperation":"Console-only (MFA for high-risk actions); not returned by Open API operations.","RequestTooFrequently":"A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before retrying.","InternalError":"Unexpected server error; retry with backoff and include `request_id` when reporting.","ServiceUnavailable":"A backend dependency is overloaded or unavailable; retry with backoff."},"example":"InvalidParameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message in the response language (`locale` / `lang` query parameter or `Accept-Language` header). May name the offending field; do not parse it.","example":"The specified parameter template_id is not valid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["request_id","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"internal":{"title":"internal","value":{"request_id":"01HK8XQE3Z7JM2NTFQ5YJ8P9R4","error":{"code":"InternalError","message":"We encountered an internal error, and it has been reported. Please try again later."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0cd27ea7-7a25-410c-9645-eaf3e2dbfc95":{"AppKeyAuth":{"type":"apiKey","in":"query","name":"app_key","description":"APP Key created in the Flashduty console under My → APP Key. Send it as the `app_key` query parameter or in the `Fd-App-Key` request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.","scopes":[],"schemeName":"AppKeyAuth"}}},"servers":{"c70255cb-a433-44fd-acf3-2539d45126be":{"url":"https://api.flashcat.cloud","description":"Flashduty Open API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"query","name":"app_key","description":"APP Key created in the Flashduty console under My → APP Key. Send it as the `app_key` query parameter or in the `Fd-App-Key` request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.","scopes":[],"schemeName":"AppKeyAuth"},"schema":{"title":"app_key","type":"string","description":"APP Key created in the Flashduty console under My → APP Key. Send it as the `app_key` query parameter or in the `Fd-App-Key` request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AppKeyAuth","name":"app_key"}],"title":"AppKeyAuth"}]},"originalFileLocation":"api-reference/safari.openapi.en.json"},"subdomain":"flashduty-com","siteName":"Flashduty Docs","title":"Run Automation rule - Flashduty Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"zh":{"href":"/zh/api-reference/ai-sre/automations/automation-rule-write-run","matchLevel":1,"hidden":true},"en":{"href":"/en/api-reference/ai-sre/automations/automation-rule-write-run","matchLevel":0}}},"lastModified":"2026-10-22T09:53:07.864Z","originalFileLocation":"en/api-reference/ai-sre/automations/automation-rule-write-run.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Run an Automation rule once right now, regardless of its triggers or enabled state.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flashduty Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run Automation rule - Flashduty Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run an Automation rule once right now, regardless of its triggers or enabled state.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flashduty Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flashduty-com.mintlify.app/_mintlify/api/og/v2?division=Automations\u0026amp;title=Run+Automation+rule\u0026amp;description=Run+an+Automation+rule+once+right+now%2C+regardless+of+its+triggers+or+enabled+state.\u0026amp;theme=b197fec5a6a7255d894ef20b\u0026amp;signature=eb5f2be8e5c2fa16514869719359d29753fdd37e06e25a1f3778713f41e35d02\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Run Automation rule - Flashduty Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run an Automation rule once right now, regardless of its triggers or enabled state.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flashduty-com.mintlify.app/_mintlify/api/og/v2?division=Automations\u0026amp;title=Run+Automation+rule\u0026amp;description=Run+an+Automation+rule+once+right+now%2C+regardless+of+its+triggers+or+enabled+state.\u0026amp;theme=b197fec5a6a7255d894ef20b\u0026amp;signature=eb5f2be8e5c2fa16514869719359d29753fdd37e06e25a1f3778713f41e35d02\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flashduty Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8B5CF6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/ai-sre/automations/automation-rule-write-run.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.flashduty.com/zh/api-reference/ai-sre/automations/automation-rule-write-run\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.flashduty.com/zh/api-reference/ai-sre/automations/automation-rule-write-run\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://flashduty.com/#organization\",\"name\":\"Flashduty\",\"legalName\":\"北京快猫星云科技有限公司\",\"url\":\"https://flashduty.com/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.flashduty.com/logo/saas-logo.svg\"},\"sameAs\":[\"https://github.com/flashcatcloud\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flashduty.com#website\",\"name\":\"Flashduty Docs\",\"url\":\"https://docs.flashduty.com\",\"publisher\":{\"@id\":\"https://flashduty.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run#webpage\",\"url\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run\",\"name\":\"Run Automation rule\",\"description\":\"Run an Automation rule once right now, regardless of its triggers or enabled state.\",\"dateModified\":\"2026-10-22T09:53:07.864Z\",\"isPartOf\":{\"@id\":\"https://docs.flashduty.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"AI SRE\",\"item\":\"https://docs.flashduty.com/en/api-reference/ai-sre/sessions/session-read-list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Automations\",\"item\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Run Automation rule\",\"item\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run#apireference\",\"headline\":\"Run Automation rule\",\"name\":\"Run Automation rule\",\"description\":\"Run an Automation rule once right now, regardless of its triggers or enabled state.\",\"url\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flashduty.com/en/api-reference/ai-sre/automations/automation-rule-write-run#webpage\"},\"dateModified\":\"2026-10-22T09:53:07.864Z\",\"publisher\":{\"@id\":\"https://flashduty.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flashduty.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flashduty Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Flashduty Docs","nav":{"global":null,"languages":[{"language":"zh","footer":{"socials":{"github":"https://github.com/flashcatcloud"},"links":[{"header":"Flashduty","items":[{"label":"官网","href":"https://www.flashduty.com/zh"},{"label":"定价","href":"https://www.flashduty.com/zh/pricing"},{"label":"集成目录","href":"https://www.flashduty.com/zh/integrations"},{"label":"博客","href":"https://www.flashduty.com/zh/now/blog"}]},{"header":"支持","items":[{"label":"联系我们","href":"https://www.flashduty.com/zh/contact"},{"label":"安全与合规","href":"https://www.flashduty.com/zh/legal/security"},{"label":"服务 SLA","href":"/zh/compliance/service-sla"}]},{"header":"法律","items":[{"label":"服务条款","href":"/zh/compliance/terms-of-service"},{"label":"用户协议","href":"/zh/compliance/user-agreement"},{"label":"隐私政策","href":"/zh/compliance/privacy-policy"},{"label":"退款政策","href":"/zh/compliance/refund-policy"}]}]},"navbar":{"links":[{"icon":"code","href":"/zh/openapi/introduction","label":"API 参考"}],"primary":{"type":"button","label":"控制台","href":"https://console.flashcat.cloud"}},"pages":[{"title":"zh","href":"/zh/api-reference/ai-sre/automations/automation-rule-write-run"}]},{"language":"en","footer":{"socials":{"github":"https://github.com/flashcatcloud"},"links":[{"header":"Flashduty","items":[{"label":"Website","href":"https://www.flashduty.com/en"},{"label":"Pricing","href":"https://www.flashduty.com/en/pricing"},{"label":"Integrations","href":"https://www.flashduty.com/en/integrations"},{"label":"Blog","href":"https://www.flashduty.com/en/now/blog"}]},{"header":"Support","items":[{"label":"Contact us","href":"https://www.flashduty.com/en/contact"},{"label":"Security","href":"https://www.flashduty.com/en/legal/security"},{"label":"Service SLA","href":"/en/compliance/service-sla"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"/en/compliance/terms-of-service"},{"label":"User Agreement","href":"/en/compliance/user-agreement"},{"label":"Privacy Policy","href":"/en/compliance/privacy-policy"},{"label":"Refund Policy","href":"/en/compliance/refund-policy"}]}]},"navbar":{"links":[{"icon":"code","href":"/en/openapi/introduction","label":"API Reference"}],"primary":{"type":"button","label":"Console","href":"https://console.flashcat.cloud"}},"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":"/en/home"}]},{"tab":"AI SRE","icon":"sparkles","pages":[{"title":"AI SRE","href":"/en/ai-sre/quickstart"}]},{"tab":"On-call","icon":"light-emergency-on","pages":[{"title":"On-call","href":"/en/on-call/quickstart/quickstart"}]},{"tab":"RUM","icon":"monitor-waveform","pages":[{"title":"RUM","href":"/en/rum/quickstart/quickstart"}]},{"tab":"Monitors","icon":"chart-area","pages":[{"title":"Monitors","href":"/en/monitors/quickstart/quickstart"}]},{"tab":"API Reference","icon":"terminal","hidden":true,"groups":[{"group":"Developer Guide","icon":"book-open","pages":[{"title":"Quick start","description":"Flashduty Open API quick start guide","href":"/en/openapi/introduction"},{"title":"API catalog","description":"Complete list of Flashduty Open API endpoints, organized by product module with links to detailed documentation","href":"/en/openapi/api-catalog"},{"title":"About pagination","description":"Flashduty Open API pagination mechanism","href":"/en/openapi/pagination"},{"title":"Rate limits and errors","description":"Flashduty Open API rate limits, permission checks, error codes, and retry advice","href":"/en/openapi/rate-limits"}]},{"group":"On-call","icon":"light-emergency-on","pages":[{"group":"Incidents","icon":"siren-on","pages":[{"group":"Incident info","icon":"circle-info","pages":[{"title":"List incidents","description":"Query a paginated list of incidents with filters by channel, severity, status, responder, and time range.","deprecated":null,"version":null,"sidebarTitle":"List incidents","openapi":"/api-reference/on-call.openapi.en.json post /incident/list","href":"/en/api-reference/on-call/incidents/incident-list"},{"title":"Get incident detail","description":"Get one incident by ID or short number, with responders, assignment, custom fields, and alert counts.","deprecated":null,"version":null,"sidebarTitle":"Get incident detail","openapi":"/api-reference/on-call.openapi.en.json post /incident/info","href":"/en/api-reference/on-call/incidents/incident-info"},{"title":"List incidents by IDs","description":"Retrieve multiple incidents by their IDs in a single request.","deprecated":null,"version":null,"sidebarTitle":"List incidents by IDs","openapi":"/api-reference/on-call.openapi.en.json post /incident/list-by-ids","href":"/en/api-reference/on-call/incidents/incident-list-by-ids"},{"title":"List alerts of incident","description":"List all alerts merged into a specific incident.","deprecated":null,"version":null,"sidebarTitle":"List alerts of incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/alert/list","href":"/en/api-reference/on-call/incidents/incident-alert-list"},{"title":"Get incident timeline","description":"List an incident's timeline entries, such as state changes, assignments, notifications, comments, and work item events.","deprecated":null,"version":null,"sidebarTitle":"Get incident timeline","openapi":"/api-reference/on-call.openapi.en.json post /incident/feed","href":"/en/api-reference/on-call/incidents/incident-feed"},{"title":"List past incidents","description":"List closed incidents in the same channel that resemble a given incident, to reuse past root causes and resolutions.","deprecated":null,"version":null,"sidebarTitle":"List past incidents","openapi":"/api-reference/on-call.openapi.en.json post /incident/past/list","href":"/en/api-reference/on-call/incidents/incident-past-list"},{"title":"Get ServiceDeskPlus linked incidents","description":"List synchronization mappings between ServiceDeskPlus requests and Flashduty incidents.","deprecated":null,"version":null,"sidebarTitle":"Get ServiceDeskPlus linked incidents","openapi":"/api-reference/on-call.openapi.en.json post /incident/sdp/request/list","href":"/en/api-reference/on-call/incidents/incident-service-desk-plus-request-read-list"},{"title":"Update incident fields","description":"Update an incident's title, description, impact, root cause, resolution, or severity in one call.","deprecated":null,"version":null,"sidebarTitle":"Update incident fields","openapi":"/api-reference/on-call.openapi.en.json post /incident/reset","href":"/en/api-reference/on-call/incidents/incident-reset"},{"title":"Add comment to incident","description":"Add a text comment to the incident timeline.","deprecated":null,"version":null,"sidebarTitle":"Add comment to incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/comment","href":"/en/api-reference/on-call/incidents/incident-comment"},{"title":"Update incident custom field","description":"Update a custom field value on an incident.","deprecated":null,"version":null,"sidebarTitle":"Update incident custom field","openapi":"/api-reference/on-call.openapi.en.json post /incident/field/reset","href":"/en/api-reference/on-call/incidents/incident-field-reset"},{"title":"Execute custom action","description":"Execute a custom action configured for an incident.","deprecated":null,"version":null,"sidebarTitle":"Execute custom action","openapi":"/api-reference/on-call.openapi.en.json post /incident/custom-action/do","href":"/en/api-reference/on-call/incidents/incident-custom-action-do"}]},{"group":"Status lifecycle","icon":"timeline","pages":[{"title":"Create incident","description":"Manually create a new incident and assign responders.","deprecated":null,"version":null,"sidebarTitle":"Create incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/create","href":"/en/api-reference/on-call/incidents/incident-create"},{"title":"Acknowledge incident","description":"Acknowledge an incident to indicate you are actively working on it.","deprecated":null,"version":null,"sidebarTitle":"Acknowledge incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/ack","href":"/en/api-reference/on-call/incidents/incident-ack"},{"title":"Unacknowledge incident","description":"Withdraw the calling member's acknowledgement of one or more incidents.","deprecated":null,"version":null,"sidebarTitle":"Unacknowledge incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/unack","href":"/en/api-reference/on-call/incidents/incident-unack"},{"title":"Resolve incident","description":"Close one or more incidents, optionally recording root cause, resolution, and resolution form values.","deprecated":null,"version":null,"sidebarTitle":"Resolve incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/resolve","href":"/en/api-reference/on-call/incidents/incident-resolve"},{"title":"Reopen incident","description":"Reopen closed incidents and dispatch them again from the first escalation level.","deprecated":null,"version":null,"sidebarTitle":"Reopen incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/reopen","href":"/en/api-reference/on-call/incidents/incident-reopen"},{"title":"Snooze incident","description":"Pause notifications for acknowledged incidents for a given number of minutes.","deprecated":null,"version":null,"sidebarTitle":"Snooze incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/snooze","href":"/en/api-reference/on-call/incidents/incident-snooze"},{"title":"Wake incident","description":"End the snooze on incidents so that their notifications resume immediately.","deprecated":null,"version":null,"sidebarTitle":"Wake incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/wake","href":"/en/api-reference/on-call/incidents/incident-wake"},{"title":"Merge incidents","description":"Merge one or more incidents into a target incident.","deprecated":null,"version":null,"sidebarTitle":"Merge incidents","openapi":"/api-reference/on-call.openapi.en.json post /incident/merge","href":"/en/api-reference/on-call/incidents/incident-merge"},{"title":"Disable incident merge","description":"Stop new alerts and events from being merged into the given incidents.","deprecated":null,"version":null,"sidebarTitle":"Disable incident merge","openapi":"/api-reference/on-call.openapi.en.json post /incident/disable-merge","href":"/en/api-reference/on-call/incidents/incident-disable-merge"},{"title":"Delete an incident","description":"Permanently delete incidents together with their alerts, raw events, and timelines.","deprecated":null,"version":null,"sidebarTitle":"Delete an incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/remove","href":"/en/api-reference/on-call/incidents/incident-remove"},{"title":"Assign incident","description":"Reassign incidents to members or an escalation rule, replacing the current responders.","deprecated":null,"version":null,"sidebarTitle":"Assign incident","openapi":"/api-reference/on-call.openapi.en.json post /incident/assign","href":"/en/api-reference/on-call/incidents/incident-assign"},{"title":"Add incident responder","description":"Add members as responders to an open incident and notify them.","deprecated":null,"version":null,"sidebarTitle":"Add incident responder","openapi":"/api-reference/on-call.openapi.en.json post /incident/responder/add","href":"/en/api-reference/on-call/incidents/incident-responder-add"}]},{"group":"War room","icon":"shield-halved","pages":[{"title":"Get war room detail","description":"Fetch the current name and join link of a war room group from the IM platform.","deprecated":null,"version":null,"sidebarTitle":"Get war room detail","openapi":"/api-reference/on-call.openapi.en.json post /incident/war-room/detail","href":"/en/api-reference/on-call/incidents/incident-war-room-detail"},{"title":"List war rooms","description":"List the IM war room groups linked to an incident.","deprecated":null,"version":null,"sidebarTitle":"List war rooms","openapi":"/api-reference/on-call.openapi.en.json post /incident/war-room/list","href":"/en/api-reference/on-call/incidents/incident-war-room-list"},{"title":"Create war room","description":"Create an IM group chat as the war room for an incident and invite members into it.","deprecated":null,"version":null,"sidebarTitle":"Create war room","openapi":"/api-reference/on-call.openapi.en.json post /incident/war-room/create","href":"/en/api-reference/on-call/incidents/incident-war-room-create"},{"title":"Delete war room","description":"Dissolve an incident's war room group on the IM platform and unlink it from the incident.","deprecated":null,"version":null,"sidebarTitle":"Delete war room","openapi":"/api-reference/on-call.openapi.en.json post /incident/war-room/delete","href":"/en/api-reference/on-call/incidents/incident-war-room-delete"}]},{"group":"Post-Mortem","icon":"file-lines","pages":[{"title":"Get post-mortem","description":"Get the full content and auto-aggregated basics of a post-mortem report by its ID.","deprecated":null,"version":null,"sidebarTitle":"Get post-mortem","openapi":"/api-reference/on-call.openapi.en.json get /incident/post-mortem/info","href":"/en/api-reference/on-call/incidents/incident-post-mortem-info"},{"title":"List post-mortems","description":"List post-mortem reports, optionally filtered by status, team, channel, and creation time.","deprecated":null,"version":null,"sidebarTitle":"List post-mortems","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/list","href":"/en/api-reference/on-call/incidents/incident-post-mortem-list"},{"title":"Delete post-mortem","description":"Permanently delete a post-mortem report together with its uploaded media.","deprecated":null,"version":null,"sidebarTitle":"Delete post-mortem","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/delete","href":"/en/api-reference/on-call/incidents/incident-post-mortem-delete"}]},{"group":"Comment types","icon":"tag","pages":[{"title":"List comment types","description":"Retrieve all comment types of the account, ordered by their display position.","deprecated":null,"version":null,"sidebarTitle":"List comment types","openapi":"/api-reference/on-call.openapi.en.json post /incident/comment-type/list","href":"/en/api-reference/on-call/incidents/incident-comment-type-list"},{"title":"Create a comment type","description":"Create a comment type that can be attached to incident comments.","deprecated":null,"version":null,"sidebarTitle":"Create a comment type","openapi":"/api-reference/on-call.openapi.en.json post /incident/comment-type/create","href":"/en/api-reference/on-call/incidents/incident-comment-type-create"},{"title":"Update a comment type","description":"Update the name and/or color of an existing account comment type.","deprecated":null,"version":null,"sidebarTitle":"Update a comment type","openapi":"/api-reference/on-call.openapi.en.json post /incident/comment-type/update","href":"/en/api-reference/on-call/incidents/incident-comment-type-update"},{"title":"Delete a comment type","description":"Permanently delete a comment type; comments that used it keep their text but lose the label.","deprecated":null,"version":null,"sidebarTitle":"Delete a comment type","openapi":"/api-reference/on-call.openapi.en.json post /incident/comment-type/delete","href":"/en/api-reference/on-call/incidents/incident-comment-type-delete"},{"title":"Reorder comment types","description":"Set the display order of all comment types by passing every type ID in the desired order.","deprecated":null,"version":null,"sidebarTitle":"Reorder comment types","openapi":"/api-reference/on-call.openapi.en.json post /incident/comment-type/reorder","href":"/en/api-reference/on-call/incidents/incident-comment-type-reorder"}]},{"group":"Work items","icon":"list-check","pages":[{"title":"List work items","description":"List incident work items (actions and post-mortem follow-ups) with cursor pagination.","deprecated":null,"version":null,"sidebarTitle":"List work items","openapi":"/api-reference/on-call.openapi.en.json post /incident/work-item/list","href":"/en/api-reference/on-call/incidents/incident-work-item-list"},{"title":"Create a work item","description":"Create an action on an open incident, or a follow-up on a closed incident.","deprecated":null,"version":null,"sidebarTitle":"Create a work item","openapi":"/api-reference/on-call.openapi.en.json post /incident/work-item/create","href":"/en/api-reference/on-call/incidents/incident-work-item-create"},{"title":"Update a work item","description":"Partially update a work item's title, description, status, or priority.","deprecated":null,"version":null,"sidebarTitle":"Update a work item","openapi":"/api-reference/on-call.openapi.en.json post /incident/work-item/update","href":"/en/api-reference/on-call/incidents/incident-work-item-update"},{"title":"Delete a work item","description":"Soft-delete a work item so it no longer appears in work item lists.","deprecated":null,"version":null,"sidebarTitle":"Delete a work item","openapi":"/api-reference/on-call.openapi.en.json post /incident/work-item/delete","href":"/en/api-reference/on-call/incidents/incident-work-item-delete"},{"title":"Complete a work item","description":"Mark a work item as done; only its current assignees can do this.","deprecated":null,"version":null,"sidebarTitle":"Complete a work item","openapi":"/api-reference/on-call.openapi.en.json post /incident/work-item/complete","href":"/en/api-reference/on-call/incidents/incident-work-item-complete"},{"title":"Convert a work item to a follow-up","description":"Convert an incident action item into a post-mortem follow-up in place.","deprecated":null,"version":null,"sidebarTitle":"Convert a work item to a follow-up","openapi":"/api-reference/on-call.openapi.en.json post /incident/work-item/convert","href":"/en/api-reference/on-call/incidents/incident-work-item-convert"},{"title":"Reset work item assignees","description":"Replace a work item's entire assignee set.","deprecated":null,"version":null,"sidebarTitle":"Reset work item assignees","openapi":"/api-reference/on-call.openapi.en.json post /incident/work-item/assignees/reset","href":"/en/api-reference/on-call/incidents/incident-work-item-reset-assignees"},{"title":"Bind work items to a post-mortem","description":"Bulk-bind an incident's converted-but-unbound follow-ups to a post-mortem.","deprecated":null,"version":null,"sidebarTitle":"Bind work items to a post-mortem","openapi":"/api-reference/on-call.openapi.en.json post /incident/work-item/post-mortem/bind","href":"/en/api-reference/on-call/incidents/incident-work-item-bind-post-mortem"}]},{"title":"Get war-room default observers","description":"Return people assigned to an incident earlier who are no longer responders, as suggested war-room observers.","deprecated":null,"version":null,"sidebarTitle":"Get war-room default observers","openapi":"/api-reference/on-call.openapi.en.json post /incident/war-room/default-observers","href":"/en/api-reference/on-call/incidents/incident-read-get-war-room-default-observers"},{"title":"Add war-room member","description":"Add members to an existing incident war room on Feishu (Lark), DingTalk, WeCom, or Slack.","deprecated":null,"version":null,"sidebarTitle":"Add war-room member","openapi":"/api-reference/on-call.openapi.en.json post /incident/war-room/add-member","href":"/en/api-reference/on-call/incidents/incident-write-add-war-room-member"},{"title":"Initialize post-mortem","description":"Create a post-mortem draft from one or more incidents and a template.","deprecated":null,"version":null,"sidebarTitle":"Initialize post-mortem","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/init","href":"/en/api-reference/on-call/incidents/postmortem-write-init"},{"title":"Update post-mortem basics","description":"Overwrite the incident facts (severity, times, responders) stored on a post-mortem report.","deprecated":null,"version":null,"sidebarTitle":"Update post-mortem basics","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/basics/reset","href":"/en/api-reference/on-call/incidents/postmortem-write-reset-basics"},{"title":"Update post-mortem status","description":"Set a post-mortem report to drafting or published.","deprecated":null,"version":null,"sidebarTitle":"Update post-mortem status","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/status/reset","href":"/en/api-reference/on-call/incidents/postmortem-write-reset-status"},{"title":"Update post-mortem title","description":"Replace the title of a post-mortem report.","deprecated":null,"version":null,"sidebarTitle":"Update post-mortem title","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/title/reset","href":"/en/api-reference/on-call/incidents/postmortem-write-reset-title"},{"title":"Update post-mortem follow-ups","description":"Replace the free-text follow-ups string stored on a post-mortem report.","deprecated":null,"version":null,"sidebarTitle":"Update post-mortem follow-ups","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/follow-ups/reset","href":"/en/api-reference/on-call/incidents/postmortem-write-reset-follow-ups"},{"title":"Reset post-mortem content","description":"Replace the body of a drafting post-mortem report with Markdown.","deprecated":null,"version":null,"sidebarTitle":"Reset post-mortem content","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/content/reset","href":"/en/api-reference/on-call/incidents/incident-post-mortem-write-reset-content"},{"title":"Create or update post-mortem template","description":"Create a custom post-mortem template, or replace an existing one identified by `template_id`.","deprecated":null,"version":null,"sidebarTitle":"Create or update post-mortem template","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/template/upsert","href":"/en/api-reference/on-call/incidents/postmortem-write-upsert-template"},{"title":"Delete post-mortem template","description":"Delete a custom post-mortem template.","deprecated":null,"version":null,"sidebarTitle":"Delete post-mortem template","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/template/delete","href":"/en/api-reference/on-call/incidents/postmortem-write-delete-template"},{"title":"List post-mortem templates","description":"Return the built-in post-mortem template followed by the account's custom templates.","deprecated":null,"version":null,"sidebarTitle":"List post-mortem templates","openapi":"/api-reference/on-call.openapi.en.json post /incident/post-mortem/template/list","href":"/en/api-reference/on-call/incidents/postmortem-read-list-templates"},{"title":"Get post-mortem template detail","description":"Return one post-mortem template by ID.","deprecated":null,"version":null,"sidebarTitle":"Get post-mortem template detail","openapi":"/api-reference/on-call.openapi.en.json get /incident/post-mortem/template/info","href":"/en/api-reference/on-call/incidents/postmortem-read-template-info"}]},{"group":"Channels","icon":"comments","pages":[{"title":"Get channel detail","description":"Return one channel's full configuration with counts of its active incidents from the last 30 days.","deprecated":null,"version":null,"sidebarTitle":"Get channel detail","openapi":"/api-reference/on-call.openapi.en.json post /channel/info","href":"/en/api-reference/on-call/channels/channel-info"},{"title":"List channels","description":"List the channels visible to the caller, with filters, sorting and pagination.","deprecated":null,"version":null,"sidebarTitle":"List channels","openapi":"/api-reference/on-call.openapi.en.json post /channel/list","href":"/en/api-reference/on-call/channels/channel-list"},{"title":"Batch get channels","description":"Return the ID, name and status of up to 1,000 channels in one call.","deprecated":null,"version":null,"sidebarTitle":"Batch get channels","openapi":"/api-reference/on-call.openapi.en.json post /channel/infos","href":"/en/api-reference/on-call/channels/channel-infos"},{"title":"Create channel","description":"Create a channel, optionally with a default escalation rule and channel-exclusive integrations.","deprecated":null,"version":null,"sidebarTitle":"Create channel","openapi":"/api-reference/on-call.openapi.en.json post /channel/create","href":"/en/api-reference/on-call/channels/channel-create"},{"title":"Update channel","description":"Update a channel's settings; only the fields present in the request are changed.","deprecated":null,"version":null,"sidebarTitle":"Update channel","openapi":"/api-reference/on-call.openapi.en.json post /channel/update","href":"/en/api-reference/on-call/channels/channel-update"},{"title":"Delete channel","description":"Delete a disabled channel together with its rules and channel-exclusive integrations.","deprecated":null,"version":null,"sidebarTitle":"Delete channel","openapi":"/api-reference/on-call.openapi.en.json post /channel/delete","href":"/en/api-reference/on-call/channels/channel-delete"},{"title":"Enable channel","description":"Enable a disabled channel so it processes incoming alert events again.","deprecated":null,"version":null,"sidebarTitle":"Enable channel","openapi":"/api-reference/on-call.openapi.en.json post /channel/enable","href":"/en/api-reference/on-call/channels/channel-enable"},{"title":"Disable channel","description":"Disable a channel; while disabled it discards all incoming alert events.","deprecated":null,"version":null,"sidebarTitle":"Disable channel","openapi":"/api-reference/on-call.openapi.en.json post /channel/disable","href":"/en/api-reference/on-call/channels/channel-disable"},{"group":"Escalation rules","icon":"arrow-up-right-dots","pages":[{"title":"Get escalation rule detail","description":"Return one escalation rule of a channel, including its levels, time windows and filters.","deprecated":null,"version":null,"sidebarTitle":"Get escalation rule detail","openapi":"/api-reference/on-call.openapi.en.json post /channel/escalate/rule/info","href":"/en/api-reference/on-call/channels/channel-escalate-rule-info"},{"title":"List escalation rules","description":"List a channel's escalation rules in the order they are evaluated.","deprecated":null,"version":null,"sidebarTitle":"List escalation rules","openapi":"/api-reference/on-call.openapi.en.json post /channel/escalate/rule/list","href":"/en/api-reference/on-call/channels/channel-escalate-rule-list"},{"title":"Create escalation rule","description":"Create an escalation rule that decides who is notified about a channel's incidents, and how.","deprecated":null,"version":null,"sidebarTitle":"Create escalation rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/escalate/rule/create","href":"/en/api-reference/on-call/channels/channel-escalate-rule-create"},{"title":"Update escalation rule","description":"Replace the configuration of an existing escalation rule.","deprecated":null,"version":null,"sidebarTitle":"Update escalation rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/escalate/rule/update","href":"/en/api-reference/on-call/channels/channel-escalate-rule-update"},{"title":"Delete escalation rule","description":"Delete a disabled escalation rule so it no longer appears in the channel's rule list.","deprecated":null,"version":null,"sidebarTitle":"Delete escalation rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/escalate/rule/delete","href":"/en/api-reference/on-call/channels/channel-escalate-rule-delete"},{"title":"Enable escalation rule","description":"Enable a disabled escalation rule so it can take new incidents again.","deprecated":null,"version":null,"sidebarTitle":"Enable escalation rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/escalate/rule/enable","href":"/en/api-reference/on-call/channels/channel-escalate-rule-enable"},{"title":"Disable escalation rule","description":"Disable an escalation rule without deleting it.","deprecated":null,"version":null,"sidebarTitle":"Disable escalation rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/escalate/rule/disable","href":"/en/api-reference/on-call/channels/channel-escalate-rule-disable"},{"title":"Reorder escalation rules","description":"Change the evaluation order of a channel's escalation rules by moving one rule into another rule's slot.","deprecated":null,"version":null,"sidebarTitle":"Reorder escalation rules","openapi":"/api-reference/on-call.openapi.en.json post /channel/escalate/rule/reorder","href":"/en/api-reference/on-call/channels/channel-escalate-rule-reorder"}]},{"group":"Silence rules","icon":"bell-slash","pages":[{"title":"List silence rules","description":"List a channel's silence rules and whether each one is in effect right now.","deprecated":null,"version":null,"sidebarTitle":"List silence rules","openapi":"/api-reference/on-call.openapi.en.json post /channel/silence/rule/list","href":"/en/api-reference/on-call/channels/channel-silence-rule-list"},{"title":"Create silence rule","description":"Create a silence rule that mutes or drops matching alert events during a time window.","deprecated":null,"version":null,"sidebarTitle":"Create silence rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/silence/rule/create","href":"/en/api-reference/on-call/channels/channel-silence-rule-create"},{"title":"Update silence rule","description":"Replace the configuration of an existing silence rule.","deprecated":null,"version":null,"sidebarTitle":"Update silence rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/silence/rule/update","href":"/en/api-reference/on-call/channels/channel-silence-rule-update"},{"title":"Delete silence rule","description":"Delete a disabled silence rule so it no longer appears in the channel's rule list.","deprecated":null,"version":null,"sidebarTitle":"Delete silence rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/silence/rule/delete","href":"/en/api-reference/on-call/channels/channel-silence-rule-delete"},{"title":"Enable silence rule","description":"Enable a disabled silence rule so it silences matching alert events again.","deprecated":null,"version":null,"sidebarTitle":"Enable silence rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/silence/rule/enable","href":"/en/api-reference/on-call/channels/channel-silence-rule-enable"},{"title":"Disable silence rule","description":"Disable a silence rule without deleting it.","deprecated":null,"version":null,"sidebarTitle":"Disable silence rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/silence/rule/disable","href":"/en/api-reference/on-call/channels/channel-silence-rule-disable"}]},{"group":"Inhibit rules","icon":"volume-xmark","pages":[{"title":"List inhibit rules","description":"List a channel's inhibit rules, oldest first.","deprecated":null,"version":null,"sidebarTitle":"List inhibit rules","openapi":"/api-reference/on-call.openapi.en.json post /channel/inhibit/rule/list","href":"/en/api-reference/on-call/channels/channel-inhibit-rule-list"},{"title":"Create inhibit rule","description":"Create an inhibit rule that mutes alert events while a related source alert is still active.","deprecated":null,"version":null,"sidebarTitle":"Create inhibit rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/inhibit/rule/create","href":"/en/api-reference/on-call/channels/channel-inhibit-rule-create"},{"title":"Update inhibit rule","description":"Replace the configuration of an existing inhibit rule.","deprecated":null,"version":null,"sidebarTitle":"Update inhibit rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/inhibit/rule/update","href":"/en/api-reference/on-call/channels/channel-inhibit-rule-update"},{"title":"Delete inhibit rule","description":"Delete a disabled inhibit rule so it no longer appears in the channel's rule list.","deprecated":null,"version":null,"sidebarTitle":"Delete inhibit rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/inhibit/rule/delete","href":"/en/api-reference/on-call/channels/channel-inhibit-rule-delete"},{"title":"Enable inhibit rule","description":"Enable a disabled inhibit rule so it mutes matching alert events again.","deprecated":null,"version":null,"sidebarTitle":"Enable inhibit rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/inhibit/rule/enable","href":"/en/api-reference/on-call/channels/channel-inhibit-rule-enable"},{"title":"Disable inhibit rule","description":"Disable an inhibit rule without deleting it.","deprecated":null,"version":null,"sidebarTitle":"Disable inhibit rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/inhibit/rule/disable","href":"/en/api-reference/on-call/channels/channel-inhibit-rule-disable"}]},{"group":"Drop rules","icon":"filter-circle-xmark","pages":[{"title":"List drop rules","description":"List a channel's drop rules, oldest first.","deprecated":null,"version":null,"sidebarTitle":"List drop rules","openapi":"/api-reference/on-call.openapi.en.json post /channel/unsubscribe/rule/list","href":"/en/api-reference/on-call/channels/channel-unsubscribe-rule-list"},{"title":"Create drop rule","description":"Create a drop rule that discards matching alert events before any alert or incident is created.","deprecated":null,"version":null,"sidebarTitle":"Create drop rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/unsubscribe/rule/create","href":"/en/api-reference/on-call/channels/channel-unsubscribe-rule-create"},{"title":"Update drop rule","description":"Replace the name, description and conditions of an existing drop rule.","deprecated":null,"version":null,"sidebarTitle":"Update drop rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/unsubscribe/rule/update","href":"/en/api-reference/on-call/channels/channel-unsubscribe-rule-update"},{"title":"Delete drop rule","description":"Delete a disabled drop rule so it no longer appears in the channel's rule list.","deprecated":null,"version":null,"sidebarTitle":"Delete drop rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/unsubscribe/rule/delete","href":"/en/api-reference/on-call/channels/channel-unsubscribe-rule-delete"},{"title":"Enable drop rule","description":"Enable a disabled drop rule so it discards matching alert events again.","deprecated":null,"version":null,"sidebarTitle":"Enable drop rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/unsubscribe/rule/enable","href":"/en/api-reference/on-call/channels/channel-unsubscribe-rule-enable"},{"title":"Disable drop rule","description":"Disable a drop rule without deleting it.","deprecated":null,"version":null,"sidebarTitle":"Disable drop rule","openapi":"/api-reference/on-call.openapi.en.json post /channel/unsubscribe/rule/disable","href":"/en/api-reference/on-call/channels/channel-unsubscribe-rule-disable"}]}]},{"group":"Alerts","icon":"bell","pages":[{"title":"List alerts","description":"Return a cursor-paginated list of alerts matching the given filters.","deprecated":null,"version":null,"sidebarTitle":"List alerts","openapi":"/api-reference/on-call.openapi.en.json post /alert/list","href":"/en/api-reference/on-call/alerts/alert-read-list"},{"title":"Get alert detail","description":"Return the full details of a single alert by its ID, including its associated incident and event count.","deprecated":null,"version":null,"sidebarTitle":"Get alert detail","openapi":"/api-reference/on-call.openapi.en.json post /alert/info","href":"/en/api-reference/on-call/alerts/alert-read-info"},{"title":"List alerts by IDs","description":"Return the details of several alerts by ID in one request, without pagination.","deprecated":null,"version":null,"sidebarTitle":"List alerts by IDs","openapi":"/api-reference/on-call.openapi.en.json post /alert/list-by-ids","href":"/en/api-reference/on-call/alerts/alert-read-list-by-ids"},{"title":"List events for an alert","description":"Return raw events for an alert with cursor or page-number pagination.","deprecated":null,"version":null,"sidebarTitle":"List events for an alert","openapi":"/api-reference/on-call.openapi.en.json post /alert/event/list","href":"/en/api-reference/on-call/alerts/alert-read-event-list"},{"title":"List alert activity feed","description":"Return the activity feed (comments, state changes, merges, silence events) for a single alert, with page-based pagination.","deprecated":null,"version":null,"sidebarTitle":"List alert activity feed","openapi":"/api-reference/on-call.openapi.en.json post /alert/feed","href":"/en/api-reference/on-call/alerts/alert-read-feed"},{"title":"Merge alerts into an incident","description":"Move one or more alerts into an existing incident and close source incidents left empty.","deprecated":null,"version":null,"sidebarTitle":"Merge alerts into an incident","openapi":"/api-reference/on-call.openapi.en.json post /alert/merge","href":"/en/api-reference/on-call/alerts/alert-write-merge"},{"title":"Get alert pipeline","description":"Return the alert processing pipeline configured for a specific integration.","deprecated":null,"version":null,"sidebarTitle":"Get alert pipeline","openapi":"/api-reference/on-call.openapi.en.json post /alert/pipeline/info","href":"/en/api-reference/on-call/alerts/alert-read-pipeline-info"},{"title":"List alert pipelines","description":"Return the alert processing pipelines configured for multiple integrations.","deprecated":null,"version":null,"sidebarTitle":"List alert pipelines","openapi":"/api-reference/on-call.openapi.en.json post /alert/pipeline/list","href":"/en/api-reference/on-call/alerts/alert-read-pipeline-list"},{"title":"Create or update alert pipeline","description":"Set the alert processing pipeline for an integration. Replaces the existing configuration entirely.","deprecated":null,"version":null,"sidebarTitle":"Create or update alert pipeline","openapi":"/api-reference/on-call.openapi.en.json post /alert/pipeline/upsert","href":"/en/api-reference/on-call/alerts/alert-write-pipeline-upsert"},{"title":"Preview alert pipeline processing","description":"Run unsaved alert processing rules over one event, the way ingestion would.","deprecated":null,"version":null,"sidebarTitle":"Preview alert pipeline processing","openapi":"/api-reference/on-call.openapi.en.json post /alert/pipeline/preview","href":"/en/api-reference/on-call/alerts/alert-read-pipeline-preview"},{"title":"List raw alert events","description":"Return a cursor-paginated list of raw alert events across all alerts, with filtering by integration, channel, time range, and severity.","deprecated":null,"version":null,"sidebarTitle":"List raw alert events","openapi":"/api-reference/on-call.openapi.en.json post /alert-event/list","href":"/en/api-reference/on-call/alerts/alert-event-read-list"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"List webhook delivery history","description":"List the delivery history for outbound webhook notifications.","deprecated":null,"version":null,"sidebarTitle":"List webhook delivery history","openapi":"/api-reference/on-call.openapi.en.json post /webhook/history/list","href":"/en/api-reference/on-call/integrations/webhook-history-list"},{"title":"Get webhook delivery detail","description":"Retrieve the detailed payload and response for a specific webhook delivery attempt.","deprecated":null,"version":null,"sidebarTitle":"Get webhook delivery detail","openapi":"/api-reference/on-call.openapi.en.json post /webhook/history/detail","href":"/en/api-reference/on-call/integrations/webhook-history-detail"},{"title":"Attempt IM person linking","description":"Try to automatically link unbound members to their IM accounts for one integration.","deprecated":null,"version":null,"sidebarTitle":"Attempt IM person linking","openapi":"/api-reference/on-call.openapi.en.json post /datasource/im/person/try-link","href":"/en/api-reference/on-call/integrations/datasource-im-person-try-link"},{"title":"List integration types","description":"List the integration types the account can configure.","deprecated":null,"version":null,"sidebarTitle":"List integration types","openapi":"/api-reference/on-call.openapi.en.json post /integration/type/list","href":"/en/api-reference/on-call/integrations/integration-api-read-type-list"},{"title":"List integrations","description":"List public integrations with their stored settings, decrypted keys, and edit permissions.","deprecated":null,"version":null,"sidebarTitle":"List integrations","openapi":"/api-reference/on-call.openapi.en.json post /integration/list","href":"/en/api-reference/on-call/integrations/integration-api-read-list"},{"title":"Get integration detail","description":"Get a public integration with its stored settings and decrypted integration key.","deprecated":null,"version":null,"sidebarTitle":"Get integration detail","openapi":"/api-reference/on-call.openapi.en.json post /integration/info","href":"/en/api-reference/on-call/integrations/integration-api-read-info"},{"title":"Create integration","description":"Create a public integration for a supported alert, change, IM, or webhook type.","deprecated":null,"version":null,"sidebarTitle":"Create integration","openapi":"/api-reference/on-call.openapi.en.json post /integration/create","href":"/en/api-reference/on-call/integrations/integration-api-write-create"},{"title":"Update integration","description":"Update an integration's name, description, team, or settings.","deprecated":null,"version":null,"sidebarTitle":"Update integration","openapi":"/api-reference/on-call.openapi.en.json post /integration/update","href":"/en/api-reference/on-call/integrations/integration-api-write-update"},{"title":"Delete integration","description":"Delete an integration that nothing else references.","deprecated":null,"version":null,"sidebarTitle":"Delete integration","openapi":"/api-reference/on-call.openapi.en.json post /integration/delete","href":"/en/api-reference/on-call/integrations/integration-api-write-delete"},{"title":"Enable integration","description":"Re-enable a disabled integration so it accepts events again.","deprecated":null,"version":null,"sidebarTitle":"Enable integration","openapi":"/api-reference/on-call.openapi.en.json post /integration/enable","href":"/en/api-reference/on-call/integrations/integration-api-write-enable"},{"title":"Disable integration","description":"Disable an integration without deleting its configuration.","deprecated":null,"version":null,"sidebarTitle":"Disable integration","openapi":"/api-reference/on-call.openapi.en.json post /integration/disable","href":"/en/api-reference/on-call/integrations/integration-api-write-disable"},{"title":"Rotate integration key","description":"Issue a new integration key and invalidate the previous one.","deprecated":null,"version":null,"sidebarTitle":"Rotate integration key","openapi":"/api-reference/on-call.openapi.en.json post /integration/key/rotate","href":"/en/api-reference/on-call/integrations/integration-api-write-rotate-key"},{"title":"Preview email-to-alert conversion","description":"Run unsaved email integration settings over one email, the way ingestion would.","deprecated":null,"version":null,"sidebarTitle":"Preview email-to-alert conversion","openapi":"/api-reference/on-call.openapi.en.json post /alert/email/preview","href":"/en/api-reference/on-call/integrations/alert-read-email-preview"}]},{"group":"IM integrations","icon":"comments","pages":[{"title":"List war-room-enabled IM integrations","description":"List IM integrations that have the war-room feature enabled for the account.","deprecated":null,"version":null,"sidebarTitle":"List war-room-enabled IM integrations","openapi":"/api-reference/on-call.openapi.en.json post /datasource/im/war-room-enabled/list","href":"/en/api-reference/on-call/integrations/im-war-room-enabled-list"}]},{"group":"Routing rules","icon":"shuffle","pages":[{"title":"Get routing rule detail","description":"Return the routing rule of one shared integration.","deprecated":null,"version":null,"sidebarTitle":"Get routing rule detail","openapi":"/api-reference/on-call.openapi.en.json post /route/info","href":"/en/api-reference/on-call/channels/route-info"},{"title":"List routing rules","description":"Return the routing rules of several shared integrations in one call.","deprecated":null,"version":null,"sidebarTitle":"List routing rules","openapi":"/api-reference/on-call.openapi.en.json post /route/list","href":"/en/api-reference/on-call/channels/route-list"},{"title":"Upsert routing rule","description":"Create or replace the routing rule that sends a shared integration's alerts to channels.","deprecated":null,"version":null,"sidebarTitle":"Upsert routing rule","openapi":"/api-reference/on-call.openapi.en.json post /route/upsert","href":"/en/api-reference/on-call/channels/route-upsert"}]},{"group":"Schedules","icon":"calendar-days","pages":[{"title":"Create schedule","description":"Create an on-call schedule with its rotation layers and shift notification settings.","deprecated":null,"version":null,"sidebarTitle":"Create schedule","openapi":"/api-reference/on-call.openapi.en.json post /schedule/create","href":"/en/api-reference/on-call/schedules/schedule-create"},{"title":"Update schedule","description":"Update an on-call schedule identified by `schedule_id`; the layer list is replaced as a whole.","deprecated":null,"version":null,"sidebarTitle":"Update schedule","openapi":"/api-reference/on-call.openapi.en.json post /schedule/update","href":"/en/api-reference/on-call/schedules/schedule-update"},{"title":"Preview schedule","description":"Preview the coverage generated by a schedule configuration without persisting it. The request accepts the same body as create/update plus a required start/end window (max 45 days).","deprecated":null,"version":null,"sidebarTitle":"Preview schedule","openapi":"/api-reference/on-call.openapi.en.json post /schedule/preview","href":"/en/api-reference/on-call/schedules/schedule-preview"},{"title":"Delete schedules","description":"Delete one or more on-call schedules by ID, together with their layers.","deprecated":null,"version":null,"sidebarTitle":"Delete schedules","openapi":"/api-reference/on-call.openapi.en.json post /schedule/delete","href":"/en/api-reference/on-call/schedules/schedule-delete"},{"title":"Get schedule info","description":"Return one on-call schedule with its layers and the shifts computed for a time window of up to 45 days.","deprecated":null,"version":null,"sidebarTitle":"Get schedule info","openapi":"/api-reference/on-call.openapi.en.json post /schedule/info","href":"/en/api-reference/on-call/schedules/schedule-info"},{"title":"List schedules","description":"List on-call schedules with filters and pagination; pass `start` and `end` to also compute shifts.","deprecated":null,"version":null,"sidebarTitle":"List schedules","openapi":"/api-reference/on-call.openapi.en.json post /schedule/list","href":"/en/api-reference/on-call/schedules/schedule-list"},{"title":"List my schedules","description":"List the enabled on-call schedules the calling member belongs to, with the member's own shifts in the window.","deprecated":null,"version":null,"sidebarTitle":"List my schedules","openapi":"/api-reference/on-call.openapi.en.json post /schedule/self","href":"/en/api-reference/on-call/schedules/schedule-self"},{"title":"Get member on-call status","description":"Get a member's current and next on-call shifts and every enabled schedule they participate in.","deprecated":null,"version":null,"sidebarTitle":"Get member on-call status","openapi":"/api-reference/on-call.openapi.en.json post /schedule/by-person","href":"/en/api-reference/on-call/schedules/schedule-by-person"},{"title":"Batch get schedules","description":"Return the basic configuration of several on-call schedules by ID, without layers or computed shifts.","deprecated":null,"version":null,"sidebarTitle":"Batch get schedules","openapi":"/api-reference/on-call.openapi.en.json post /schedule/infos","href":"/en/api-reference/on-call/schedules/schedule-infos"}]},{"group":"Licenses","icon":"id-card","pages":[{"title":"List On-call licenses","description":"List people with active fixed or temporary On-call licenses in the current account.","deprecated":null,"version":null,"sidebarTitle":"List On-call licenses","openapi":"/api-reference/on-call.openapi.en.json post /oncall/license/list","href":"/en/api-reference/on-call/licenses/oncall-license-read-license-list"}]},{"group":"Calendars","icon":"calendar","pages":[{"title":"Create calendar","description":"Create a personal service calendar with its weekly workdays and linked holiday calendars.","deprecated":null,"version":null,"sidebarTitle":"Create calendar","openapi":"/api-reference/on-call.openapi.en.json post /calendar/create","href":"/en/api-reference/on-call/calendars/calendar-create"},{"title":"Update calendar","description":"Update a personal service calendar; only the fields you send are changed.","deprecated":null,"version":null,"sidebarTitle":"Update calendar","openapi":"/api-reference/on-call.openapi.en.json post /calendar/update","href":"/en/api-reference/on-call/calendars/calendar-update"},{"title":"Delete calendar","description":"Delete a personal service calendar and its events when no rule references it.","deprecated":null,"version":null,"sidebarTitle":"Delete calendar","openapi":"/api-reference/on-call.openapi.en.json post /calendar/delete","href":"/en/api-reference/on-call/calendars/calendar-delete"},{"title":"Get calendar info","description":"Return the details of one service calendar of the account by its ID.","deprecated":null,"version":null,"sidebarTitle":"Get calendar info","openapi":"/api-reference/on-call.openapi.en.json post /calendar/info","href":"/en/api-reference/on-call/calendars/calendar-info"},{"title":"List calendars","description":"Return the list of service calendars visible to the current account.","deprecated":null,"version":null,"sidebarTitle":"List calendars","openapi":"/api-reference/on-call.openapi.en.json post /calendar/list","href":"/en/api-reference/on-call/calendars/calendar-list"},{"group":"Calendar events","icon":"calendar-plus","pages":[{"title":"Upsert calendar event","description":"Create or update one of a personal calendar's own events: a day off or a working-day override.","deprecated":null,"version":null,"sidebarTitle":"Upsert calendar event","openapi":"/api-reference/on-call.openapi.en.json post /calendar/event/upsert","href":"/en/api-reference/on-call/calendars/cal-event-upsert"},{"title":"Delete calendar event","description":"Delete one personal-calendar event by ID, or clear the calendar's own events from a date range.","deprecated":null,"version":null,"sidebarTitle":"Delete calendar event","openapi":"/api-reference/on-call.openapi.en.json post /calendar/event/delete","href":"/en/api-reference/on-call/calendars/cal-event-delete"},{"title":"List calendar events","description":"Return a personal calendar's events for a year, month or day, plus the resolved state of each day.","deprecated":null,"version":null,"sidebarTitle":"List calendar events","openapi":"/api-reference/on-call.openapi.en.json post /calendar/event/list","href":"/en/api-reference/on-call/calendars/cal-event-list"}]}]},{"group":"Notification templates","icon":"envelope-open-text","pages":[{"title":"Get template detail","description":"Return a single notification template by ID.","deprecated":null,"version":null,"sidebarTitle":"Get template detail","openapi":"/api-reference/on-call.openapi.en.json post /template/info","href":"/en/api-reference/on-call/notification-templates/template-read-info"},{"title":"List templates","description":"Return a paginated list of notification templates.","deprecated":null,"version":null,"sidebarTitle":"List templates","openapi":"/api-reference/on-call.openapi.en.json post /template/list","href":"/en/api-reference/on-call/notification-templates/template-read-list"},{"title":"Create a template","description":"Create a notification template with per-channel message sources.","deprecated":null,"version":null,"sidebarTitle":"Create a template","openapi":"/api-reference/on-call.openapi.en.json post /template/create","href":"/en/api-reference/on-call/notification-templates/template-write-create"},{"title":"Update a template","description":"Update a notification template; only the fields present in the request are written.","deprecated":null,"version":null,"sidebarTitle":"Update a template","openapi":"/api-reference/on-call.openapi.en.json post /template/update","href":"/en/api-reference/on-call/notification-templates/template-write-update"},{"title":"Delete a template","description":"Soft-delete a notification template by ID.","deprecated":null,"version":null,"sidebarTitle":"Delete a template","openapi":"/api-reference/on-call.openapi.en.json post /template/delete","href":"/en/api-reference/on-call/notification-templates/template-write-delete"},{"title":"Preview template","description":"Render a template source against an incident or mock data and return what the channel would send.","deprecated":null,"version":null,"sidebarTitle":"Preview template","openapi":"/api-reference/on-call.openapi.en.json post /template/preview","href":"/en/api-reference/on-call/notification-templates/template-read-preview"}]},{"group":"Alert enrichment","icon":"tags","pages":[{"title":"Get enrichment rules","description":"Return the enrichment rule set configured for a specific integration.","deprecated":null,"version":null,"sidebarTitle":"Get enrichment rules","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/info","href":"/en/api-reference/on-call/alert-enrichment/enrichment-read-info"},{"title":"List enrichment rules","description":"Return the enrichment rule sets for a list of integration IDs.","deprecated":null,"version":null,"sidebarTitle":"List enrichment rules","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/list","href":"/en/api-reference/on-call/alert-enrichment/enrichment-read-list"},{"title":"Upsert enrichment rules","description":"Create or replace the whole enrichment rule set of an integration.","deprecated":null,"version":null,"sidebarTitle":"Upsert enrichment rules","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/upsert","href":"/en/api-reference/on-call/alert-enrichment/enrichment-write-upsert"},{"title":"Preview enrichment rule results","description":"Run unsaved enrichment rules over one event, the way ingestion would.","deprecated":null,"version":null,"sidebarTitle":"Preview enrichment rule results","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/preview","href":"/en/api-reference/on-call/alert-enrichment/enrichment-read-preview"},{"title":"List recent event samples","description":"List the raw events an integration received most recently, newest first.","deprecated":null,"version":null,"sidebarTitle":"List recent event samples","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/sample/list","href":"/en/api-reference/on-call/alert-enrichment/enrichment-sample-read-list"},{"group":"Mapping schemas","icon":"table-columns","pages":[{"title":"List mapping schemas","description":"Return all mapping schemas of the account, newest first.","deprecated":null,"version":null,"sidebarTitle":"List mapping schemas","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/schema/list","href":"/en/api-reference/on-call/alert-enrichment/mapping-schema-read-list"},{"title":"Get mapping schema detail","description":"Return detail of a single mapping schema by its ID.","deprecated":null,"version":null,"sidebarTitle":"Get mapping schema detail","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/schema/info","href":"/en/api-reference/on-call/alert-enrichment/mapping-schema-read-info"},{"title":"Create mapping schema","description":"Create a mapping schema that defines the lookup labels and the result labels to fill.","deprecated":null,"version":null,"sidebarTitle":"Create mapping schema","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/schema/create","href":"/en/api-reference/on-call/alert-enrichment/mapping-schema-write-create"},{"title":"Update mapping schema","description":"Update the name, description, or owning team of a mapping schema. Source and result labels cannot be changed after creation.","deprecated":null,"version":null,"sidebarTitle":"Update mapping schema","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/schema/update","href":"/en/api-reference/on-call/alert-enrichment/mapping-schema-write-update"},{"title":"Delete mapping schema","description":"Delete a mapping schema and all of its data rows; refused while an enrichment rule or robot webhook uses it.","deprecated":null,"version":null,"sidebarTitle":"Delete mapping schema","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/schema/delete","href":"/en/api-reference/on-call/alert-enrichment/mapping-schema-write-delete"}]},{"group":"Mapping data","icon":"table","pages":[{"title":"List mapping data","description":"Return paginated mapping data rows for a schema, with optional exact-match filtering on source label values.","deprecated":null,"version":null,"sidebarTitle":"List mapping data","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/data/list","href":"/en/api-reference/on-call/alert-enrichment/mapping-data-read-list"},{"title":"Upsert mapping data rows","description":"Insert or update up to 1000 data rows in a mapping schema. Each row must contain all source and result labels.","deprecated":null,"version":null,"sidebarTitle":"Upsert mapping data rows","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/data/upsert","href":"/en/api-reference/on-call/alert-enrichment/mapping-data-write-upsert"},{"title":"Delete mapping data rows","description":"Delete up to 100 mapping data rows by their keys.","deprecated":null,"version":null,"sidebarTitle":"Delete mapping data rows","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/data/delete","href":"/en/api-reference/on-call/alert-enrichment/mapping-data-write-delete"},{"title":"Truncate mapping data","description":"Delete all data rows in a mapping schema.","deprecated":null,"version":null,"sidebarTitle":"Truncate mapping data","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/data/truncate","href":"/en/api-reference/on-call/alert-enrichment/mapping-data-write-truncate"},{"title":"Upload mapping data via CSV","description":"Upload a CSV file to bulk-load mapping data. By default the existing data is truncated before loading the new rows.","deprecated":null,"version":null,"sidebarTitle":"Upload mapping data via CSV","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/data/upload","href":"/en/api-reference/on-call/alert-enrichment/mapping-data-write-upload"},{"title":"Download mapping data as CSV","description":"Export all data rows of a mapping schema as a CSV file download.","deprecated":null,"version":null,"sidebarTitle":"Download mapping data as CSV","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/data/download","href":"/en/api-reference/on-call/alert-enrichment/mapping-data-read-download"}]},{"group":"Mapping API sources","icon":"cloud-arrow-down","pages":[{"title":"List mapping APIs","description":"Return all mapping APIs of the account, newest first.","deprecated":null,"version":null,"sidebarTitle":"List mapping APIs","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/api/list","href":"/en/api-reference/on-call/alert-enrichment/mapping-api-read-list"},{"title":"Get mapping API detail","description":"Return detail of a single mapping API by its ID.","deprecated":null,"version":null,"sidebarTitle":"Get mapping API detail","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/api/info","href":"/en/api-reference/on-call/alert-enrichment/mapping-api-read-info"},{"title":"Create mapping API","description":"Register an external HTTP API that enrichment rules call to look up alert labels.","deprecated":null,"version":null,"sidebarTitle":"Create mapping API","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/api/create","href":"/en/api-reference/on-call/alert-enrichment/mapping-api-write-create"},{"title":"Update mapping API","description":"Update configuration of an existing mapping API.","deprecated":null,"version":null,"sidebarTitle":"Update mapping API","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/api/update","href":"/en/api-reference/on-call/alert-enrichment/mapping-api-write-update"},{"title":"Delete mapping API","description":"Soft-delete a mapping API; refused while an enrichment rule uses it.","deprecated":null,"version":null,"sidebarTitle":"Delete mapping API","openapi":"/api-reference/on-call.openapi.en.json post /enrichment/mapping/api/delete","href":"/en/api-reference/on-call/alert-enrichment/mapping-api-write-delete"}]},{"title":"Get field detail","description":"Return the configuration of a single incident custom field by ID.","deprecated":null,"version":null,"sidebarTitle":"Get field detail","openapi":"/api-reference/on-call.openapi.en.json post /field/info","href":"/en/api-reference/on-call/alert-enrichment/field-read-info"},{"title":"List fields","description":"Return all incident custom fields configured for the account.","deprecated":null,"version":null,"sidebarTitle":"List fields","openapi":"/api-reference/on-call.openapi.en.json post /field/list","href":"/en/api-reference/on-call/alert-enrichment/field-read-list"},{"title":"Create field","description":"Create a new incident custom field on the account.","deprecated":null,"version":null,"sidebarTitle":"Create field","openapi":"/api-reference/on-call.openapi.en.json post /field/create","href":"/en/api-reference/on-call/alert-enrichment/field-write-create"},{"title":"Update field","description":"Update mutable attributes of an existing incident custom field.","deprecated":null,"version":null,"sidebarTitle":"Update field","openapi":"/api-reference/on-call.openapi.en.json post /field/update","href":"/en/api-reference/on-call/alert-enrichment/field-write-update"},{"title":"Delete field","description":"Delete an incident custom field and asynchronously strip it from existing incidents.","deprecated":null,"version":null,"sidebarTitle":"Delete field","openapi":"/api-reference/on-call.openapi.en.json post /field/delete","href":"/en/api-reference/on-call/alert-enrichment/field-write-delete"}]},{"group":"Analytics","icon":"chart-line","pages":[{"title":"Get top-K alerts grouped by check or resource","description":"Return the top-K alert groups aggregated either by `check` or by `resource` label over the specified time range.","deprecated":null,"version":null,"sidebarTitle":"Get top-K alerts grouped by check or resource","openapi":"/api-reference/on-call.openapi.en.json post /insight/alert/topk-by-label","href":"/en/api-reference/on-call/analytics/insight-topk-alerts-by-label"},{"title":"Get account-level insight","description":"Return incident and alert metrics for the whole account, one row per time bucket.","deprecated":null,"version":null,"sidebarTitle":"Get account-level insight","openapi":"/api-reference/on-call.openapi.en.json post /insight/account","href":"/en/api-reference/on-call/analytics/insight-by-account"},{"title":"List insight incidents","description":"Return a paged list of incidents with per-incident handling metrics used by the analytics dashboard.","deprecated":null,"version":null,"sidebarTitle":"List insight incidents","openapi":"/api-reference/on-call.openapi.en.json post /insight/incident/list","href":"/en/api-reference/on-call/analytics/insight-incident-list"},{"title":"Export insight incidents","description":"Export the incidents matched by the analytics filters as a CSV file, one row per incident.","deprecated":null,"version":null,"sidebarTitle":"Export insight incidents","openapi":"/api-reference/on-call.openapi.en.json post /insight/incident/export","href":"/en/api-reference/on-call/analytics/insight-incident-export"},{"title":"Get channel insight","description":"Return incident and alert metrics grouped by channel, one row per channel per time bucket.","deprecated":null,"version":null,"sidebarTitle":"Get channel insight","openapi":"/api-reference/on-call.openapi.en.json post /insight/channel","href":"/en/api-reference/on-call/analytics/insight-by-channel"},{"title":"Export channel insight","description":"Export channel insight metrics as a CSV file with the same rows as `/insight/channel`.","deprecated":null,"version":null,"sidebarTitle":"Export channel insight","openapi":"/api-reference/on-call.openapi.en.json post /insight/channel/export","href":"/en/api-reference/on-call/analytics/insight-channel-export"},{"title":"Get team insight","description":"Return incident and alert metrics grouped by team, one row per team per time bucket.","deprecated":null,"version":null,"sidebarTitle":"Get team insight","openapi":"/api-reference/on-call.openapi.en.json post /insight/team","href":"/en/api-reference/on-call/analytics/insight-by-team"},{"title":"Export team insight","description":"Export team insight metrics as a CSV file with the same rows as `/insight/team`.","deprecated":null,"version":null,"sidebarTitle":"Export team insight","openapi":"/api-reference/on-call.openapi.en.json post /insight/team/export","href":"/en/api-reference/on-call/analytics/insight-team-export"},{"title":"Get responder insight","description":"Return per-responder incident handling metrics, one row per responder per time bucket.","deprecated":null,"version":null,"sidebarTitle":"Get responder insight","openapi":"/api-reference/on-call.openapi.en.json post /insight/responder","href":"/en/api-reference/on-call/analytics/insight-by-responder"},{"title":"Export responder insight","description":"Export responder insight metrics as a CSV file with the same rows as `/insight/responder`.","deprecated":null,"version":null,"sidebarTitle":"Export responder insight","openapi":"/api-reference/on-call.openapi.en.json post /insight/responder/export","href":"/en/api-reference/on-call/analytics/insight-responder-export"}]},{"group":"Status pages","icon":"signal-stream","pages":[{"group":"Changes","icon":"newspaper","pages":[{"title":"Get status page event detail","description":"Retrieve details of a specific status page event (incident or maintenance).","deprecated":null,"version":null,"sidebarTitle":"Get status page event detail","openapi":"/api-reference/on-call.openapi.en.json get /status-page/change/info","href":"/en/api-reference/on-call/status-pages/status-page-change-info"},{"title":"List status page events","description":"List the incidents or maintenances of a status page by status and time window, including hidden components.","deprecated":null,"version":null,"sidebarTitle":"List status page events","openapi":"/api-reference/on-call.openapi.en.json get /status-page/change/list","href":"/en/api-reference/on-call/status-pages/status-page-change-list"},{"title":"Create status page event","description":"Create a new incident or maintenance event on a status page.","deprecated":null,"version":null,"sidebarTitle":"Create status page event","openapi":"/api-reference/on-call.openapi.en.json post /status-page/change/create","href":"/en/api-reference/on-call/status-pages/status-page-change-create"},{"title":"Update status page event","description":"Update the title, responders, or linked events of a status page event.","deprecated":null,"version":null,"sidebarTitle":"Update status page event","openapi":"/api-reference/on-call.openapi.en.json post /status-page/change/update","href":"/en/api-reference/on-call/status-pages/status-page-change-update"},{"title":"Delete status page event","description":"Delete an incident or maintenance event from a status page.","deprecated":null,"version":null,"sidebarTitle":"Delete status page event","openapi":"/api-reference/on-call.openapi.en.json post /status-page/change/delete","href":"/en/api-reference/on-call/status-pages/status-page-change-delete"},{"title":"Create event timeline entry","description":"Add a timeline update to a status page event.","deprecated":null,"version":null,"sidebarTitle":"Create event timeline entry","openapi":"/api-reference/on-call.openapi.en.json post /status-page/change/timeline/create","href":"/en/api-reference/on-call/status-pages/status-page-change-timeline-create"},{"title":"Update event timeline entry","description":"Edit the time or description of a status page event timeline entry.","deprecated":null,"version":null,"sidebarTitle":"Update event timeline entry","openapi":"/api-reference/on-call.openapi.en.json post /status-page/change/timeline/update","href":"/en/api-reference/on-call/status-pages/status-page-change-timeline-update"},{"title":"Delete event timeline entry","description":"Delete a timeline entry from a status page event.","deprecated":null,"version":null,"sidebarTitle":"Delete event timeline entry","openapi":"/api-reference/on-call.openapi.en.json post /status-page/change/timeline/delete","href":"/en/api-reference/on-call/status-pages/status-page-change-timeline-delete"}]},{"group":"Subscribers","icon":"envelope","pages":[{"title":"List status page subscribers","description":"List subscribers who have signed up for status page notifications.","deprecated":null,"version":null,"sidebarTitle":"List status page subscribers","openapi":"/api-reference/on-call.openapi.en.json get /status-page/subscriber/list","href":"/en/api-reference/on-call/status-pages/status-page-subscriber-list"},{"title":"Import subscribers","description":"Bulk import subscribers into a status page without sending confirmation emails.","deprecated":null,"version":null,"sidebarTitle":"Import subscribers","openapi":"/api-reference/on-call.openapi.en.json post /status-page/subscriber/import","href":"/en/api-reference/on-call/status-pages/status-page-subscriber-import"},{"title":"Export subscribers","description":"Export the subscribers of a status page as a CSV file.","deprecated":null,"version":null,"sidebarTitle":"Export subscribers","openapi":"/api-reference/on-call.openapi.en.json post /status-page/subscriber/export","href":"/en/api-reference/on-call/status-pages/status-page-subscriber-export"}]},{"group":"Migration","icon":"truck-moving","pages":[{"title":"Migrate status page structure","description":"Start a migration job that imports the structure and historical events of an Atlassian Statuspage into a new Flashduty status page.","deprecated":null,"version":null,"sidebarTitle":"Migrate status page structure","openapi":"/api-reference/on-call.openapi.en.json post /status-page/migrate-structure","href":"/en/api-reference/on-call/status-pages/status-page-migrate-structure"},{"title":"Migrate email subscribers","description":"Start a migration job that imports email subscribers from an Atlassian Statuspage into an existing Flashduty status page.","deprecated":null,"version":null,"sidebarTitle":"Migrate email subscribers","openapi":"/api-reference/on-call.openapi.en.json post /status-page/migrate-email-subscribers","href":"/en/api-reference/on-call/status-pages/status-page-migrate-email-subscribers"},{"title":"Get migration status","description":"Get the current status and progress of a status page migration job.","deprecated":null,"version":null,"sidebarTitle":"Get migration status","openapi":"/api-reference/on-call.openapi.en.json get /status-page/migration/status","href":"/en/api-reference/on-call/status-pages/status-page-migration-status"},{"title":"Cancel status page migration","description":"Cancel a running Atlassian Statuspage migration job.","deprecated":null,"version":null,"sidebarTitle":"Cancel status page migration","openapi":"/api-reference/on-call.openapi.en.json post /status-page/migration/cancel","href":"/en/api-reference/on-call/status-pages/status-page-migration-cancel"}]},{"title":"List status pages","description":"List all status pages owned by the account, including their components and sections.","deprecated":null,"version":null,"sidebarTitle":"List status pages","openapi":"/api-reference/on-call.openapi.en.json get /status-page/list","href":"/en/api-reference/on-call/status-pages/status-page-read-page-list"},{"title":"List active status page events","description":"List in-progress (non-terminal) events of a given type for a status page.","deprecated":null,"version":null,"sidebarTitle":"List active status page events","openapi":"/api-reference/on-call.openapi.en.json get /status-page/change/active/list","href":"/en/api-reference/on-call/status-pages/status-page-change-active-list"},{"title":"Get status page detail","description":"Retrieve detailed configuration for a specific status page.","deprecated":null,"version":null,"sidebarTitle":"Get status page detail","openapi":"/api-reference/on-call.openapi.en.json get /status-page/info","href":"/en/api-reference/on-call/status-pages/status-page-info"},{"title":"Create status page","description":"Create a public or internal status page for the account.","deprecated":null,"version":null,"sidebarTitle":"Create status page","openapi":"/api-reference/on-call.openapi.en.json post /status-page/create","href":"/en/api-reference/on-call/status-pages/status-page-create"},{"title":"Update status page","description":"Update the configuration of an existing status page; omitted fields keep their values.","deprecated":null,"version":null,"sidebarTitle":"Update status page","openapi":"/api-reference/on-call.openapi.en.json post /status-page/update","href":"/en/api-reference/on-call/status-pages/status-page-update"},{"title":"Delete status page","description":"Delete a status page together with its events and subscriptions.","deprecated":null,"version":null,"sidebarTitle":"Delete status page","openapi":"/api-reference/on-call.openapi.en.json post /status-page/delete","href":"/en/api-reference/on-call/status-pages/status-page-delete"},{"title":"Upsert status page component","description":"Create or update one or more service components on a status page.","deprecated":null,"version":null,"sidebarTitle":"Upsert status page component","openapi":"/api-reference/on-call.openapi.en.json post /status-page/component/upsert","href":"/en/api-reference/on-call/status-pages/status-page-component-upsert"},{"title":"Delete status page component","description":"Delete one or more service components from a status page.","deprecated":null,"version":null,"sidebarTitle":"Delete status page component","openapi":"/api-reference/on-call.openapi.en.json post /status-page/component/delete","href":"/en/api-reference/on-call/status-pages/status-page-component-delete"},{"title":"Upsert status page section","description":"Create or update one or more sections that group components on a status page.","deprecated":null,"version":null,"sidebarTitle":"Upsert status page section","openapi":"/api-reference/on-call.openapi.en.json post /status-page/section/upsert","href":"/en/api-reference/on-call/status-pages/status-page-section-upsert"},{"title":"Delete status page section","description":"Delete one or more sections from a status page; their components move to the top level.","deprecated":null,"version":null,"sidebarTitle":"Delete status page section","openapi":"/api-reference/on-call.openapi.en.json post /status-page/section/delete","href":"/en/api-reference/on-call/status-pages/status-page-section-delete"},{"title":"Upsert status page template","description":"Create or update a predefined event template or a message template of a status page.","deprecated":null,"version":null,"sidebarTitle":"Upsert status page template","openapi":"/api-reference/on-call.openapi.en.json post /status-page/template/upsert","href":"/en/api-reference/on-call/status-pages/status-page-template-upsert"},{"title":"Delete status page template","description":"Delete a predefined event template or a message template from a status page.","deprecated":null,"version":null,"sidebarTitle":"Delete status page template","openapi":"/api-reference/on-call.openapi.en.json post /status-page/template/delete","href":"/en/api-reference/on-call/status-pages/status-page-template-delete"},{"title":"List status page templates","description":"List the predefined event templates or message templates of a status page.","deprecated":null,"version":null,"sidebarTitle":"List status page templates","openapi":"/api-reference/on-call.openapi.en.json get /status-page/template/list","href":"/en/api-reference/on-call/status-pages/status-page-template-list"},{"title":"Create status page draft","description":"Store a status page event draft so a human can review and publish it from the console.","deprecated":null,"version":null,"sidebarTitle":"Create status page draft","openapi":"/api-reference/on-call.openapi.en.json post /status-page/draft/create","href":"/en/api-reference/on-call/status-pages/status-page-draft-create"}]},{"group":"Changes","icon":"code-commit","pages":[{"title":"List changes","description":"Query change records within a time window, with filtering, search, and pagination.","deprecated":null,"version":null,"sidebarTitle":"List changes","openapi":"/api-reference/on-call.openapi.en.json post /change/list","href":"/en/api-reference/on-call/changes/change-read-list"}]}]},{"group":"Monitors","icon":"chart-area","pages":[{"group":"Alert rules","icon":"diamond-exclamation","pages":[{"title":"List alert rules","description":"Return basic information for the alert rules in a folder; call `POST /monit/rule/v2/info` for full details.","deprecated":null,"version":null,"sidebarTitle":"List alert rules","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/list/basic","href":"/en/api-reference/monitors/alert-rules/monit-rule-read-list"},{"title":"Get alert rule detail (V2)","description":"Return the full V2 configuration of an alert rule by ID, including lifecycle v2 recovery and ending modes.","deprecated":null,"version":null,"sidebarTitle":"Get alert rule detail (V2)","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/v2/info","href":"/en/api-reference/monitors/alert-rules/monit-rule-read-info-v2"},{"title":"Create alert rule (V2)","description":"Create a new V2 alert rule. Returns the created rule with its assigned ID.","deprecated":null,"version":null,"sidebarTitle":"Create alert rule (V2)","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/v2/create","href":"/en/api-reference/monitors/alert-rules/monit-rule-write-create-v2"},{"title":"Update alert rule (V2)","description":"Replace an alert rule's V2 configuration in full by ID. Returns the updated rule.","deprecated":null,"version":null,"sidebarTitle":"Update alert rule (V2)","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/v2/update","href":"/en/api-reference/monitors/alert-rules/monit-rule-write-update-v2"},{"title":"Delete alert rule","description":"Delete a single alert rule by its ID.","deprecated":null,"version":null,"sidebarTitle":"Delete alert rule","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/delete","href":"/en/api-reference/monitors/alert-rules/monit-rule-write-delete"},{"title":"Batch delete alert rules","description":"Delete multiple alert rules in a single request.","deprecated":null,"version":null,"sidebarTitle":"Batch delete alert rules","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/delete/batch","href":"/en/api-reference/monitors/alert-rules/monit-rule-write-delete-batch"},{"title":"Batch update rule fields","description":"Update the fields listed in `fields` on multiple alert rules in one call.","deprecated":null,"version":null,"sidebarTitle":"Batch update rule fields","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/update/fields","href":"/en/api-reference/monitors/alert-rules/monit-rule-write-fields-update"},{"title":"Move alert rules to folder","description":"Move one or more alert rules to a different folder.","deprecated":null,"version":null,"sidebarTitle":"Move alert rules to folder","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/move","href":"/en/api-reference/monitors/alert-rules/monit-rule-write-move"},{"title":"List rule change history","description":"Return the change history (audit records) for an alert rule.","deprecated":null,"version":null,"sidebarTitle":"List rule change history","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/audits","href":"/en/api-reference/monitors/alert-rules/monit-rule-read-audits"},{"title":"Get rule audit snapshot","description":"Return one audit record of an alert rule, including the rule snapshot stored in `content`.","deprecated":null,"version":null,"sidebarTitle":"Get rule audit snapshot","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/audit/detail","href":"/en/api-reference/monitors/alert-rules/monit-rule-read-audit-detail"},{"title":"Get rule counter time series","description":"Return the stored time series of the total rule count across the account — one sample per `clock` timestamp.","deprecated":null,"version":null,"sidebarTitle":"Get rule counter time series","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/counter/total","href":"/en/api-reference/monitors/alert-rules/monit-rule-read-counter-total"},{"title":"Get rule counts by channel","description":"Return how many alert rules route alerts to each collaboration space, keyed by space name.","deprecated":null,"version":null,"sidebarTitle":"Get rule counts by channel","openapi":"/api-reference/monitors.openapi.en.json post /monit/rule/counter/channel","href":"/en/api-reference/monitors/alert-rules/monit-rule-read-counter-channel"}]},{"group":"Data sources","icon":"database","pages":[{"title":"List datasources","description":"List the account's datasources that the caller can query, optionally filtered by type or exact name.","deprecated":null,"version":null,"sidebarTitle":"List datasources","openapi":"/api-reference/monitors.openapi.en.json post /monit/datasource/list","href":"/en/api-reference/monitors/data-sources/monit-datasource-read-list"},{"title":"Get datasource detail","description":"Return one datasource by ID, including its full `payload` configuration.","deprecated":null,"version":null,"sidebarTitle":"Get datasource detail","openapi":"/api-reference/monitors.openapi.en.json post /monit/datasource/info","href":"/en/api-reference/monitors/data-sources/monit-datasource-read-info"},{"title":"Create datasource","description":"Create a monitoring datasource of one of 15 supported types and bind it to a Monitors edge cluster.","deprecated":null,"version":null,"sidebarTitle":"Create datasource","openapi":"/api-reference/monitors.openapi.en.json post /monit/datasource/create","href":"/en/api-reference/monitors/data-sources/monit-datasource-write-create"},{"title":"Update datasource","description":"Update a datasource by ID, replacing its name, note, address, payload and edge cluster.","deprecated":null,"version":null,"sidebarTitle":"Update datasource","openapi":"/api-reference/monitors.openapi.en.json post /monit/datasource/update","href":"/en/api-reference/monitors/data-sources/monit-datasource-write-update"},{"title":"Delete datasource","description":"Delete a datasource by ID; alert rules that reference it are not blocked.","deprecated":null,"version":null,"sidebarTitle":"Delete datasource","openapi":"/api-reference/monitors.openapi.en.json post /monit/datasource/delete","href":"/en/api-reference/monitors/data-sources/monit-datasource-write-delete"},{"title":"Invoke datasource tool","description":"Execute one deterministic diagnostic or query tool against a configured datasource.","deprecated":null,"version":null,"sidebarTitle":"Invoke datasource tool","openapi":"/api-reference/monitors.openapi.en.json post /monit/datasource/tools/invoke","href":"/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke"},{"title":"List SLS projects","description":"List Alibaba Cloud SLS (Simple Log Service) projects available in the specified SLS datasource.","deprecated":null,"version":null,"sidebarTitle":"List SLS projects","openapi":"/api-reference/monitors.openapi.en.json post /monit/datasource/sls/projects","href":"/en/api-reference/monitors/data-sources/monit-datasource-read-sls-projects"},{"title":"List SLS logstores","description":"List logstores within an SLS project for the specified SLS datasource.","deprecated":null,"version":null,"sidebarTitle":"List SLS logstores","openapi":"/api-reference/monitors.openapi.en.json post /monit/datasource/sls/logstores","href":"/en/api-reference/monitors/data-sources/monit-datasource-read-sls-logstores"},{"title":"List Prometheus label values","description":"Read label values from a Prometheus-compatible data source through the Monitors proxy.","deprecated":null,"version":null,"sidebarTitle":"List Prometheus label values","openapi":"/api-reference/monitors.openapi.en.json get /monit/prometheus/api/v1/label/{label_name}/values","href":"/en/api-reference/monitors/data-sources/monit-prometheus-read-label-values"}]},{"group":"Diagnostics","icon":"stethoscope","pages":[{"title":"Query structured data","description":"Run a synchronous ad-hoc query against a data source and return a `query_result.v1` result as frames, records, or samples.","deprecated":null,"version":null,"sidebarTitle":"Query structured data","openapi":"/api-reference/monitors.openapi.en.json post /monit/query/data","href":"/en/api-reference/monitors/diagnostics/monit-read-query-data"},{"title":"Run Explore query","description":"Run an Explore query against a configured data source and return frames, samples, or logs.","deprecated":null,"version":null,"sidebarTitle":"Run Explore query","openapi":"/api-reference/monitors.openapi.en.json post /monit/query/explore","href":"/en/api-reference/monitors/diagnostics/monit-read-query-explore"}]},{"group":"Dashboards","icon":"chart-pie","pages":[{"title":"List dashboards","description":"List the dashboards stored directly in one folder, with word search and paging.","deprecated":null,"version":null,"sidebarTitle":"List dashboards","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/list","href":"/en/api-reference/monitors/dashboards/monit-dashboard-read-list"},{"title":"Search dashboards","description":"Search dashboards across every readable folder.","deprecated":null,"version":null,"sidebarTitle":"Search dashboards","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/search","href":"/en/api-reference/monitors/dashboards/monit-dashboard-read-search"},{"title":"Get dashboard detail","description":"Fetch one dashboard with its full definition.","deprecated":null,"version":null,"sidebarTitle":"Get dashboard detail","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/get","href":"/en/api-reference/monitors/dashboards/monit-dashboard-read-get"},{"title":"Get dashboard outline","description":"Get a dashboard's structure without queries or definitions.","deprecated":null,"version":null,"sidebarTitle":"Get dashboard outline","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/outline","href":"/en/api-reference/monitors/dashboards/monit-dashboard-read-outline"},{"title":"Create dashboard","description":"Create a dashboard from a full definition.","deprecated":null,"version":null,"sidebarTitle":"Create dashboard","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/create","href":"/en/api-reference/monitors/dashboards/monit-dashboard-write-create"},{"title":"Update dashboard","description":"Replace a dashboard definition with compare-and-swap on the revision counter.","deprecated":null,"version":null,"sidebarTitle":"Update dashboard","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/update","href":"/en/api-reference/monitors/dashboards/monit-dashboard-write-update"},{"title":"Move dashboard","description":"Move a dashboard to another folder without changing its definition.","deprecated":null,"version":null,"sidebarTitle":"Move dashboard","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/move","href":"/en/api-reference/monitors/dashboards/monit-dashboard-write-move"},{"title":"Delete dashboard","description":"Move a dashboard to the trash, where it can be restored for 30 days.","deprecated":null,"version":null,"sidebarTitle":"Delete dashboard","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/delete","href":"/en/api-reference/monitors/dashboards/monit-dashboard-write-delete"},{"title":"Restore dashboard","description":"Bring a trashed dashboard back, optionally into a different folder.","deprecated":null,"version":null,"sidebarTitle":"Restore dashboard","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/restore","href":"/en/api-reference/monitors/dashboards/monit-dashboard-write-restore"},{"title":"List trashed dashboards","description":"List deleted dashboards still inside the 30-day retention window.","deprecated":null,"version":null,"sidebarTitle":"List trashed dashboards","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/trash/list","href":"/en/api-reference/monitors/dashboards/monit-dashboard-trash-read-list"},{"title":"List dashboard revisions","description":"List a dashboard's revision history, newest first.","deprecated":null,"version":null,"sidebarTitle":"List dashboard revisions","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/revisions/list","href":"/en/api-reference/monitors/dashboards/monit-dashboard-revision-read-list"},{"title":"Get dashboard revision","description":"Fetch one historical revision with its full definition.","deprecated":null,"version":null,"sidebarTitle":"Get dashboard revision","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/revisions/get","href":"/en/api-reference/monitors/dashboards/monit-dashboard-revision-read-get"},{"title":"Resolve dashboard variables","description":"Resolve every variable of a stored dashboard for a time range.","deprecated":null,"version":null,"sidebarTitle":"Resolve dashboard variables","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/runtime/variables/resolve","href":"/en/api-reference/monitors/dashboards/monit-dashboard-variable-read-resolve"},{"title":"Preview draft variables","description":"Resolve a draft variable set that is not stored in any dashboard.","deprecated":null,"version":null,"sidebarTitle":"Preview draft variables","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/runtime/variables/preview","href":"/en/api-reference/monitors/dashboards/monit-dashboard-variable-read-preview"},{"title":"Resolve panel queries","description":"Bind panel queries to datasources and substitute variables without executing them.","deprecated":null,"version":null,"sidebarTitle":"Resolve panel queries","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/runtime/queries/resolve","href":"/en/api-reference/monitors/dashboards/monit-dashboard-query-read-resolve"},{"title":"Run dashboard panel","description":"Execute one panel of a stored dashboard and return the datasource results.","deprecated":null,"version":null,"sidebarTitle":"Run dashboard panel","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/panel/run","href":"/en/api-reference/monitors/dashboards/monit-dashboard-panel-read-run"},{"title":"Preview draft panel","description":"Execute a draft panel inline without saving a dashboard revision.","deprecated":null,"version":null,"sidebarTitle":"Preview draft panel","openapi":"/api-reference/monitors.openapi.en.json post /monit/dashboard/panel/preview","href":"/en/api-reference/monitors/dashboards/monit-dashboard-panel-read-preview"}]},{"group":"Rule folders","icon":"folder-tree","pages":[{"title":"List monitor folders","description":"List every monitor folder the caller can read.","deprecated":null,"version":null,"sidebarTitle":"List monitor folders","openapi":"/api-reference/monitors.openapi.en.json post /monit/folder/list","href":"/en/api-reference/monitors/rule-folders/monit-folder-read-list"},{"title":"Get monitor folder health","description":"Get issue flags for the visible monitor folders, including issues in their descendants.","deprecated":null,"version":null,"sidebarTitle":"Get monitor folder health","openapi":"/api-reference/monitors.openapi.en.json post /monit/folder/health","href":"/en/api-reference/monitors/rule-folders/monit-folder-read-health"},{"title":"Create monitor folder","description":"Create a monitor folder at the root or under a parent folder the caller may modify.","deprecated":null,"version":null,"sidebarTitle":"Create monitor folder","openapi":"/api-reference/monitors.openapi.en.json post /monit/folder/create","href":"/en/api-reference/monitors/rule-folders/monit-folder-write-create"},{"title":"Update monitor folder","description":"Replace the name, note, and team assignment of a monitor folder the caller may modify.","deprecated":null,"version":null,"sidebarTitle":"Update monitor folder","openapi":"/api-reference/monitors.openapi.en.json post /monit/folder/update","href":"/en/api-reference/monitors/rule-folders/monit-folder-write-update"},{"title":"Move monitor folder","description":"Move a monitor folder and its descendants under another folder or to the root.","deprecated":null,"version":null,"sidebarTitle":"Move monitor folder","openapi":"/api-reference/monitors.openapi.en.json post /monit/folder/move","href":"/en/api-reference/monitors/rule-folders/monit-folder-write-move"},{"title":"Delete monitor folder","description":"Delete an empty monitor folder that the caller may modify.","deprecated":null,"version":null,"sidebarTitle":"Delete monitor folder","openapi":"/api-reference/monitors.openapi.en.json post /monit/folder/delete","href":"/en/api-reference/monitors/rule-folders/monit-folder-write-delete"}]}]},{"group":"RUM","icon":"monitor-waveform","pages":[{"group":"Applications","icon":"mobile-screen-button","pages":[{"title":"List applications","description":"Return a paginated list of RUM applications accessible to the current user.","deprecated":null,"version":null,"sidebarTitle":"List applications","openapi":"/api-reference/rum.openapi.en.json post /rum/application/list","href":"/en/api-reference/rum/applications/rum-application-read-list"},{"title":"Get application detail","description":"Retrieve full details of a single RUM application by `application_id`.","deprecated":null,"version":null,"sidebarTitle":"Get application detail","openapi":"/api-reference/rum.openapi.en.json post /rum/application/info","href":"/en/api-reference/rum/applications/rum-application-read-info"},{"title":"Batch get applications","description":"Retrieve details for multiple RUM applications by their IDs in one request.","deprecated":null,"version":null,"sidebarTitle":"Batch get applications","openapi":"/api-reference/rum.openapi.en.json post /rum/application/infos","href":"/en/api-reference/rum/applications/rum-application-read-infos"},{"title":"Create application","description":"Create a new RUM application. Returns the generated `application_id` and `client_token`.","deprecated":null,"version":null,"sidebarTitle":"Create application","openapi":"/api-reference/rum.openapi.en.json post /rum/application/create","href":"/en/api-reference/rum/applications/rum-application-write-create"},{"title":"Update application","description":"Update selected fields of a RUM application; fields left out of the request keep their current values.","deprecated":null,"version":null,"sidebarTitle":"Update application","openapi":"/api-reference/rum.openapi.en.json post /rum/application/update","href":"/en/api-reference/rum/applications/rum-application-write-update"},{"title":"Delete application","description":"Delete a RUM application by `application_id`.","deprecated":null,"version":null,"sidebarTitle":"Delete application","openapi":"/api-reference/rum.openapi.en.json post /rum/application/delete","href":"/en/api-reference/rum/applications/rum-application-write-delete"},{"title":"Test application webhook","description":"Send a sample RUM alert event to verify an application's webhook URL.","deprecated":null,"version":null,"sidebarTitle":"Test application webhook","openapi":"/api-reference/rum.openapi.en.json post /rum/application/webhook/test","href":"/en/api-reference/rum/applications/rum-application-webhook-test"},{"title":"Get remote config detail","description":"Retrieve the live remote configuration of a RUM application and the version it is stored under.","deprecated":null,"version":null,"sidebarTitle":"Get remote config detail","openapi":"/api-reference/rum.openapi.en.json post /rum/application/remote-config/get","href":"/en/api-reference/rum/applications/rum-application-remote-config-read-get"},{"title":"Update remote config","description":"Publish a complete new remote configuration version for a RUM application.","deprecated":null,"version":null,"sidebarTitle":"Update remote config","openapi":"/api-reference/rum.openapi.en.json post /rum/application/remote-config/update","href":"/en/api-reference/rum/applications/rum-application-remote-config-write-update"},{"title":"Preview remote config","description":"Evaluate a draft remote configuration against a client context without publishing it.","deprecated":null,"version":null,"sidebarTitle":"Preview remote config","openapi":"/api-reference/rum.openapi.en.json post /rum/application/remote-config/preview","href":"/en/api-reference/rum/applications/rum-application-remote-config-read-preview"},{"title":"List remote config history","description":"List published remote configuration versions of a RUM application.","deprecated":null,"version":null,"sidebarTitle":"List remote config history","openapi":"/api-reference/rum.openapi.en.json post /rum/application/remote-config/history/list","href":"/en/api-reference/rum/applications/rum-application-remote-config-read-history-list"},{"title":"Revert remote config","description":"Republish an earlier remote configuration version's content as a new version.","deprecated":null,"version":null,"sidebarTitle":"Revert remote config","openapi":"/api-reference/rum.openapi.en.json post /rum/application/remote-config/history/revert","href":"/en/api-reference/rum/applications/rum-application-remote-config-write-history-revert"}]},{"group":"Data query","icon":"chart-line","pages":[{"title":"Query RUM data","description":"Run one or more SQL-style RUM data queries over a bounded time range.","deprecated":null,"version":null,"sidebarTitle":"Query RUM data","openapi":"/api-reference/rum.openapi.en.json post /rum/data/query","href":"/en/api-reference/rum/data-query/rum-read-data-query"}]},{"group":"Dashboards","icon":"gauge","pages":[{"title":"Create dashboard","description":"Create a RUM custom dashboard from a full definition.","deprecated":null,"version":null,"sidebarTitle":"Create dashboard","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/create","href":"/en/api-reference/rum/dashboards/rum-dashboard-write-create"},{"title":"Delete dashboard","description":"Move a dashboard to the trash under an expected-revision check.","deprecated":null,"version":null,"sidebarTitle":"Delete dashboard","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/delete","href":"/en/api-reference/rum/dashboards/rum-dashboard-write-delete"},{"title":"Get dashboard detail","description":"Get one dashboard with its current definition and revision.","deprecated":null,"version":null,"sidebarTitle":"Get dashboard detail","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/get","href":"/en/api-reference/rum/dashboards/rum-dashboard-read-get"},{"title":"List dashboards","description":"List the account's dashboards, newest change first by default.","deprecated":null,"version":null,"sidebarTitle":"List dashboards","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/list","href":"/en/api-reference/rum/dashboards/rum-dashboard-read-list"},{"title":"Restore dashboard","description":"Restore a dashboard from the trash as a new revision.","deprecated":null,"version":null,"sidebarTitle":"Restore dashboard","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/restore","href":"/en/api-reference/rum/dashboards/rum-dashboard-write-restore"},{"title":"Get dashboard revision","description":"Get one revision of a dashboard with its full definition.","deprecated":null,"version":null,"sidebarTitle":"Get dashboard revision","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/revisions/get","href":"/en/api-reference/rum/dashboards/rum-dashboard-read-revision-get"},{"title":"List dashboard revisions","description":"List a dashboard's revision history, newest first.","deprecated":null,"version":null,"sidebarTitle":"List dashboard revisions","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/revisions/list","href":"/en/api-reference/rum/dashboards/rum-dashboard-read-revision-list"},{"title":"List deleted dashboards","description":"List the deleted dashboards, newest deletion first by default.","deprecated":null,"version":null,"sidebarTitle":"List deleted dashboards","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/trash/list","href":"/en/api-reference/rum/dashboards/rum-dashboard-read-trash-list"},{"title":"Update dashboard","description":"Replace a dashboard's definition under an expected-revision check.","deprecated":null,"version":null,"sidebarTitle":"Update dashboard","openapi":"/api-reference/rum.openapi.en.json post /rum/dashboard/update","href":"/en/api-reference/rum/dashboards/rum-dashboard-write-update"}]},{"group":"Issues","icon":"bug","pages":[{"title":"List issues","description":"Return a paginated list of RUM error tracking issues matching the given filters.","deprecated":null,"version":null,"sidebarTitle":"List issues","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/list","href":"/en/api-reference/rum/issues/rum-issue-read-list"},{"title":"Export issues as CSV","description":"Export the issues matching the `POST /rum/issue/list` filters as a CSV file of at most 100 rows.","deprecated":null,"version":null,"sidebarTitle":"Export issues as CSV","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/export","href":"/en/api-reference/rum/issues/rum-issue-read-export"},{"title":"Get issue detail","description":"Retrieve full details of a single issue by `issue_id`.","deprecated":null,"version":null,"sidebarTitle":"Get issue detail","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/info","href":"/en/api-reference/rum/issues/rum-issue-read-info"},{"title":"Update issue","description":"Update the status or suspected cause of an issue.","deprecated":null,"version":null,"sidebarTitle":"Update issue","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/update","href":"/en/api-reference/rum/issues/rum-issue-write-update"}]},{"group":"Session replay","icon":"clapperboard-play","pages":[{"title":"Get session replay metadata","description":"Return the application, device, session bounds, and views recorded for a replayable session.","deprecated":null,"version":null,"sidebarTitle":"Get session replay metadata","openapi":"/api-reference/rum.openapi.en.json post /rum/session-replay/metadata","href":"/en/api-reference/rum/session-replay/rum-session-replay-read-metadata"},{"title":"List session replay segments","description":"Page through the recorded replay segments of a session, as presigned URLs or a raw stream.","deprecated":null,"version":null,"sidebarTitle":"List session replay segments","openapi":"/api-reference/rum.openapi.en.json post /rum/session-replay/segments","href":"/en/api-reference/rum/session-replay/rum-session-replay-read-segments"}]},{"group":"Facets","icon":"filter","pages":[{"title":"Count facet value distribution","description":"Return the top N values for a facet field within a time range, sorted by occurrence count descending.","deprecated":null,"version":null,"sidebarTitle":"Count facet value distribution","openapi":"/api-reference/rum.openapi.en.json post /rum/facet/count","href":"/en/api-reference/rum/facets/rum-read-facet-count"},{"title":"List RUM fields","description":"Return RUM field definitions, optionally filtered by scope and facet status.","deprecated":null,"version":null,"sidebarTitle":"List RUM fields","openapi":"/api-reference/rum.openapi.en.json post /rum/field/list","href":"/en/api-reference/rum/facets/rum-read-field-list"}]},{"group":"Sourcemaps","icon":"map","pages":[{"title":"List sourcemaps","description":"Return a paginated list of uploaded sourcemap files filtered by platform type, service, and version.","deprecated":null,"version":null,"sidebarTitle":"List sourcemaps","openapi":"/api-reference/rum.openapi.en.json post /sourcemap/list","href":"/en/api-reference/rum/sourcemaps/sourcemap-read-list"},{"title":"Enrich a stack trace","description":"Symbolicate or deobfuscate a stack trace with the sourcemaps or symbol files uploaded for a service version.","deprecated":null,"version":null,"sidebarTitle":"Enrich a stack trace","openapi":"/api-reference/rum.openapi.en.json post /sourcemap/stack/enrich","href":"/en/api-reference/rum/sourcemaps/sourcemap-read-stack-enrich"}]},{"group":"Error ingestion rules","icon":"bug-slash","pages":[{"title":"List error ingestion rules","description":"Return every error ingestion rule configured for a RUM application.","deprecated":null,"version":null,"sidebarTitle":"List error ingestion rules","openapi":"/api-reference/rum.openapi.en.json post /rum/error-ingestion/rules/list","href":"/en/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-list"},{"title":"Create an error ingestion rule","description":"Create a rule whose matching errors are kept out of issue grouping; matched errors are still stored.","deprecated":null,"version":null,"sidebarTitle":"Create an error ingestion rule","openapi":"/api-reference/rum.openapi.en.json post /rum/error-ingestion/rules/create","href":"/en/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-create"},{"title":"Update an error ingestion rule","description":"Update the name, description, or filters of an error ingestion rule.","deprecated":null,"version":null,"sidebarTitle":"Update an error ingestion rule","openapi":"/api-reference/rum.openapi.en.json post /rum/error-ingestion/rules/update","href":"/en/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-update"},{"title":"Delete an error ingestion rule","description":"Delete an error ingestion rule from a RUM application.","deprecated":null,"version":null,"sidebarTitle":"Delete an error ingestion rule","openapi":"/api-reference/rum.openapi.en.json post /rum/error-ingestion/rules/delete","href":"/en/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-delete"},{"title":"Enable an error ingestion rule","description":"Re-enable a previously disabled error ingestion rule.","deprecated":null,"version":null,"sidebarTitle":"Enable an error ingestion rule","openapi":"/api-reference/rum.openapi.en.json post /rum/error-ingestion/rules/enable","href":"/en/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-enable"},{"title":"Disable an error ingestion rule","description":"Disable an error ingestion rule without deleting it.","deprecated":null,"version":null,"sidebarTitle":"Disable an error ingestion rule","openapi":"/api-reference/rum.openapi.en.json post /rum/error-ingestion/rules/disable","href":"/en/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-disable"},{"title":"List error ingestion rule history","description":"Return paginated snapshots of an application's error ingestion rule history.","deprecated":null,"version":null,"sidebarTitle":"List error ingestion rule history","openapi":"/api-reference/rum.openapi.en.json post /rum/error-ingestion/rules/history/list","href":"/en/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-history-list"},{"title":"Revert error ingestion rules to a history version","description":"Restore an application's entire rule set to a prior history version.","deprecated":null,"version":null,"sidebarTitle":"Revert error ingestion rules to a history version","openapi":"/api-reference/rum.openapi.en.json post /rum/error-ingestion/rules/history/revert","href":"/en/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-history-revert"}]},{"group":"Issue preset severity rules","icon":"triangle-exclamation","pages":[{"title":"List preset severity rules","description":"Return all preset severity rules configured for a RUM application.","deprecated":null,"version":null,"sidebarTitle":"List preset severity rules","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/list","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-list"},{"title":"Create preset severity rule","description":"Create a new preset severity rule for a RUM application.","deprecated":null,"version":null,"sidebarTitle":"Create preset severity rule","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/create","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-create"},{"title":"Update preset severity rule","description":"Update the name, description, filters, or severity of a preset severity rule.","deprecated":null,"version":null,"sidebarTitle":"Update preset severity rule","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/update","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-update"},{"title":"Delete preset severity rule","description":"Delete a preset severity rule.","deprecated":null,"version":null,"sidebarTitle":"Delete preset severity rule","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/delete","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-delete"},{"title":"Enable preset severity rule","description":"Enable a preset severity rule.","deprecated":null,"version":null,"sidebarTitle":"Enable preset severity rule","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/enable","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-enable"},{"title":"Disable preset severity rule","description":"Disable a preset severity rule.","deprecated":null,"version":null,"sidebarTitle":"Disable preset severity rule","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/disable","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-disable"},{"title":"Reorder preset severity rule","description":"Move one preset severity rule to another rule's position in evaluation order.","deprecated":null,"version":null,"sidebarTitle":"Reorder preset severity rule","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/reorder","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-reorder"},{"title":"List preset severity rule history","description":"Return the change history of preset severity rules for a RUM application.","deprecated":null,"version":null,"sidebarTitle":"List preset severity rule history","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/history/list","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-history-list"},{"title":"Revert preset severity rules to a history snapshot","description":"Roll back preset severity rules to the state captured in a specific history snapshot.","deprecated":null,"version":null,"sidebarTitle":"Revert preset severity rules to a history snapshot","openapi":"/api-reference/rum.openapi.en.json post /rum/issue/preset-severity/rules/history/revert","href":"/en/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-history-revert"}]},{"group":"Resources","icon":"gauge-high","pages":[{"title":"Get RUM resource info","description":"Return the account's RUM resource record and its current session usage.","deprecated":null,"version":null,"sidebarTitle":"Get RUM resource info","openapi":"/api-reference/rum.openapi.en.json post /rum/resource/info","href":"/en/api-reference/rum/resources/rum-resource-read-info"}]}]},{"group":"AI SRE","icon":"robot","pages":[{"group":"Sessions","icon":"comments","pages":[{"title":"List sessions","description":"List agent sessions visible to the caller, filtered by app, entry surface, archive status, and team.","deprecated":null,"version":null,"sidebarTitle":"List sessions","openapi":"/api-reference/safari.openapi.en.json post /safari/session/list","href":"/en/api-reference/ai-sre/sessions/session-read-list"},{"title":"Get session detail","description":"Fetch one session plus a backward-paged window of its most recent events.","deprecated":null,"version":null,"sidebarTitle":"Get session detail","openapi":"/api-reference/safari.openapi.en.json post /safari/session/get","href":"/en/api-reference/ai-sre/sessions/session-read-info"},{"title":"Export session transcript","description":"Stream a session's full event transcript as newline-delimited JSON.","deprecated":null,"version":null,"sidebarTitle":"Export session transcript","openapi":"/api-reference/safari.openapi.en.json post /safari/session/export","href":"/en/api-reference/ai-sre/sessions/session-read-export"},{"title":"Delete session","description":"Soft-delete a session together with its subagent sessions and the files it presented.","deprecated":null,"version":null,"sidebarTitle":"Delete session","openapi":"/api-reference/safari.openapi.en.json post /safari/session/delete","href":"/en/api-reference/ai-sre/sessions/session-write-delete"}]},{"group":"Automations","icon":"clock","pages":[{"title":"Create Automation rule","description":"Create an Automation rule with schedule, HTTP POST, On-call incident, and war room triggers.","deprecated":null,"version":null,"sidebarTitle":"Create Automation rule","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/rule/create","href":"/en/api-reference/ai-sre/automations/automation-rule-write-create"},{"title":"List Automation rules","description":"List Automation rules visible to the caller, newest update first, with pagination and filters.","deprecated":null,"version":null,"sidebarTitle":"List Automation rules","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/rule/list","href":"/en/api-reference/ai-sre/automations/automation-rule-read-list"},{"title":"List Automation templates","description":"List built-in Automation templates that prefill the create-rule form, in Chinese or English.","deprecated":null,"version":null,"sidebarTitle":"List Automation templates","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/template/list","href":"/en/api-reference/ai-sre/automations/automation-template-read-list"},{"title":"List Automation runs","description":"List the run history of one Automation rule, newest first, with status, trigger, and time filters.","deprecated":null,"version":null,"sidebarTitle":"List Automation runs","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/run/list","href":"/en/api-reference/ai-sre/automations/automation-run-read-list"},{"title":"Get Automation rule","description":"Get one Automation rule by ID, including its trigger settings and execution destination.","deprecated":null,"version":null,"sidebarTitle":"Get Automation rule","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/rule/get","href":"/en/api-reference/ai-sre/automations/automation-rule-read-get"},{"title":"Update Automation rule","description":"Update an Automation rule's fields and trigger settings; omitted fields keep their current values.","deprecated":null,"version":null,"sidebarTitle":"Update Automation rule","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/rule/update","href":"/en/api-reference/ai-sre/automations/automation-rule-write-update"},{"title":"Delete Automation rule","description":"Delete an Automation rule together with all of its triggers and their subscriptions.","deprecated":null,"version":null,"sidebarTitle":"Delete Automation rule","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/rule/delete","href":"/en/api-reference/ai-sre/automations/automation-rule-write-delete"},{"title":"Run Automation rule","deprecated":null,"version":null,"sidebarTitle":"Run Automation rule","openapi":"/api-reference/safari.openapi.en.json post /safari/automation/rule/run","href":"/en/api-reference/ai-sre/automations/automation-rule-write-run"}]},{"group":"Skills","icon":"wand-magic-sparkles","pages":[{"title":"List skills","description":"List AI SRE skills visible to the caller across account and team scopes, with pagination.","deprecated":null,"version":null,"sidebarTitle":"List skills","openapi":"/api-reference/safari.openapi.en.json post /safari/skill/list","href":"/en/api-reference/ai-sre/skills/skill-read-list"},{"title":"Get skill detail","description":"Get one skill including its full SKILL.md content.","deprecated":null,"version":null,"sidebarTitle":"Get skill detail","openapi":"/api-reference/safari.openapi.en.json post /safari/skill/get","href":"/en/api-reference/ai-sre/skills/skill-read-get"},{"title":"Update skill","description":"Update a skill's descriptions or reassign its team scope.","deprecated":null,"version":null,"sidebarTitle":"Update skill","openapi":"/api-reference/safari.openapi.en.json post /safari/skill/update","href":"/en/api-reference/ai-sre/skills/skill-write-update"},{"title":"Delete skill","description":"Soft-delete a skill so agents stop loading it and its name can be reused.","deprecated":null,"version":null,"sidebarTitle":"Delete skill","openapi":"/api-reference/safari.openapi.en.json post /safari/skill/delete","href":"/en/api-reference/ai-sre/skills/skill-write-delete"},{"title":"Upload skill","description":"Upload a skill archive (.skill/.zip/.tar.gz/.tgz) to create or replace a skill.","deprecated":null,"version":null,"sidebarTitle":"Upload skill","openapi":"/api-reference/safari.openapi.en.json post /safari/skill/upload","href":"/en/api-reference/ai-sre/skills/skill-write-upload"},{"title":"Enable skill","description":"Enable a disabled skill so the agent can load it.","deprecated":null,"version":null,"sidebarTitle":"Enable skill","openapi":"/api-reference/safari.openapi.en.json post /safari/skill/enable","href":"/en/api-reference/ai-sre/skills/skill-read-enable"},{"title":"Disable skill","description":"Disable an enabled skill so the agent stops loading it.","deprecated":null,"version":null,"sidebarTitle":"Disable skill","openapi":"/api-reference/safari.openapi.en.json post /safari/skill/disable","href":"/en/api-reference/ai-sre/skills/skill-write-disable"}]},{"group":"MCP servers","icon":"plug","pages":[{"title":"List MCP servers","description":"List MCP servers visible to the caller across account and team scopes, with pagination.","deprecated":null,"version":null,"sidebarTitle":"List MCP servers","openapi":"/api-reference/safari.openapi.en.json post /safari/mcp/server/list","href":"/en/api-reference/ai-sre/mcp-servers/mcp-read-server-list"},{"title":"Create MCP server","description":"Register a new MCP server (connector) on the account.","deprecated":null,"version":null,"sidebarTitle":"Create MCP server","openapi":"/api-reference/safari.openapi.en.json post /safari/mcp/server/create","href":"/en/api-reference/ai-sre/mcp-servers/mcp-write-server-create"},{"title":"Get MCP server detail","description":"Get one MCP server as a pure database read — no live probe is performed.","deprecated":null,"version":null,"sidebarTitle":"Get MCP server detail","openapi":"/api-reference/safari.openapi.en.json post /safari/mcp/server/get","href":"/en/api-reference/ai-sre/mcp-servers/mcp-read-server-get"},{"title":"Update MCP server","description":"Update an MCP server's configuration. Omit a field to leave it unchanged.","deprecated":null,"version":null,"sidebarTitle":"Update MCP server","openapi":"/api-reference/safari.openapi.en.json post /safari/mcp/server/update","href":"/en/api-reference/ai-sre/mcp-servers/mcp-write-server-update"},{"title":"Delete MCP server","description":"Delete an MCP server by ID.","deprecated":null,"version":null,"sidebarTitle":"Delete MCP server","openapi":"/api-reference/safari.openapi.en.json post /safari/mcp/server/delete","href":"/en/api-reference/ai-sre/mcp-servers/mcp-write-server-delete"},{"title":"Enable MCP server","description":"Enable a disabled MCP server.","deprecated":null,"version":null,"sidebarTitle":"Enable MCP server","openapi":"/api-reference/safari.openapi.en.json post /safari/mcp/server/enable","href":"/en/api-reference/ai-sre/mcp-servers/mcp-write-server-enable"},{"title":"Disable MCP server","description":"Disable an enabled MCP server.","deprecated":null,"version":null,"sidebarTitle":"Disable MCP server","openapi":"/api-reference/safari.openapi.en.json post /safari/mcp/server/disable","href":"/en/api-reference/ai-sre/mcp-servers/mcp-write-server-disable"}]},{"group":"A2A agents","icon":"robot","pages":[{"title":"Create A2A agent","description":"Register a new A2A remote agent from its agent-card URL.","deprecated":null,"version":null,"sidebarTitle":"Create A2A agent","openapi":"/api-reference/safari.openapi.en.json post /safari/a2a-agent/create","href":"/en/api-reference/ai-sre/a2a-agents/remote-agent-write-create"},{"title":"List A2A agents","description":"List A2A agents visible to the caller across account and team scopes, with pagination.","deprecated":null,"version":null,"sidebarTitle":"List A2A agents","openapi":"/api-reference/safari.openapi.en.json post /safari/a2a-agent/list","href":"/en/api-reference/ai-sre/a2a-agents/remote-agent-read-list"},{"title":"Get A2A agent detail","description":"Return one A2A agent's configuration by ID, with auth secrets masked.","deprecated":null,"version":null,"sidebarTitle":"Get A2A agent detail","openapi":"/api-reference/safari.openapi.en.json post /safari/a2a-agent/get","href":"/en/api-reference/ai-sre/a2a-agents/remote-agent-read-get"},{"title":"Update A2A agent","description":"Apply a partial update to an A2A agent. Omit a field to leave it unchanged.","deprecated":null,"version":null,"sidebarTitle":"Update A2A agent","openapi":"/api-reference/safari.openapi.en.json post /safari/a2a-agent/update","href":"/en/api-reference/ai-sre/a2a-agents/remote-agent-write-update"},{"title":"Enable A2A agent","description":"Enable a disabled A2A agent.","deprecated":null,"version":null,"sidebarTitle":"Enable A2A agent","openapi":"/api-reference/safari.openapi.en.json post /safari/a2a-agent/enable","href":"/en/api-reference/ai-sre/a2a-agents/remote-agent-write-enable"},{"title":"Disable A2A agent","description":"Disable an enabled A2A agent.","deprecated":null,"version":null,"sidebarTitle":"Disable A2A agent","openapi":"/api-reference/safari.openapi.en.json post /safari/a2a-agent/disable","href":"/en/api-reference/ai-sre/a2a-agents/remote-agent-write-disable"},{"title":"Delete A2A agent","description":"Soft-delete an A2A agent by ID.","deprecated":null,"version":null,"sidebarTitle":"Delete A2A agent","openapi":"/api-reference/safari.openapi.en.json post /safari/a2a-agent/delete","href":"/en/api-reference/ai-sre/a2a-agents/remote-agent-write-delete"}]},{"group":"Artifacts","icon":"images","pages":[{"title":"List artifacts","description":"List published artifacts visible to the caller, with pagination and title search.","deprecated":null,"version":null,"sidebarTitle":"List artifacts","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/list","href":"/en/api-reference/ai-sre/artifacts/artifact-read-list"},{"title":"Get artifact detail","description":"Get one published artifact by ID, including its source file, owner and public-share state.","deprecated":null,"version":null,"sidebarTitle":"Get artifact detail","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/get","href":"/en/api-reference/ai-sre/artifacts/artifact-read-get"},{"title":"Get file publish state","description":"Check which presented files already have a live published artifact.","deprecated":null,"version":null,"sidebarTitle":"Get file publish state","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/file-state","href":"/en/api-reference/ai-sre/artifacts/artifact-read-get-file-state"},{"title":"Create signed file URLs","description":"Create short-lived signed URLs to download or preview a presented file.","deprecated":null,"version":null,"sidebarTitle":"Create signed file URLs","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/sign","href":"/en/api-reference/ai-sre/artifacts/artifact-read-sign"},{"title":"Download or preview a file","description":"Download or preview a file's bytes using a signed token.","deprecated":null,"version":null,"sidebarTitle":"Download or preview a file","openapi":"/api-reference/safari.openapi.en.json get /safari/artifact/stream","href":"/en/api-reference/ai-sre/artifacts/artifact-read-stream"},{"title":"Publish file as artifact","description":"Publish a session-produced file to the artifact gallery.","deprecated":null,"version":null,"sidebarTitle":"Publish file as artifact","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/publish-from-file","href":"/en/api-reference/ai-sre/artifacts/artifact-write-publish"},{"title":"Update artifact","description":"Rename an artifact or transfer it between personal and team scope.","deprecated":null,"version":null,"sidebarTitle":"Update artifact","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/update","href":"/en/api-reference/ai-sre/artifacts/artifact-write-update"},{"title":"Remove artifact from gallery","description":"Detach an artifact from the gallery; the source file stays with its session.","deprecated":null,"version":null,"sidebarTitle":"Remove artifact from gallery","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/delete","href":"/en/api-reference/ai-sre/artifacts/artifact-write-delete"},{"title":"Enable public sharing","description":"Turn on anonymous public sharing for an artifact and return its public link.","deprecated":null,"version":null,"sidebarTitle":"Enable public sharing","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/share/enable","href":"/en/api-reference/ai-sre/artifacts/artifact-write-share-enable"},{"title":"Update shared snapshot","description":"Refresh the public snapshot of a shared artifact with its latest content.","deprecated":null,"version":null,"sidebarTitle":"Update shared snapshot","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/share/sync","href":"/en/api-reference/ai-sre/artifacts/artifact-write-share-sync"},{"title":"Revoke public sharing","description":"Turn off public sharing; the link stops resolving immediately.","deprecated":null,"version":null,"sidebarTitle":"Revoke public sharing","openapi":"/api-reference/safari.openapi.en.json post /safari/artifact/gallery/share/revoke","href":"/en/api-reference/ai-sre/artifacts/artifact-write-share-revoke"}]},{"group":"Knowledge","icon":"book","pages":[{"title":"List knowledge","description":"List the knowledge visible to the caller across account and team scopes.","deprecated":null,"version":null,"sidebarTitle":"List knowledge","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/pack/list","href":"/en/api-reference/ai-sre/knowledge/knowledge-pack-read-list"},{"title":"Get account knowledge","description":"Return the metadata and file list of the account-scope knowledge.","deprecated":null,"version":null,"sidebarTitle":"Get account knowledge","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/get","href":"/en/api-reference/ai-sre/knowledge/knowledge-pack-read-get"},{"title":"Ensure knowledge","description":"Idempotently create the knowledge at the given scope, or return the existing one.","deprecated":null,"version":null,"sidebarTitle":"Ensure knowledge","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/pack/ensure","href":"/en/api-reference/ai-sre/knowledge/knowledge-pack-write-ensure"},{"title":"Update knowledge","description":"Move knowledge to a different account or team scope.","deprecated":null,"version":null,"sidebarTitle":"Update knowledge","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/pack/update","href":"/en/api-reference/ai-sre/knowledge/knowledge-pack-write-update"},{"title":"Delete knowledge","description":"Delete knowledge and all of its files.","deprecated":null,"version":null,"sidebarTitle":"Delete knowledge","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/pack/delete","href":"/en/api-reference/ai-sre/knowledge/knowledge-pack-write-delete"},{"title":"List knowledge files","description":"List knowledge files with metadata such as size and checksum.","deprecated":null,"version":null,"sidebarTitle":"List knowledge files","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/file/list","href":"/en/api-reference/ai-sre/knowledge/knowledge-file-read-list"},{"title":"Get knowledge file","description":"Return a knowledge file's metadata and its base64-encoded content.","deprecated":null,"version":null,"sidebarTitle":"Get knowledge file","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/file/get","href":"/en/api-reference/ai-sre/knowledge/knowledge-file-read-get"},{"title":"Upload knowledge file","description":"Create or overwrite a knowledge file with base64-encoded content.","deprecated":null,"version":null,"sidebarTitle":"Upload knowledge file","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/file/put","href":"/en/api-reference/ai-sre/knowledge/knowledge-file-write-put"},{"title":"Delete knowledge file","description":"Delete a knowledge file by its relative path.","deprecated":null,"version":null,"sidebarTitle":"Delete knowledge file","openapi":"/api-reference/safari.openapi.en.json post /safari/knowledge/file/delete","href":"/en/api-reference/ai-sre/knowledge/knowledge-file-write-delete"}]}]},{"group":"Platform","icon":"gear","pages":[{"group":"Members","icon":"users","pages":[{"title":"Get current member info","description":"Return the profile and account context of the member who owns the credential.","deprecated":null,"version":null,"sidebarTitle":"Get current member info","openapi":"/api-reference/platform.openapi.en.json post /member/info","href":"/en/api-reference/platform/members/member-info"},{"title":"List members","description":"Return a paginated list of organization members.","deprecated":null,"version":null,"sidebarTitle":"List members","openapi":"/api-reference/platform.openapi.en.json post /member/list","href":"/en/api-reference/platform/members/member-list"},{"title":"Delete member","description":"Remove a member from the organization by ID, email, phone, or name.","deprecated":null,"version":null,"sidebarTitle":"Delete member","openapi":"/api-reference/platform.openapi.en.json post /member/delete","href":"/en/api-reference/platform/members/member-delete"},{"title":"Invite members","description":"Batch invite new members to the organization by email or phone.","deprecated":null,"version":null,"sidebarTitle":"Invite members","openapi":"/api-reference/platform.openapi.en.json post /member/invite","href":"/en/api-reference/platform/members/member-invite"},{"title":"Grant role to member","description":"Add one or more roles to a member's existing role assignments.","deprecated":null,"version":null,"sidebarTitle":"Grant role to member","openapi":"/api-reference/platform.openapi.en.json post /member/role/grant","href":"/en/api-reference/platform/members/member-grant-role"},{"title":"Revoke role from member","description":"Remove one or more roles from a member's role assignments.","deprecated":null,"version":null,"sidebarTitle":"Revoke role from member","openapi":"/api-reference/platform.openapi.en.json post /member/role/revoke","href":"/en/api-reference/platform/members/member-revoke-role"},{"title":"Update member roles","description":"Replace a member's role assignments with the given set of roles.","deprecated":null,"version":null,"sidebarTitle":"Update member roles","openapi":"/api-reference/platform.openapi.en.json post /member/role/update","href":"/en/api-reference/platform/members/member-update-role"},{"title":"Reset member info","description":"Identify a member and reset the specified profile fields.","deprecated":null,"version":null,"sidebarTitle":"Reset member info","openapi":"/api-reference/platform.openapi.en.json post /member/info/reset","href":"/en/api-reference/platform/members/member-reset-info"},{"title":"Notify members","description":"Email account members a message written by the calling AI SRE session.","deprecated":null,"version":null,"sidebarTitle":"Notify members","openapi":"/api-reference/platform.openapi.en.json post /member/notify","href":"/en/api-reference/platform/members/member-notify"},{"title":"Batch get persons","description":"Return profile information for a batch of person IDs (members or accounts).","deprecated":null,"version":null,"sidebarTitle":"Batch get persons","openapi":"/api-reference/platform.openapi.en.json post /person/infos","href":"/en/api-reference/platform/members/person-infos"}]},{"group":"Teams","icon":"users-line","pages":[{"title":"Get team detail","description":"Return a single team by ID, name, or external reference ID.","deprecated":null,"version":null,"sidebarTitle":"Get team detail","openapi":"/api-reference/platform.openapi.en.json post /team/info","href":"/en/api-reference/platform/teams/team-read-info"},{"title":"Batch get teams","description":"Return basic info for multiple teams by their IDs in a single request.","deprecated":null,"version":null,"sidebarTitle":"Batch get teams","openapi":"/api-reference/platform.openapi.en.json post /team/infos","href":"/en/api-reference/platform/teams/team-read-infos"},{"title":"List teams","description":"Return a paginated list of teams in the current account.","deprecated":null,"version":null,"sidebarTitle":"List teams","openapi":"/api-reference/platform.openapi.en.json post /team/list","href":"/en/api-reference/platform/teams/team-read-list"},{"title":"Create or update a team","description":"Create a new team or update an existing one. Pass `team_id` to update.","deprecated":null,"version":null,"sidebarTitle":"Create or update a team","openapi":"/api-reference/platform.openapi.en.json post /team/upsert","href":"/en/api-reference/platform/teams/team-write-upsert"},{"title":"Delete a team","description":"Delete a team by ID, name, or external reference ID and remove all of its members.","deprecated":null,"version":null,"sidebarTitle":"Delete a team","openapi":"/api-reference/platform.openapi.en.json post /team/delete","href":"/en/api-reference/platform/teams/team-write-delete"}]},{"group":"Roles \u0026 permissions","icon":"user-shield","pages":[{"title":"Get role detail","description":"Return the detail of a single role by its ID.","deprecated":null,"version":null,"sidebarTitle":"Get role detail","openapi":"/api-reference/platform.openapi.en.json post /role/info","href":"/en/api-reference/platform/roles-permissions/role-read-info"},{"title":"List roles","description":"Return all custom and built-in roles for the current account.","deprecated":null,"version":null,"sidebarTitle":"List roles","openapi":"/api-reference/platform.openapi.en.json post /role/list","href":"/en/api-reference/platform/roles-permissions/role-read-list"},{"title":"Create or update a role","description":"Create a new custom role or update an existing one. Pass `role_id` to update.","deprecated":null,"version":null,"sidebarTitle":"Create or update a role","openapi":"/api-reference/platform.openapi.en.json post /role/upsert","href":"/en/api-reference/platform/roles-permissions/role-write-upsert"},{"title":"Enable a role","description":"Re-enable a previously disabled custom role.","deprecated":null,"version":null,"sidebarTitle":"Enable a role","openapi":"/api-reference/platform.openapi.en.json post /role/enable","href":"/en/api-reference/platform/roles-permissions/role-write-enable"},{"title":"Disable a role","description":"Set a custom role's status to disabled without deleting it.","deprecated":null,"version":null,"sidebarTitle":"Disable a role","openapi":"/api-reference/platform.openapi.en.json post /role/disable","href":"/en/api-reference/platform/roles-permissions/role-write-disable"},{"title":"Delete a role","description":"Delete a custom role, optionally revoking it from every member who still holds it.","deprecated":null,"version":null,"sidebarTitle":"Delete a role","openapi":"/api-reference/platform.openapi.en.json post /role/delete","href":"/en/api-reference/platform/roles-permissions/role-write-delete"},{"title":"List permissions","description":"List permission entries and mark which of them the given roles grant.","deprecated":null,"version":null,"sidebarTitle":"List permissions","openapi":"/api-reference/platform.openapi.en.json post /role/permission/list","href":"/en/api-reference/platform/roles-permissions/role-read-list-permission"},{"title":"List permission factors","description":"List the permission factors granted to the calling member through their roles.","deprecated":null,"version":null,"sidebarTitle":"List permission factors","openapi":"/api-reference/platform.openapi.en.json post /role/permission/factor/list","href":"/en/api-reference/platform/roles-permissions/role-read-list-permission-factor"},{"title":"Grant role to members","description":"Assign a role to one or more members, giving them its permissions.","deprecated":null,"version":null,"sidebarTitle":"Grant role to members","openapi":"/api-reference/platform.openapi.en.json post /role/member/grant","href":"/en/api-reference/platform/roles-permissions/role-write-grant-role"},{"title":"Revoke role from members","description":"Remove a role from one or more members, revoking the permissions it granted.","deprecated":null,"version":null,"sidebarTitle":"Revoke role from members","openapi":"/api-reference/platform.openapi.en.json post /role/member/revoke","href":"/en/api-reference/platform/roles-permissions/role-write-revoke-role"}]},{"group":"Audit logs","icon":"scroll","pages":[{"title":"Search audit logs","description":"Return a cursor-paginated list of audit log entries within a time range.","deprecated":null,"version":null,"sidebarTitle":"Search audit logs","openapi":"/api-reference/platform.openapi.en.json post /audit/search","href":"/en/api-reference/platform/audit-logs/audit-read-search"},{"title":"List auditable operation types","description":"Return all operation names that are recorded in the audit log, for use as `operations` filter values.","deprecated":null,"version":null,"sidebarTitle":"List auditable operation types","openapi":"/api-reference/platform.openapi.en.json post /audit/operation/list","href":"/en/api-reference/platform/audit-logs/audit-read-operation-list"}]},{"group":"Account","icon":"id-card","pages":[{"title":"Get account detail","description":"Return the current account's profile and settings.","deprecated":null,"version":null,"sidebarTitle":"Get account detail","openapi":"/api-reference/platform.openapi.en.json post /account/info","href":"/en/api-reference/platform/account/account-read-info"}]}]}]}]}]},"title":"Run Automation rule - Flashduty Docs","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}