An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs. read:change_events is reserved: keys can carry it, but no endpoint needs it yet.
Scopes
write:incidents
Path Parameters
id
string<uuid>
required
Incident id.
Body
application/json
description
string
Response
ok
id
string<uuid>
required
title
string
required
type
enum<string>
required
Available options:
Incident,
Maintenance
created_at
string<date-time>
required
severity
enum<string> | null
Available options:
minor,
major,
critical,
maintenance,
null
state
enum<string>
Available options:
draft,
published,
resolved,
scheduled,
in_progress,
completed,
canceled
published_at
string<date-time> | null
resolved_at
string<date-time> | null
scheduled_start_at
string<date-time> | null
scheduled_end_at
string<date-time> | null
actual_start_at
string<date-time> | null
actual_end_at
string<date-time> | null
canceled_at
string<date-time> | null
postmortem_url
string<uri> | null
affected_services
object[]
Show child attributes
visible_to_customer_ids
string<uuid>[]
customer_targeting
object
Which customers the update affects: mode (none, selected or all), customers (empty unless mode is selected), and whether their linked subscribers are emailed.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Observer Docs","description":"Observer documentation: install the agent, connect Prometheus, OpenTelemetry and probes, publish metric-driven status pages, track SLOs, and use the API.","colors":{"primary":"#35C68C","light":"#35C68C","dark":"#35C68C"},"logo":{"light":"https://mintcdn.com/observer-55c64b1d/EVAFfwwZSxUdEUoQ/logo/light.png?fit=max\u0026auto=format\u0026n=EVAFfwwZSxUdEUoQ\u0026q=85\u0026s=ac35eeffcfd53350cec867dd0b149925","dark":"https://mintcdn.com/observer-55c64b1d/EVAFfwwZSxUdEUoQ/logo/dark.png?fit=max\u0026auto=format\u0026n=EVAFfwwZSxUdEUoQ\u0026q=85\u0026s=0627bee4d060b071ca40d3f9934376de","href":"https://use.observer"},"favicon":"https://mintcdn.com/observer-55c64b1d/EVAFfwwZSxUdEUoQ/favicon.svg?fit=max\u0026auto=format\u0026n=EVAFfwwZSxUdEUoQ\u0026q=85\u0026s=a174fa24d5dd29b75d0cd27ca1242d61","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"]}},"background":{"decoration":"grid","color":{"light":"#F2F2F2","dark":"#191919"}},"navbar":{"links":[{"icon":"globe","href":"https://use.observer","label":"use.observer"},{"icon":"log-in","href":"https://use.observer/sign-in","label":"Sign in"}],"primary":{"type":"button","label":"Start free","href":"https://use.observer/sign-up"}},"footer":{"socials":{"github":"https://github.com/useobserver"}},"seo":{"metatags":{"description":"Observer documentation: install the agent, connect Prometheus, OpenTelemetry and probes, publish metric-driven status pages, track SLOs, and use the API.","application-name":"Observer Docs","robots":"index, follow, max-image-preview:large","theme-color":"#0b0a0a","og:type":"website","og:site_name":"Observer Docs","og:title":"Observer Docs","og:description":"Install the agent, connect Prometheus, OpenTelemetry and probes, publish metric-driven status pages, track SLOs, and automate it all with the API and MCP.","og:url":"https://docs.use.observer","og:locale":"en_GB","og:image":"https://use.observer/opengraph-image","og:image:type":"image/png","og:image:width":"1200","og:image:height":"630","og:image:alt":"Observer: status pages that read your telemetry","twitter:card":"summary_large_image","twitter:site":"@use_Observer","twitter:title":"Observer Docs","twitter:description":"Agent install, probes, Prometheus and OpenTelemetry, status pages, SLOs, the REST API and MCP server for Observer.","twitter:image":"https://use.observer/opengraph-image","twitter:image:alt":"Observer: status pages that read your telemetry"},"indexing":"navigable"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","download-pdf","claude","perplexity","chatgpt"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"observer-55c64b1d","hasAudioNarration":false,"actualSubdomain":"observer-55c64b1d","customDomains":["docs.use.observer"],"gitSource":{"type":"github","owner":"useobserver","repo":"docs","deployBranch":"mintlify-release","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afa0706c11f076dcacd4cc0","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Documentation","count":77},{"language":"default","tag":"API","count":57},{"language":"default","tag":"Guides","count":51},{"language":"default","tag":"Observer Agent","count":35},{"language":"default","tag":"Concepts","count":16},{"language":"default","tag":"Incidents","count":14},{"language":"default","tag":"Reference","count":12},{"language":"default","tag":"Notifications","count":11},{"language":"default","tag":"Quickstart","count":10},{"language":"default","tag":"Metrics","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"tab-accent.css","content":"html[data-obs-tab=\"agent\"]{--primary: 168 119 0 !important;--primary-light: 255 207 68 !important;--primary-dark: 138 97 0 !important}html[data-obs-tab=\"api\"]{--primary: 21 20 19 !important;--primary-light: 243 242 239 !important;--primary-dark: 70 68 63 !important}span.pointer-events-none[style*=\"radial-gradient\"]{background:radial-gradient(\n 49.63% 57.02% at 58.99% -7.2%,\n rgb(var(--primary-light) / 0.1) 39.4%,\n rgba(0, 0, 0, 0) 100%\n )!important}"},{"filePath":"sidebar-links.css","content":"#sidebar a[href=\"https://use.observer/sign-up\"]{color:rgb(var(--primary))}.dark #sidebar a[href=\"https://use.observer/sign-up\"]{color:rgb(var(--primary-light))}#sidebar a[href=\"https://use.observer/sign-up\"]:hover{opacity:0.85}#sidebar a[href=\"https://use.observer/sign-up\"]::before{content:\"\";flex-shrink:0;width:1rem;height:1lh;background-color:currentColor;-webkit-mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M4.5 16.5c-1.5 1.26-2 5-2 5s3.74-.5 5-2c.71-.84.7-2.13-.09-2.91a2.18 2.18 0 0 0-2.91-.09z'/%3E%3Cpath d='m12 15-3-3a22 22 0 0 1 2-3.95A12.88 12.88 0 0 1 22 2c0 2.72-.78 7.5-6 11a22.35 22.35 0 0 1-4 2z'/%3E%3Cpath d='M9 12H4s.55-3.03 2-4c1.62-1.08 5 0 5 0'/%3E%3Cpath d='M12 15v5s3.03-.55 4-2c1.08-1.62 0-5 0-5'/%3E%3C/svg%3E\") center / 1rem 1rem no-repeat;mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M4.5 16.5c-1.5 1.26-2 5-2 5s3.74-.5 5-2c.71-.84.7-2.13-.09-2.91a2.18 2.18 0 0 0-2.91-.09z'/%3E%3Cpath d='m12 15-3-3a22 22 0 0 1 2-3.95A12.88 12.88 0 0 1 22 2c0 2.72-.78 7.5-6 11a22.35 22.35 0 0 1-4 2z'/%3E%3Cpath d='M9 12H4s.55-3.03 2-4c1.62-1.08 5 0 5 0'/%3E%3Cpath d='M12 15v5s3.03-.55 4-2c1.08-1.62 0-5 0-5'/%3E%3C/svg%3E\") center / 1rem 1rem no-repeat}"}],"page":{"pagePath":"api/incidents/post-incidents-by-id-resolve","slug":"/api/incidents/post-incidents-by-id-resolve","pageMetadata":{"title":"Resolve an incident","openapi":"api-reference/openapi.json POST /incidents/{id}/resolve","description":null,"href":"/api/incidents/post-incidents-by-id-resolve"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Resolve an incident","openapi":"api-reference/openapi.json POST /incidents/{id}/resolve","description":null,"href":"/api/incidents/post-incidents-by-id-resolve"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/observer-55c64b1d/f7b53cdcdf2b52bc/tab-accent.js"],"openApiReferenceData":{"operation":{"operationId":"resolveIncident","x-mcp-title":"Resolve incident","x-mcp-annotations":{"idempotentHint":true,"openWorldHint":true},"summary":"Resolve an incident with optional final message","tags":["incidents"],"security":["ed9d1931-bd96-46dd-a360-9dbb4c48e50f"],"requestBody":"d68563d5-4c50-40e2-b17a-9dd803718a51","responses":{"200":"e70978b3-59bc-4225-9a23-d8864b205bcc","401":"702dbb7a-3a3e-48ee-9c41-ab9b2252741b","403":"96be5bba-320c-4665-8247-4fd4357d5db8","404":"06cccfa4-a092-40ce-8b17-66438e964b3f","409":"4e3e4a1a-ca44-48c0-885b-bdda4f37f296","429":"7632829e-b376-4397-af69-f2a677096425","500":"6a788114-366e-405f-828f-5bc3e5ba6259"},"method":"post","type":"path","servers":["b1a0327b-ef1d-4d9b-969a-1de22fe32269"],"path":"/incidents/{id}/resolve","baseUrlOptions":["https://use.observer/api/v1"],"title":"Resolve an incident with optional final message","description":"","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7763c44e-5a8a-4879-bded-fce6b1986744":{"name":"id","in":"path","required":true,"description":"Incident id.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Incident id.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","uniqueKey":"description","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"description":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e70978b3-59bc-4225-9a23-d8864b205bcc":{"description":"ok","content":{"application/json":{"schema":{"type":"object","required":["id","title","type","created_at"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","enum":["Incident","Maintenance"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"severity":{"oneOf":[{"type":"string","enum":["minor","major","critical","maintenance",null],"uniqueKey":"severity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["minor","major","critical","maintenance",null],"uniqueKey":"severity.oneOf.1","typeLabel":"null"}],"uniqueKey":"severity","typeLabel":"enum\u003cstring> | null"},"state":{"type":"string","enum":["draft","published","resolved","scheduled","in_progress","completed","canceled"],"uniqueKey":"state","typeLabel":"enum\u003cstring>"},"published_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"published_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"published_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_at","typeLabel":"string\u003cdate-time> | null"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_at","typeLabel":"string\u003cdate-time> | null"},"scheduled_start_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"scheduled_start_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"scheduled_start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"scheduled_start_at","typeLabel":"string\u003cdate-time> | null"},"scheduled_end_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"scheduled_end_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"scheduled_end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"scheduled_end_at","typeLabel":"string\u003cdate-time> | null"},"actual_start_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"actual_start_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"actual_start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"actual_start_at","typeLabel":"string\u003cdate-time> | null"},"actual_end_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"actual_end_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"actual_end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"actual_end_at","typeLabel":"string\u003cdate-time> | null"},"canceled_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"canceled_at","typeLabel":"string\u003cdate-time> | null"},"postmortem_url":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"postmortem_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"postmortem_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"postmortem_url","typeLabel":"string\u003curi> | null"},"affected_services":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"affected_services.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"affected_services.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"affected_services.items.[INDEX]","typeLabel":"object"},"uniqueKey":"affected_services","typeLabel":"object[]"},"visible_to_customer_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"visible_to_customer_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"visible_to_customer_ids","typeLabel":"string\u003cuuid>[]"},"customer_targeting":{"type":"object","description":"Which customers the update affects: mode (none, selected or all), customers (empty unless mode is selected), and whether their linked subscribers are emailed.","required":["mode","customers","notify_customer_subscribers"],"properties":{"mode":{"type":"string","enum":["none","selected","all"],"isRequired":true,"uniqueKey":"customer_targeting.mode","typeLabel":"enum\u003cstring>"},"customers":{"type":"array","items":{"type":"object","required":["id","external_id","name"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"customer_targeting.customers.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"external_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"customer_targeting.customers.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"customer_targeting.customers.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer_targeting.customers.items.[INDEX].external_id","typeLabel":"string | null"},"name":{"type":"string","isRequired":true,"uniqueKey":"customer_targeting.customers.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"customer_targeting.customers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"customer_targeting.customers","typeLabel":"object[]"},"notify_customer_subscribers":{"type":"boolean","isRequired":true,"uniqueKey":"customer_targeting.notify_customer_subscribers","typeLabel":"boolean"}},"uniqueKey":"customer_targeting","typeLabel":"object"},"messages":{"type":"array","description":"The timeline, oldest first (by `date`, then `id`).","items":{"type":"object","required":["id","type","description","date"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"messages.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["Investigating","Information","Identified","Resolved"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].description","typeLabel":"string"},"date":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].date","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","type":"Incident","created_at":"2023-11-07T05:31:56Z","severity":"minor","state":"draft","published_at":"2023-11-07T05:31:56Z","resolved_at":"2023-11-07T05:31:56Z","scheduled_start_at":"2023-11-07T05:31:56Z","scheduled_end_at":"2023-11-07T05:31:56Z","actual_start_at":"2023-11-07T05:31:56Z","actual_end_at":"2023-11-07T05:31:56Z","canceled_at":"2023-11-07T05:31:56Z","postmortem_url":"\u003cstring>","affected_services":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"}],"visible_to_customer_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"customer_targeting":{"mode":"none","customers":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","external_id":"\u003cstring>","name":"\u003cstring>"}],"notify_customer_subscribers":true},"messages":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"Investigating","description":"\u003cstring>","date":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"headers":{"X-RateLimit-Limit":{"description":"Requests allowed per minute for the organization.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the per-minute window resets.","schema":{"type":"integer"}},"X-RateLimit-Daily-Limit":{"description":"Requests allowed per UTC day for the organization.","schema":{"type":"integer"}},"X-RateLimit-Daily-Remaining":{"description":"Requests left today (UTC).","schema":{"type":"integer"}},"X-RateLimit-Daily-Reset":{"description":"Seconds until the daily quota resets (UTC midnight).","schema":{"type":"integer"}}},"exampleType":"generated"},"702dbb7a-3a3e-48ee-9c41-ab9b2252741b":{"description":"`unauthenticated`: no bearer token was sent, or the key is invalid or revoked. `detail` distinguishes the two.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"example":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"},"properties":{"type":{"type":"string","format":"uri","description":"Errors reference URI with the title token as the fragment.","example":"https://docs.use.observer/api/getting-started/errors#forbidden","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Stable error token. Branch on this, not on detail.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation. Wording may change.","uniqueKey":"detail","typeLabel":"string"},"retry_after":{"type":"integer","description":"429 only: seconds until the exhausted window resets (mirrors Retry-After).","uniqueKey":"retry_after","typeLabel":"integer"},"limit":{"type":"object","description":"429 only: which organization limit was hit.","properties":{"scope":{"type":"string","enum":["organization"],"uniqueKey":"limit.scope","typeLabel":"enum\u003cstring>"},"window":{"type":"string","enum":["minute","day"],"uniqueKey":"limit.window","typeLabel":"enum\u003cstring>"},"max":{"type":"integer","uniqueKey":"limit.max","typeLabel":"integer"},"plan":{"type":"string","uniqueKey":"limit.plan","typeLabel":"string"}},"uniqueKey":"limit","typeLabel":"object"},"errors":{"type":"array","description":"Validation failures (config_invalid, invalid_customer_targeting): one entry per problem.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"warnings":{"type":"array","description":"config_invalid only: the same non-fatal warnings a successful apply returns.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"warnings.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"},"unknown_customers":{"type":"array","description":"unknown_customers only: the submitted values that matched no customer in your organization.","items":{"type":"string","uniqueKey":"unknown_customers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"unknown_customers","typeLabel":"string[]"},"unknown_services":{"type":"array","description":"unknown_services only: the submitted `affected_services` values that matched no service in your organization.","items":{"oneOf":[{}],"uniqueKey":"unknown_services.items.[INDEX]","typeLabel":"any"},"uniqueKey":"unknown_services","typeLabel":"any[]"},"referenced_by":{"type":"object","description":"in_use only: what depends on the object (slos, pages: lists of { id, config_key, name }; subscribers: a count).","uniqueKey":"referenced_by","typeLabel":"object"},"quota":{"type":"object","description":"quota_exceeded / feature_locked on a create, item_suspended_plan on a write to a suspended item: the plan limit involved.","properties":{"capability":{"type":"string","uniqueKey":"quota.capability","typeLabel":"string"},"used":{"oneOf":[{"type":"integer","uniqueKey":"quota.used.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.used.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.used","typeLabel":"integer | null"},"cap":{"oneOf":[{"type":"integer","uniqueKey":"quota.cap.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.cap.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.cap","typeLabel":"integer | null"},"plan":{"oneOf":[{"type":"string","uniqueKey":"quota.plan.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quota.plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.plan","typeLabel":"string | null"}},"uniqueKey":"quota","typeLabel":"object"},"upgrade":{"type":"object","description":"Plan-limit problems only, when a higher plan lifts the limit: the smallest such plan and the pricing page.","properties":{"plan":{"type":"string","uniqueKey":"upgrade.plan","typeLabel":"string"},"label":{"type":"string","uniqueKey":"upgrade.label","typeLabel":"string"},"url":{"type":"string","format":"uri","uniqueKey":"upgrade.url","typeLabel":"string\u003curi>"}},"uniqueKey":"upgrade","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"}}},"exampleType":"generated"}},"exampleType":"generated"},"96be5bba-320c-4665-8247-4fd4357d5db8":{"description":"`forbidden`: the key does not carry the scope this endpoint requires. `plan_does_not_permit_api`: the organization's plan does not include the public API.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"example":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"},"properties":{"type":{"type":"string","format":"uri","description":"Errors reference URI with the title token as the fragment.","example":"https://docs.use.observer/api/getting-started/errors#forbidden","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Stable error token. Branch on this, not on detail.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation. Wording may change.","uniqueKey":"detail","typeLabel":"string"},"retry_after":{"type":"integer","description":"429 only: seconds until the exhausted window resets (mirrors Retry-After).","uniqueKey":"retry_after","typeLabel":"integer"},"limit":{"type":"object","description":"429 only: which organization limit was hit.","properties":{"scope":{"type":"string","enum":["organization"],"uniqueKey":"limit.scope","typeLabel":"enum\u003cstring>"},"window":{"type":"string","enum":["minute","day"],"uniqueKey":"limit.window","typeLabel":"enum\u003cstring>"},"max":{"type":"integer","uniqueKey":"limit.max","typeLabel":"integer"},"plan":{"type":"string","uniqueKey":"limit.plan","typeLabel":"string"}},"uniqueKey":"limit","typeLabel":"object"},"errors":{"type":"array","description":"Validation failures (config_invalid, invalid_customer_targeting): one entry per problem.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"warnings":{"type":"array","description":"config_invalid only: the same non-fatal warnings a successful apply returns.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"warnings.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"},"unknown_customers":{"type":"array","description":"unknown_customers only: the submitted values that matched no customer in your organization.","items":{"type":"string","uniqueKey":"unknown_customers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"unknown_customers","typeLabel":"string[]"},"unknown_services":{"type":"array","description":"unknown_services only: the submitted `affected_services` values that matched no service in your organization.","items":{"oneOf":[{}],"uniqueKey":"unknown_services.items.[INDEX]","typeLabel":"any"},"uniqueKey":"unknown_services","typeLabel":"any[]"},"referenced_by":{"type":"object","description":"in_use only: what depends on the object (slos, pages: lists of { id, config_key, name }; subscribers: a count).","uniqueKey":"referenced_by","typeLabel":"object"},"quota":{"type":"object","description":"quota_exceeded / feature_locked on a create, item_suspended_plan on a write to a suspended item: the plan limit involved.","properties":{"capability":{"type":"string","uniqueKey":"quota.capability","typeLabel":"string"},"used":{"oneOf":[{"type":"integer","uniqueKey":"quota.used.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.used.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.used","typeLabel":"integer | null"},"cap":{"oneOf":[{"type":"integer","uniqueKey":"quota.cap.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.cap.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.cap","typeLabel":"integer | null"},"plan":{"oneOf":[{"type":"string","uniqueKey":"quota.plan.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quota.plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.plan","typeLabel":"string | null"}},"uniqueKey":"quota","typeLabel":"object"},"upgrade":{"type":"object","description":"Plan-limit problems only, when a higher plan lifts the limit: the smallest such plan and the pricing page.","properties":{"plan":{"type":"string","uniqueKey":"upgrade.plan","typeLabel":"string"},"label":{"type":"string","uniqueKey":"upgrade.label","typeLabel":"string"},"url":{"type":"string","format":"uri","uniqueKey":"upgrade.url","typeLabel":"string\u003curi>"}},"uniqueKey":"upgrade","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"}}},"exampleType":"generated"}},"exampleType":"generated"},"06cccfa4-a092-40ce-8b17-66438e964b3f":{"description":"`not_found`: no incident with that id is available to this key. One owned by another organization, or an id that is not a valid UUID, returns the same response, so a 404 does not confirm that the id is unused.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"example":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"},"properties":{"type":{"type":"string","format":"uri","description":"Errors reference URI with the title token as the fragment.","example":"https://docs.use.observer/api/getting-started/errors#forbidden","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Stable error token. Branch on this, not on detail.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation. Wording may change.","uniqueKey":"detail","typeLabel":"string"},"retry_after":{"type":"integer","description":"429 only: seconds until the exhausted window resets (mirrors Retry-After).","uniqueKey":"retry_after","typeLabel":"integer"},"limit":{"type":"object","description":"429 only: which organization limit was hit.","properties":{"scope":{"type":"string","enum":["organization"],"uniqueKey":"limit.scope","typeLabel":"enum\u003cstring>"},"window":{"type":"string","enum":["minute","day"],"uniqueKey":"limit.window","typeLabel":"enum\u003cstring>"},"max":{"type":"integer","uniqueKey":"limit.max","typeLabel":"integer"},"plan":{"type":"string","uniqueKey":"limit.plan","typeLabel":"string"}},"uniqueKey":"limit","typeLabel":"object"},"errors":{"type":"array","description":"Validation failures (config_invalid, invalid_customer_targeting): one entry per problem.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"warnings":{"type":"array","description":"config_invalid only: the same non-fatal warnings a successful apply returns.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"warnings.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"},"unknown_customers":{"type":"array","description":"unknown_customers only: the submitted values that matched no customer in your organization.","items":{"type":"string","uniqueKey":"unknown_customers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"unknown_customers","typeLabel":"string[]"},"unknown_services":{"type":"array","description":"unknown_services only: the submitted `affected_services` values that matched no service in your organization.","items":{"oneOf":[{}],"uniqueKey":"unknown_services.items.[INDEX]","typeLabel":"any"},"uniqueKey":"unknown_services","typeLabel":"any[]"},"referenced_by":{"type":"object","description":"in_use only: what depends on the object (slos, pages: lists of { id, config_key, name }; subscribers: a count).","uniqueKey":"referenced_by","typeLabel":"object"},"quota":{"type":"object","description":"quota_exceeded / feature_locked on a create, item_suspended_plan on a write to a suspended item: the plan limit involved.","properties":{"capability":{"type":"string","uniqueKey":"quota.capability","typeLabel":"string"},"used":{"oneOf":[{"type":"integer","uniqueKey":"quota.used.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.used.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.used","typeLabel":"integer | null"},"cap":{"oneOf":[{"type":"integer","uniqueKey":"quota.cap.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.cap.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.cap","typeLabel":"integer | null"},"plan":{"oneOf":[{"type":"string","uniqueKey":"quota.plan.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quota.plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.plan","typeLabel":"string | null"}},"uniqueKey":"quota","typeLabel":"object"},"upgrade":{"type":"object","description":"Plan-limit problems only, when a higher plan lifts the limit: the smallest such plan and the pricing page.","properties":{"plan":{"type":"string","uniqueKey":"upgrade.plan","typeLabel":"string"},"label":{"type":"string","uniqueKey":"upgrade.label","typeLabel":"string"},"url":{"type":"string","format":"uri","uniqueKey":"upgrade.url","typeLabel":"string\u003curi>"}},"uniqueKey":"upgrade","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"}}},"exampleType":"generated"}},"exampleType":"generated"},"4e3e4a1a-ca44-48c0-885b-bdda4f37f296":{"description":"`already_resolved`: the incident is already resolved.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"example":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"},"properties":{"type":{"type":"string","format":"uri","description":"Errors reference URI with the title token as the fragment.","example":"https://docs.use.observer/api/getting-started/errors#forbidden","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Stable error token. Branch on this, not on detail.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation. Wording may change.","uniqueKey":"detail","typeLabel":"string"},"retry_after":{"type":"integer","description":"429 only: seconds until the exhausted window resets (mirrors Retry-After).","uniqueKey":"retry_after","typeLabel":"integer"},"limit":{"type":"object","description":"429 only: which organization limit was hit.","properties":{"scope":{"type":"string","enum":["organization"],"uniqueKey":"limit.scope","typeLabel":"enum\u003cstring>"},"window":{"type":"string","enum":["minute","day"],"uniqueKey":"limit.window","typeLabel":"enum\u003cstring>"},"max":{"type":"integer","uniqueKey":"limit.max","typeLabel":"integer"},"plan":{"type":"string","uniqueKey":"limit.plan","typeLabel":"string"}},"uniqueKey":"limit","typeLabel":"object"},"errors":{"type":"array","description":"Validation failures (config_invalid, invalid_customer_targeting): one entry per problem.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"warnings":{"type":"array","description":"config_invalid only: the same non-fatal warnings a successful apply returns.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"warnings.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"},"unknown_customers":{"type":"array","description":"unknown_customers only: the submitted values that matched no customer in your organization.","items":{"type":"string","uniqueKey":"unknown_customers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"unknown_customers","typeLabel":"string[]"},"unknown_services":{"type":"array","description":"unknown_services only: the submitted `affected_services` values that matched no service in your organization.","items":{"oneOf":[{}],"uniqueKey":"unknown_services.items.[INDEX]","typeLabel":"any"},"uniqueKey":"unknown_services","typeLabel":"any[]"},"referenced_by":{"type":"object","description":"in_use only: what depends on the object (slos, pages: lists of { id, config_key, name }; subscribers: a count).","uniqueKey":"referenced_by","typeLabel":"object"},"quota":{"type":"object","description":"quota_exceeded / feature_locked on a create, item_suspended_plan on a write to a suspended item: the plan limit involved.","properties":{"capability":{"type":"string","uniqueKey":"quota.capability","typeLabel":"string"},"used":{"oneOf":[{"type":"integer","uniqueKey":"quota.used.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.used.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.used","typeLabel":"integer | null"},"cap":{"oneOf":[{"type":"integer","uniqueKey":"quota.cap.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.cap.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.cap","typeLabel":"integer | null"},"plan":{"oneOf":[{"type":"string","uniqueKey":"quota.plan.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quota.plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.plan","typeLabel":"string | null"}},"uniqueKey":"quota","typeLabel":"object"},"upgrade":{"type":"object","description":"Plan-limit problems only, when a higher plan lifts the limit: the smallest such plan and the pricing page.","properties":{"plan":{"type":"string","uniqueKey":"upgrade.plan","typeLabel":"string"},"label":{"type":"string","uniqueKey":"upgrade.label","typeLabel":"string"},"url":{"type":"string","format":"uri","uniqueKey":"upgrade.url","typeLabel":"string\u003curi>"}},"uniqueKey":"upgrade","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"}}},"exampleType":"generated"}},"exampleType":"generated"},"7632829e-b376-4397-af69-f2a677096425":{"description":"`rate_limited`: the organization's per-minute or daily request limit is used up (`limit.window` says which). Limits are per organization, shared by every key. The response carries `Retry-After` and `retry_after`, in seconds.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"example":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"},"properties":{"type":{"type":"string","format":"uri","description":"Errors reference URI with the title token as the fragment.","example":"https://docs.use.observer/api/getting-started/errors#forbidden","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Stable error token. Branch on this, not on detail.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation. Wording may change.","uniqueKey":"detail","typeLabel":"string"},"retry_after":{"type":"integer","description":"429 only: seconds until the exhausted window resets (mirrors Retry-After).","uniqueKey":"retry_after","typeLabel":"integer"},"limit":{"type":"object","description":"429 only: which organization limit was hit.","properties":{"scope":{"type":"string","enum":["organization"],"uniqueKey":"limit.scope","typeLabel":"enum\u003cstring>"},"window":{"type":"string","enum":["minute","day"],"uniqueKey":"limit.window","typeLabel":"enum\u003cstring>"},"max":{"type":"integer","uniqueKey":"limit.max","typeLabel":"integer"},"plan":{"type":"string","uniqueKey":"limit.plan","typeLabel":"string"}},"uniqueKey":"limit","typeLabel":"object"},"errors":{"type":"array","description":"Validation failures (config_invalid, invalid_customer_targeting): one entry per problem.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"warnings":{"type":"array","description":"config_invalid only: the same non-fatal warnings a successful apply returns.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"warnings.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"},"unknown_customers":{"type":"array","description":"unknown_customers only: the submitted values that matched no customer in your organization.","items":{"type":"string","uniqueKey":"unknown_customers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"unknown_customers","typeLabel":"string[]"},"unknown_services":{"type":"array","description":"unknown_services only: the submitted `affected_services` values that matched no service in your organization.","items":{"oneOf":[{}],"uniqueKey":"unknown_services.items.[INDEX]","typeLabel":"any"},"uniqueKey":"unknown_services","typeLabel":"any[]"},"referenced_by":{"type":"object","description":"in_use only: what depends on the object (slos, pages: lists of { id, config_key, name }; subscribers: a count).","uniqueKey":"referenced_by","typeLabel":"object"},"quota":{"type":"object","description":"quota_exceeded / feature_locked on a create, item_suspended_plan on a write to a suspended item: the plan limit involved.","properties":{"capability":{"type":"string","uniqueKey":"quota.capability","typeLabel":"string"},"used":{"oneOf":[{"type":"integer","uniqueKey":"quota.used.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.used.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.used","typeLabel":"integer | null"},"cap":{"oneOf":[{"type":"integer","uniqueKey":"quota.cap.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.cap.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.cap","typeLabel":"integer | null"},"plan":{"oneOf":[{"type":"string","uniqueKey":"quota.plan.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quota.plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.plan","typeLabel":"string | null"}},"uniqueKey":"quota","typeLabel":"object"},"upgrade":{"type":"object","description":"Plan-limit problems only, when a higher plan lifts the limit: the smallest such plan and the pricing page.","properties":{"plan":{"type":"string","uniqueKey":"upgrade.plan","typeLabel":"string"},"label":{"type":"string","uniqueKey":"upgrade.label","typeLabel":"string"},"url":{"type":"string","format":"uri","uniqueKey":"upgrade.url","typeLabel":"string\u003curi>"}},"uniqueKey":"upgrade","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"429 only: seconds to wait before retrying.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed per minute for the organization.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the per-minute window resets.","schema":{"type":"integer"}},"X-RateLimit-Daily-Limit":{"description":"Requests allowed per UTC day for the organization.","schema":{"type":"integer"}},"X-RateLimit-Daily-Remaining":{"description":"Requests left today (UTC).","schema":{"type":"integer"}},"X-RateLimit-Daily-Reset":{"description":"Seconds until the daily quota resets (UTC midnight).","schema":{"type":"integer"}}},"exampleType":"generated"},"6a788114-366e-405f-828f-5bc3e5ba6259":{"description":"`internal_error`: an unhandled server error. Safe to retry.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"example":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"},"properties":{"type":{"type":"string","format":"uri","description":"Errors reference URI with the title token as the fragment.","example":"https://docs.use.observer/api/getting-started/errors#forbidden","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Stable error token. Branch on this, not on detail.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation. Wording may change.","uniqueKey":"detail","typeLabel":"string"},"retry_after":{"type":"integer","description":"429 only: seconds until the exhausted window resets (mirrors Retry-After).","uniqueKey":"retry_after","typeLabel":"integer"},"limit":{"type":"object","description":"429 only: which organization limit was hit.","properties":{"scope":{"type":"string","enum":["organization"],"uniqueKey":"limit.scope","typeLabel":"enum\u003cstring>"},"window":{"type":"string","enum":["minute","day"],"uniqueKey":"limit.window","typeLabel":"enum\u003cstring>"},"max":{"type":"integer","uniqueKey":"limit.max","typeLabel":"integer"},"plan":{"type":"string","uniqueKey":"limit.plan","typeLabel":"string"}},"uniqueKey":"limit","typeLabel":"object"},"errors":{"type":"array","description":"Validation failures (config_invalid, invalid_customer_targeting): one entry per problem.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"warnings":{"type":"array","description":"config_invalid only: the same non-fatal warnings a successful apply returns.","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"warnings.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"},"unknown_customers":{"type":"array","description":"unknown_customers only: the submitted values that matched no customer in your organization.","items":{"type":"string","uniqueKey":"unknown_customers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"unknown_customers","typeLabel":"string[]"},"unknown_services":{"type":"array","description":"unknown_services only: the submitted `affected_services` values that matched no service in your organization.","items":{"oneOf":[{}],"uniqueKey":"unknown_services.items.[INDEX]","typeLabel":"any"},"uniqueKey":"unknown_services","typeLabel":"any[]"},"referenced_by":{"type":"object","description":"in_use only: what depends on the object (slos, pages: lists of { id, config_key, name }; subscribers: a count).","uniqueKey":"referenced_by","typeLabel":"object"},"quota":{"type":"object","description":"quota_exceeded / feature_locked on a create, item_suspended_plan on a write to a suspended item: the plan limit involved.","properties":{"capability":{"type":"string","uniqueKey":"quota.capability","typeLabel":"string"},"used":{"oneOf":[{"type":"integer","uniqueKey":"quota.used.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.used.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.used","typeLabel":"integer | null"},"cap":{"oneOf":[{"type":"integer","uniqueKey":"quota.cap.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"quota.cap.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.cap","typeLabel":"integer | null"},"plan":{"oneOf":[{"type":"string","uniqueKey":"quota.plan.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quota.plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.plan","typeLabel":"string | null"}},"uniqueKey":"quota","typeLabel":"object"},"upgrade":{"type":"object","description":"Plan-limit problems only, when a higher plan lifts the limit: the smallest such plan and the pricing page.","properties":{"plan":{"type":"string","uniqueKey":"upgrade.plan","typeLabel":"string"},"label":{"type":"string","uniqueKey":"upgrade.label","typeLabel":"string"},"url":{"type":"string","format":"uri","uniqueKey":"upgrade.url","typeLabel":"string\u003curi>"}},"uniqueKey":"upgrade","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.use.observer/api/getting-started/errors#forbidden","title":"forbidden","status":403,"detail":"missing scope: write:incidents"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ed9d1931-bd96-46dd-a360-9dbb4c48e50f":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"obs_pub_","description":"An organization API key (obs_pub_…) sent as `Authorization: Bearer \u003ckey>`. Each key carries scopes; an endpoint lists the scope it needs. `read:change_events` is reserved: keys can carry it, but no endpoint needs it yet.","scopes":["write:incidents"],"schemeName":"bearerAuth"}}},"servers":{"b1a0327b-ef1d-4d9b-969a-1de22fe32269":{"url":"https://use.observer/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"obs_pub_","description":"An organization API key (obs_pub_…) sent as `Authorization: Bearer \u003ckey>`. Each key carries scopes; an endpoint lists the scope it needs. `read:change_events` is reserved: keys can carry it, but no endpoint needs it yet.","scopes":["write:incidents"],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An organization API key (obs_pub_…) sent as `Authorization: Bearer \u003ckey>`. Each key carries scopes; an endpoint lists the scope it needs. `read:change_events` is reserved: keys can carry it, but no endpoint needs it yet.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"observer-55c64b1d","siteName":"Observer Docs","title":"Observer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T21:37:07.011Z","originalFileLocation":"api/incidents/post-incidents-by-id-resolve.mdx"},"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=\"Observer documentation: install the agent, connect Prometheus, OpenTelemetry and probes, publish metric-driven status pages, track SLOs, and use the API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Observer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow, max-image-preview:large\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_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/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_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/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_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/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_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/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_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/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_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/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_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/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Observer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Install the agent, connect Prometheus, OpenTelemetry and probes, publish metric-driven status pages, track SLOs, and automate it all with the API and MCP.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Observer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://use.observer/opengraph-image\">\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=\"Observer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Agent install, probes, Prometheus and OpenTelemetry, status pages, SLOs, the REST API and MCP server for Observer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://use.observer/opengraph-image\">\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/observer-55c64b1d/9BgTWOEWvQwRvyeZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Observer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#35C68C\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_GB\">\u003cmeta data-mint-head name=\"application-name\" content=\"Observer Docs\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#0b0a0a\">\u003cmeta data-mint-head name=\"og:image:type\" content=\"image/png\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Observer: status pages that read your telemetry\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Observer: status pages that read your telemetry\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/incidents/post-incidents-by-id-resolve.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.use.observer/#organization\",\"name\":\"Observer Docs\",\"url\":\"https://docs.use.observer\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/observer-55c64b1d/EVAFfwwZSxUdEUoQ/logo/light.png?fit=max\u0026auto=format\u0026n=EVAFfwwZSxUdEUoQ\u0026q=85\u0026s=ac35eeffcfd53350cec867dd0b149925\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.use.observer#website\",\"name\":\"Observer Docs\",\"url\":\"https://docs.use.observer\",\"publisher\":{\"@id\":\"https://docs.use.observer/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve#webpage\",\"url\":\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve\",\"name\":\"Resolve an incident\",\"dateModified\":\"2026-11-07T21:37:07.011Z\",\"isPartOf\":{\"@id\":\"https://docs.use.observer#website\"},\"breadcrumb\":{\"@id\":\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Incidents\",\"item\":\"https://docs.use.observer/api/incidents/get-incidents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Resolve an incident\",\"item\":\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve#apireference\",\"headline\":\"Resolve an incident\",\"name\":\"Resolve an incident\",\"url\":\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve\",\"mainEntityOfPage\":{\"@id\":\"https://docs.use.observer/api/incidents/post-incidents-by-id-resolve#webpage\"},\"image\":\"https://use.observer/opengraph-image\",\"dateModified\":\"2026-11-07T21:37:07.011Z\",\"publisher\":{\"@id\":\"https://docs.use.observer/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.use.observer#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Observer Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Observer Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/incidents/post-incidents-by-id-resolve.md","siteName":"Observer Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book","pages":[{"title":"Documentation","href":"/docs/overview"}]},{"tab":"Observer Agent","icon":"server","pages":[{"title":"Observer Agent","href":"/agent/overview"}]},{"tab":"API","icon":"code","pages":[{"title":"API reference","sidebarTitle":"Overview","icon":"house","href":"/api/overview"},{"group":"Getting started","icon":"shield","pages":[{"title":"Authentication","href":"/api/getting-started/auth"},{"title":"Errors and status codes","href":"/api/getting-started/errors"},{"title":"Rate limits","href":"/api/getting-started/rate-limits"}]},{"group":"Account","icon":"user","pages":[{"title":"Get the calling key","openapi":"api-reference/openapi.json GET /me","href":"/api/account/get-me"}]},{"group":"Status pages","icon":"app-window","pages":[{"title":"List status pages","openapi":"api-reference/openapi.json GET /pages","href":"/api/pages/get-pages"},{"title":"Get a status page","openapi":"api-reference/openapi.json GET /pages/{id}","href":"/api/pages/get-pages-by-id"},{"title":"Change a status page's settings","openapi":"api-reference/openapi.json PATCH /pages/{id}","href":"/api/pages/patch-pages-by-id"},{"title":"Delete a status page","openapi":"api-reference/openapi.json DELETE /pages/{id}","href":"/api/pages/delete-pages-by-id"}]},{"group":"Services","icon":"layers","pages":[{"title":"List services","openapi":"api-reference/openapi.json GET /services","href":"/api/services/get-services"},{"title":"Get a service","openapi":"api-reference/openapi.json GET /services/{id}","href":"/api/services/get-services-by-id"},{"title":"Delete a service","openapi":"api-reference/openapi.json DELETE /services/{id}","href":"/api/services/delete-services-by-id"}]},{"group":"Metrics","icon":"trending-up","pages":[{"title":"List metrics","openapi":"api-reference/openapi.json GET /metrics","href":"/api/metrics/get-metrics"},{"title":"Create a hosted check","openapi":"api-reference/openapi.json POST /checks","href":"/api/metrics/post-checks"},{"title":"Get a metric","openapi":"api-reference/openapi.json GET /metrics/{id}","href":"/api/metrics/get-metrics-by-id"},{"title":"Delete a metric","openapi":"api-reference/openapi.json DELETE /metrics/{id}","href":"/api/metrics/delete-metrics-by-id"},{"title":"Get metric history","openapi":"api-reference/openapi.json GET /metrics/{id}/history","href":"/api/metrics/get-metrics-by-id-history"},{"title":"Set manual metric status","openapi":"api-reference/openapi.json POST /metrics/{id}/status","href":"/api/metrics/post-metrics-by-id-status"},{"title":"Get heartbeat state","openapi":"api-reference/openapi.json GET /metrics/{id}/heartbeat","href":"/api/metrics/get-metrics-by-id-heartbeat"},{"title":"Rotate heartbeat ping URL","openapi":"api-reference/openapi.json POST /metrics/{id}/heartbeat/rotate","href":"/api/metrics/post-metrics-by-id-heartbeat-rotate"},{"title":"Test a probe","openapi":"api-reference/openapi.json POST /metrics/test","href":"/api/metrics/post-metrics-test"},{"title":"Get a probe test result","openapi":"api-reference/openapi.json GET /metrics/test/{job_id}","href":"/api/metrics/get-metrics-test-by-jobId"}]},{"group":"SLOs","icon":"target","pages":[{"title":"List SLOs","openapi":"api-reference/openapi.json GET /slos","href":"/api/slos/get-slos"},{"title":"Get an SLO","openapi":"api-reference/openapi.json GET /slos/{id}","href":"/api/slos/get-slos-by-id"},{"title":"Delete an SLO","openapi":"api-reference/openapi.json DELETE /slos/{id}","href":"/api/slos/delete-slos-by-id"}]},{"group":"SLA statements","icon":"file-check","pages":[{"title":"List SLA statements","openapi":"api-reference/openapi.json GET /sla/statements","href":"/api/sla/get-sla-statements"},{"title":"Get an SLA statement","openapi":"api-reference/openapi.json GET /sla/statements/{id}","href":"/api/sla/get-sla-statements-by-id"}]},{"group":"Incidents","icon":"triangle-alert","pages":[{"title":"List incidents","openapi":"api-reference/openapi.json GET /incidents","href":"/api/incidents/get-incidents"},{"title":"Get an incident","openapi":"api-reference/openapi.json GET /incidents/{id}","href":"/api/incidents/get-incidents-by-id"},{"title":"Create an incident","openapi":"api-reference/openapi.json POST /incidents","href":"/api/incidents/post-incidents"},{"title":"Update an incident","openapi":"api-reference/openapi.json PATCH /incidents/{id}","href":"/api/incidents/patch-incidents-by-id"},{"title":"Publish an incident","openapi":"api-reference/openapi.json POST /incidents/{id}/publish","href":"/api/incidents/post-incidents-by-id-publish"},{"title":"Add an incident update","openapi":"api-reference/openapi.json POST /incidents/{id}/messages","description":null,"href":"/api/incidents/post-incidents-by-id-messages"},{"title":"Resolve an incident","openapi":"api-reference/openapi.json POST /incidents/{id}/resolve","href":"/api/incidents/post-incidents-by-id-resolve"},{"title":"Draft an incident from a metric","openapi":"api-reference/openapi.json POST /incidents/from-metric/{metricId}","description":"Creates an unpublished incident titled `Investigating: \u003cmetric title>` with an Investigating message. While that draft is unpublished, another call within 30 minutes returns it. When an unresolved incident created in the last hour affects a service with an SLO on this metric, that incident is returned instead.","href":"/api/incidents/post-incidents-from-metric-by-metricId"},{"title":"Delete an incident","openapi":"api-reference/openapi.json DELETE /incidents/{id}","href":"/api/incidents/delete-incidents-by-id"},{"title":"Get an incident's measured impact","openapi":"api-reference/openapi.json GET /incidents/{id}/impact","href":"/api/incidents/get-incidents-by-id-impact"},{"title":"Draft an incident update","openapi":"api-reference/openapi.json POST /incidents/{id}/draft","href":"/api/incidents/post-incidents-by-id-draft"},{"title":"List internal notes","openapi":"api-reference/openapi.json GET /incidents/{id}/notes","href":"/api/incidents/get-incidents-by-id-notes"},{"title":"Add an internal note","openapi":"api-reference/openapi.json POST /incidents/{id}/notes","href":"/api/incidents/post-incidents-by-id-notes"},{"title":"Export incident evidence","openapi":"api-reference/openapi.json GET /incidents/{id}/evidence","href":"/api/incidents/get-incidents-by-id-evidence"}]},{"group":"Maintenances","icon":"calendar","pages":[{"title":"List maintenance windows","openapi":"api-reference/openapi.json GET /maintenances","href":"/api/maintenances/get-maintenances"},{"title":"Get a maintenance window","openapi":"api-reference/openapi.json GET /maintenances/{id}","href":"/api/maintenances/get-maintenances-by-id"},{"title":"Schedule maintenance","openapi":"api-reference/openapi.json POST /maintenances","href":"/api/maintenances/post-maintenances"},{"title":"Update maintenance","openapi":"api-reference/openapi.json PATCH /maintenances/{id}","href":"/api/maintenances/patch-maintenances-by-id"},{"title":"Start maintenance","openapi":"api-reference/openapi.json POST /maintenances/{id}/start","href":"/api/maintenances/post-maintenances-by-id-start"},{"title":"Complete maintenance","openapi":"api-reference/openapi.json POST /maintenances/{id}/complete","href":"/api/maintenances/post-maintenances-by-id-complete"},{"title":"Cancel maintenance","openapi":"api-reference/openapi.json POST /maintenances/{id}/cancel","href":"/api/maintenances/post-maintenances-by-id-cancel"}]},{"group":"Config as code","icon":"settings","pages":[{"title":"Export config","openapi":"api-reference/openapi.json GET /config/export","href":"/api/config/get-config-export"},{"title":"Apply config","openapi":"api-reference/openapi.json POST /config/apply","href":"/api/config/post-config-apply"}]},{"group":"Agents","icon":"server","pages":[{"title":"List agents","openapi":"api-reference/openapi.json GET /agents","href":"/api/agents/get-agents"},{"title":"Get an agent","openapi":"api-reference/openapi.json GET /agents/{id}","href":"/api/agents/get-agents-by-id"},{"title":"Create an agent","openapi":"api-reference/openapi.json POST /agents","href":"/api/agents/post-agents"},{"title":"Rotate an agent key","openapi":"api-reference/openapi.json POST /agents/{id}/rotate-key","href":"/api/agents/post-agents-by-id-rotate-key"},{"title":"Delete an agent","openapi":"api-reference/openapi.json DELETE /agents/{id}","href":"/api/agents/delete-agents-by-id"}]},{"group":"Change events","icon":"git-branch","pages":[{"title":"Record a change event","openapi":"api-reference/openapi.json POST /change-events","href":"/api/change-events/post-change-events"}]},{"group":"Audit log","icon":"scroll-text","pages":[{"title":"List the audit log","openapi":"api-reference/openapi.json GET /audit-log","href":"/api/audit/get-audit-log"}]}],"groups":[{"group":"audit","pages":[{"title":"List the organization's audit log, newest first (Business and Enterprise)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /audit-log","href":"/api-reference/audit/list-the-organizations-audit-log-newest-first-business-and-enterprise"}]},{"group":"config","pages":[{"title":"Apply a config-as-code document (idempotent upsert by config_key)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /config/apply","href":"/api-reference/config/apply-a-config-as-code-document-idempotent-upsert-by-config_key"},{"title":"Export the org's config as a canonical apply document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /config/export","href":"/api-reference/config/export-the-orgs-config-as-a-canonical-apply-document"}]},{"group":"change-events","pages":[{"title":"Ingest a deploy / commit / release event for status-transition correlation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /change-events","href":"/api-reference/change-events/ingest-a-deploy-commit-release-event-for-status-transition-correlation"}]},{"group":"services","pages":[{"title":"List services","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /services","href":"/api-reference/services/list-services"},{"title":"Get service by id or key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /services/{id}","href":"/api-reference/services/get-service-by-id-or-key"},{"title":"Create or replace one service by its config key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /services/{id}","href":"/api-reference/services/create-or-replace-one-service-by-its-config-key"},{"title":"Delete a config-managed service by id or config_key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /services/{id}","href":"/api-reference/services/delete-a-config-managed-service-by-id-or-config_key"}]},{"group":"pages","pages":[{"title":"List status pages with their public URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pages","href":"/api-reference/pages/list-status-pages-with-their-public-url"},{"title":"Get a status page by id or key, with its metrics in display order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pages/{id}","href":"/api-reference/pages/get-a-status-page-by-id-or-key-with-its-metrics-in-display-order"},{"title":"Create or replace one status page by its config key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /pages/{id}","href":"/api-reference/pages/create-or-replace-one-status-page-by-its-config-key"},{"title":"Delete a config-managed page by id or config_key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /pages/{id}","href":"/api-reference/pages/delete-a-config-managed-page-by-id-or-config_key"},{"title":"Change a status page's settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /pages/{id}","href":"/api-reference/pages/change-a-status-pages-settings"}]},{"group":"account","pages":[{"title":"Who this API key is: organization, scopes, plan, quotas with usage, rate limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /me","href":"/api-reference/account/who-this-api-key-is:-organization-scopes-plan-quotas-with-usage-rate-limits"}]},{"group":"agents","pages":[{"title":"List Observer Agents and whether each is online","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-observer-agents-and-whether-each-is-online"},{"title":"Create an Observer Agent and get its key (shown once)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents","href":"/api-reference/agents/create-an-observer-agent-and-get-its-key-shown-once"},{"title":"Get an Observer Agent: status, whether it ever connected, heartbeats, metric count","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}","href":"/api-reference/agents/get-an-observer-agent:-status-whether-it-ever-connected-heartbeats-metric-count"},{"title":"Delete an Observer Agent (its key stops working; its metrics are kept, unassigned)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}","href":"/api-reference/agents/delete-an-observer-agent-its-key-stops-working;-its-metrics-are-kept-unassigned"},{"title":"Change an Observer Agent's name, description or Prometheus URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}","href":"/api-reference/agents/change-an-observer-agents-name-description-or-prometheus-url"},{"title":"Issue a new agent key (shown once)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/rotate-key","href":"/api-reference/agents/issue-a-new-agent-key-shown-once"}]},{"group":"metrics","pages":[{"title":"Watch a public website or API from Observer's own locations and put it on a public status page (experimental, nothing to install)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /checks","href":"/api-reference/metrics/watch-a-public-website-or-api-from-observers-own-locations-and-put-it-on-a-public-status-page-experimental-nothing-to-install"},{"title":"List metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /metrics","href":"/api-reference/metrics/list-metrics"},{"title":"Get metric by id or key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /metrics/{id}","href":"/api-reference/metrics/get-metric-by-id-or-key"},{"title":"Create or replace one metric by its config key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /metrics/{id}","href":"/api-reference/metrics/create-or-replace-one-metric-by-its-config-key"},{"title":"Delete a config-managed metric by id or config_key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /metrics/{id}","href":"/api-reference/metrics/delete-a-config-managed-metric-by-id-or-config_key"},{"title":"Run a draft probe once and return the value it measures, without creating a metric","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /metrics/test","href":"/api-reference/metrics/run-a-draft-probe-once-and-return-the-value-it-measures-without-creating-a-metric"},{"title":"Get the result of a probe test that was still running (POST /metrics/test returned 202)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /metrics/test/{job_id}","href":"/api-reference/metrics/get-the-result-of-a-probe-test-that-was-still-running-post-metricstest-returned-202"},{"title":"Aggregated metric values over a window (max 30 days)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /metrics/{id}/history","href":"/api-reference/metrics/aggregated-metric-values-over-a-window-max-30-days"},{"title":"Heartbeat schedule, state and recent pings (source_type heartbeat)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /metrics/{id}/heartbeat","href":"/api-reference/metrics/heartbeat-schedule-state-and-recent-pings-source_type-heartbeat"},{"title":"Issue a new heartbeat ping URL (the old one stops working)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /metrics/{id}/heartbeat/rotate","href":"/api-reference/metrics/issue-a-new-heartbeat-ping-url-the-old-one-stops-working"},{"title":"Set status on a manually-managed metric","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /metrics/{id}/status","href":"/api-reference/metrics/set-status-on-a-manually-managed-metric"}]},{"group":"slos","pages":[{"title":"List SLOs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /slos","href":"/api-reference/slos/list-slos"},{"title":"Get SLO by id or key, with latest burn event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /slos/{id}","href":"/api-reference/slos/get-slo-by-id-or-key-with-latest-burn-event"},{"title":"Create or replace one SLO by its config key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /slos/{id}","href":"/api-reference/slos/create-or-replace-one-slo-by-its-config-key"},{"title":"Delete a config-managed SLO by id or config_key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /slos/{id}","href":"/api-reference/slos/delete-a-config-managed-slo-by-id-or-config_key"}]},{"group":"sla","pages":[{"title":"List SLA Ledger statements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sla/statements","href":"/api-reference/sla/list-sla-ledger-statements"},{"title":"Get an SLA Ledger statement with its signed payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sla/statements/{id}","href":"/api-reference/sla/get-an-sla-ledger-statement-with-its-signed-payload"}]},{"group":"incidents","pages":[{"title":"List incidents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /incidents","href":"/api-reference/incidents/list-incidents"},{"title":"Create incident (draft or published)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /incidents","href":"/api-reference/incidents/create-incident-draft-or-published"},{"title":"Get incident","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /incidents/{id}","href":"/api-reference/incidents/get-incident"},{"title":"Soft-delete incident","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /incidents/{id}","href":"/api-reference/incidents/soft-delete-incident"},{"title":"Patch incident (title, severity, affected services, visibility, customer targeting)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /incidents/{id}","href":"/api-reference/incidents/patch-incident-title-severity-affected-services-visibility-customer-targeting"},{"title":"Publish a draft incident","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /incidents/{id}/publish","href":"/api-reference/incidents/publish-a-draft-incident"},{"title":"Resolve an incident with optional final message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /incidents/{id}/resolve","href":"/api-reference/incidents/resolve-an-incident-with-optional-final-message"},{"title":"Append a timeline message; type=Resolved auto-resolves the parent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /incidents/{id}/messages","href":"/api-reference/incidents/append-a-timeline-message;-type=resolved-auto-resolves-the-parent"},{"title":"Draft the next customer update with AI, plus the evidence appendix it was written against (never publishes)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /incidents/{id}/draft","href":"/api-reference/incidents/draft-the-next-customer-update-with-ai-plus-the-evidence-appendix-it-was-written-against-never-publishes"},{"title":"List an incident's internal notes, oldest first","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /incidents/{id}/notes","href":"/api-reference/incidents/list-an-incidents-internal-notes-oldest-first"},{"title":"Attach an internal note (e.g. findings from another tool) to an incident; never published","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /incidents/{id}/notes","href":"/api-reference/incidents/attach-an-internal-note-eg-findings-from-another-tool-to-an-incident;-never-published"},{"title":"Measured impact of an incident: window, affected services, checks and customers, SLO burn, related changes, observers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /incidents/{id}/impact","href":"/api-reference/incidents/measured-impact-of-an-incident:-window-affected-services-checks-and-customers-slo-burn-related-changes-observers"},{"title":"Signed incident evidence export (canonical JSON envelope, or PDF), verifiable on the public verify page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /incidents/{id}/evidence","href":"/api-reference/incidents/signed-incident-evidence-export-canonical-json-envelope-or-pdf-verifiable-on-the-public-verify-page"},{"title":"Pre-fill a draft incident from the metric's current state (idempotent within 30 minutes)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /incidents/from-metric/{metricId}","href":"/api-reference/incidents/pre-fill-a-draft-incident-from-the-metrics-current-state-idempotent-within-30-minutes"}]},{"group":"maintenances","pages":[{"title":"List maintenances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenances","href":"/api-reference/maintenances/list-maintenances"},{"title":"Schedule a maintenance window","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /maintenances","href":"/api-reference/maintenances/schedule-a-maintenance-window"},{"title":"Get maintenance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenances/{id}","href":"/api-reference/maintenances/get-maintenance"},{"title":"Edit maintenance (only allowed before actual_start_at is set)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /maintenances/{id}","href":"/api-reference/maintenances/edit-maintenance-only-allowed-before-actual_start_at-is-set"},{"title":"Manually transition a scheduled maintenance to in_progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /maintenances/{id}/start","href":"/api-reference/maintenances/manually-transition-a-scheduled-maintenance-to-in_progress"},{"title":"Manually transition an in-progress maintenance to completed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /maintenances/{id}/complete","href":"/api-reference/maintenances/manually-transition-an-in-progress-maintenance-to-completed"},{"title":"Cancel a maintenance before completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /maintenances/{id}/cancel","href":"/api-reference/maintenances/cancel-a-maintenance-before-completion"}]}]}]},"basePath":"","title":"Observer Docs","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CnLhKuUV.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}