From d4e72cb35b3c003bfe82b4b479e395405011c066 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 2 Sep 2026 14:03:40 +0000 Subject: [PATCH] chore: sync OpenAPI spec and refresh devhelm SDK --- docs/openapi/monitoring-api.json | 27440 ++++++++++++++++++----------- uv.lock | 2 +- 2 files changed, 17391 insertions(+), 10051 deletions(-) diff --git a/docs/openapi/monitoring-api.json b/docs/openapi/monitoring-api.json index 146f30f..8f075cc 100644 --- a/docs/openapi/monitoring-api.json +++ b/docs/openapi/monitoring-api.json @@ -38,6 +38,10 @@ "name": "API Keys", "description": "Organization API key management" }, + { + "name": "Artifacts", + "description": "Run evidence file content" + }, { "name": "Audit Log", "description": "Organization audit trail" @@ -50,6 +54,10 @@ "name": "Dashboard", "description": "Overview dashboard aggregates" }, + { + "name": "Definitions", + "description": "Code-monitor definition catalog and revisions" + }, { "name": "Deploy Lock", "description": "Mutex for CLI deploy operations" @@ -102,6 +110,22 @@ "name": "Monitor Auth", "description": "Manage authentication configuration for a monitor" }, + { + "name": "Monitor definitions", + "description": "Publish, rollback, and revision history for code monitors" + }, + { + "name": "Monitor Runs", + "description": "Per-monitor code run history and run-now" + }, + { + "name": "Monitor secret requests", + "description": "Secret keys a monitor requires and how they are fulfilled" + }, + { + "name": "Monitor session", + "description": "Cached sign-in session for a monitor" + }, { "name": "Monitors", "description": "Monitor CRUD and lifecycle management" @@ -126,6 +150,14 @@ "name": "Resource Groups", "description": "Resource group CRUD and member management" }, + { + "name": "Revisions", + "description": "Definition revision packages" + }, + { + "name": "Runs", + "description": "Code-monitor run list, snapshot, cases, events, and cancel" + }, { "name": "Secrets", "description": "Organization environment secret management" @@ -2123,13 +2155,122 @@ } } }, + "/api/v1/artifacts/{id}/content": { + "get": { + "tags": [ + "Artifacts" + ], + "summary": "Redirect to signed artifact download", + "description": "Returns 302 Location with a signed GET URL. 410 after the 14-day file clock.", + "operationId": "getArtifactContent", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "302": { + "description": "Signed download Location" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "410": { + "description": "Artifact bytes expired" + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, "/api/v1/audit-log": { "get": { "tags": [ "Audit Log" ], "summary": "List audit events for the current organization", - "operationId": "list_20", + "operationId": "list_22", "parameters": [ { "name": "action", @@ -2606,21 +2747,20 @@ } } }, - "/api/v1/deploy/lock": { + "/api/v1/definitions": { "get": { "tags": [ - "Deploy Lock" + "Definitions" ], - "summary": "Get current deploy lock", - "description": "Returns the active deploy lock for the current workspace, if any.", - "operationId": "current", + "summary": "List definitions", + "operationId": "list_21", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseDeployLockDto" + "$ref": "#/components/schemas/TableValueResultDefinitionDto" } } } @@ -2706,31 +2846,145 @@ } } } - }, - "post": { + } + }, + "/api/v1/definitions/{id}": { + "get": { "tags": [ - "Deploy Lock" + "Definitions" ], - "summary": "Acquire deploy lock", - "description": "Acquires an exclusive deploy lock for the current workspace. Returns 409 Conflict if the workspace is already locked by another session.", - "operationId": "acquire", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AcquireDeployLockRequest" + "summary": "Get definition with Heads", + "operationId": "get_13", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseDefinitionDetailDto" + } } } }, - "required": true - }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/definitions/{id}/revisions": { + "get": { + "tags": [ + "Definitions" + ], + "summary": "List all revisions for a definition", + "operationId": "listRevisions_1", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseDeployLockDto" + "$ref": "#/components/schemas/TableValueResultRevisionDto" } } } @@ -2818,28 +3072,134 @@ } } }, - "/api/v1/deploy/lock/{lockId}": { - "delete": { + "/api/v1/deploy/lock": { + "get": { "tags": [ "Deploy Lock" ], - "summary": "Release deploy lock", - "description": "Releases a deploy lock by ID. Only the lock holder should call this.", - "operationId": "release", - "parameters": [ - { - "name": "lockId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Get current deploy lock", + "description": "Returns the active deploy lock for the current workspace, if any.", + "operationId": "current", + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseDeployLockDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } } } + } + }, + "post": { + "tags": [ + "Deploy Lock" ], + "summary": "Acquire deploy lock", + "description": "Acquires an exclusive deploy lock for the current workspace. Returns 409 Conflict if the workspace is already locked by another session.", + "operationId": "acquire", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AcquireDeployLockRequest" + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "No Content" + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseDeployLockDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -2924,14 +3284,25 @@ } } }, - "/api/v1/deploy/lock/force": { + "/api/v1/deploy/lock/{lockId}": { "delete": { "tags": [ "Deploy Lock" ], - "summary": "Force-release deploy lock", - "description": "Forcibly removes any deploy lock on the current workspace. Use to break stale locks.", - "operationId": "forceRelease", + "summary": "Release deploy lock", + "description": "Releases a deploy lock by ID. Only the lock holder should call this.", + "operationId": "release", + "parameters": [ + { + "name": "lockId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "responses": { "204": { "description": "No Content" @@ -3019,23 +3390,17 @@ } } }, - "/api/v1/environments": { - "get": { + "/api/v1/deploy/lock/force": { + "delete": { "tags": [ - "Environments" + "Deploy Lock" ], - "summary": "List environments", - "operationId": "list_12", + "summary": "Force-release deploy lock", + "description": "Forcibly removes any deploy lock on the current workspace. Use to break stale locks.", + "operationId": "forceRelease", "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TableValueResultEnvironmentDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -3118,30 +3483,22 @@ } } } - }, - "post": { + } + }, + "/api/v1/environments": { + "get": { "tags": [ "Environments" ], - "summary": "Create environment", - "operationId": "create_13", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateEnvironmentRequest" - } - } - }, - "required": true - }, + "summary": "List environments", + "operationId": "list_12", "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseEnvironmentDto" + "$ref": "#/components/schemas/TableValueResultEnvironmentDto" } } } @@ -3227,28 +3584,26 @@ } } } - } - }, - "/api/v1/environments/{slug}": { - "get": { + }, + "post": { "tags": [ "Environments" ], - "summary": "Get environment by slug", - "operationId": "get_7", - "parameters": [ - { - "name": "slug", - "in": "path", - "required": true, - "schema": { - "type": "string" + "summary": "Create environment", + "operationId": "create_13", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateEnvironmentRequest" + } } - } - ], + }, + "required": true + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { @@ -3338,13 +3693,15 @@ } } } - }, - "put": { + } + }, + "/api/v1/environments/{slug}": { + "get": { "tags": [ "Environments" ], - "summary": "Update environment", - "operationId": "update_13", + "summary": "Get environment by slug", + "operationId": "get_7", "parameters": [ { "name": "slug", @@ -3355,16 +3712,6 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateEnvironmentRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", @@ -3458,12 +3805,12 @@ } } }, - "delete": { + "put": { "tags": [ "Environments" ], - "summary": "Delete environment", - "operationId": "delete_9", + "summary": "Update environment", + "operationId": "update_13", "parameters": [ { "name": "slug", @@ -3474,9 +3821,26 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateEnvironmentRequest" + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseEnvironmentDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -3559,37 +3923,26 @@ } } } - } - }, - "/api/v1/forensics/incidents/{id}/timeline": { - "get": { + }, + "delete": { "tags": [ - "Forensics" + "Environments" ], - "summary": "Full forensic timeline for an incident", - "description": "Returns every state-machine transition for this incident plus the rule evaluations that caused each transition, plus the policy snapshot that triggered confirmation. Correlate evaluations to transitions via evaluation.triggeringTransitionId == transition.id.", - "operationId": "getTimeline", + "summary": "Delete environment", + "operationId": "delete_9", "parameters": [ { - "name": "id", + "name": "slug", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseIncidentTimelineDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -3674,14 +4027,14 @@ } } }, - "/api/v1/forensics/monitors/{id}/rule-evaluations": { + "/api/v1/forensics/incidents/{id}/timeline": { "get": { "tags": [ "Forensics" ], - "summary": "Paged list of rule evaluations for a monitor", - "description": "Filter by ruleType (e.g. consecutive_failures), region, onlyMatched=true to narrow to firing evaluations. Time window defaults to the last 7 days when from/to are omitted; windows wider than 30 days are clamped.", - "operationId": "listMonitorRuleEvaluations", + "summary": "Full forensic timeline for an incident", + "description": "Returns every state-machine transition for this incident plus the rule evaluations that caused each transition, plus the policy snapshot that triggered confirmation. Correlate evaluations to transitions via evaluation.triggeringTransitionId == transition.id.", + "operationId": "getTimeline", "parameters": [ { "name": "id", @@ -3691,56 +4044,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "ruleType", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "region", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "onlyMatched", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "to", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "pageable", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/Pageable" - } } ], "responses": { @@ -3749,7 +4052,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultRuleEvaluationDto" + "$ref": "#/components/schemas/SingleValueResponseIncidentTimelineDto" } } } @@ -3837,14 +4140,14 @@ } } }, - "/api/v1/forensics/monitors/{id}/transitions": { + "/api/v1/forensics/monitors/{id}/rule-evaluations": { "get": { "tags": [ "Forensics" ], - "summary": "Paged list of state transitions for a monitor", - "description": "Time window defaults to the last 30 days when from/to are omitted; windows wider than 90 days are clamped.", - "operationId": "listMonitorTransitions", + "summary": "Paged list of rule evaluations for a monitor", + "description": "Filter by ruleType (e.g. consecutive_failures), region, onlyMatched=true to narrow to firing evaluations. Time window defaults to the last 7 days when from/to are omitted; windows wider than 30 days are clamped.", + "operationId": "listMonitorRuleEvaluations", "parameters": [ { "name": "id", @@ -3855,6 +4158,30 @@ "format": "uuid" } }, + { + "name": "ruleType", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "onlyMatched", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, { "name": "from", "in": "query", @@ -3888,7 +4215,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultIncidentStateTransitionDto" + "$ref": "#/components/schemas/TableValueResultRuleEvaluationDto" } } } @@ -3976,134 +4303,48 @@ } } }, - "/api/v1/forensics/policy-snapshots/{hashHex}": { + "/api/v1/forensics/monitors/{id}/transitions": { "get": { "tags": [ "Forensics" ], - "summary": "Fetch a policy snapshot by its content hash", - "description": "Hash is SHA-256 over canonical policy JSON, hex-encoded. Access is gated: caller's org must have evaluated against this hash at least once.", - "operationId": "getPolicySnapshot", + "summary": "Paged list of state transitions for a monitor", + "description": "Time window defaults to the last 30 days when from/to are omitted; windows wider than 90 days are clamped.", + "operationId": "listMonitorTransitions", "parameters": [ { - "name": "hashHex", + "name": "id", "in": "path", "required": true, "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponsePolicySnapshotDto" - } - } - } - }, - "400": { - "description": "Bad request — the payload failed validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden — the actor lacks permission for this resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found — the requested resource does not exist", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Conflict — the request collides with current resource state", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "type": "string", + "format": "uuid" } }, - "500": { - "description": "Internal server error — see the message field for details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + { + "name": "from", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" } }, - "502": { - "description": "Bad gateway — an upstream provider returned an error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + { + "name": "to", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" } }, - "503": { - "description": "Service unavailable — try again shortly", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/api/v1/forensics/traces/{checkId}": { - "get": { - "tags": [ - "Forensics" - ], - "summary": "Replay a single check execution", - "description": "Returns every rule evaluation and state transition emitted for this scheduler-minted check_id (V92), plus the policy snapshot that governed them.", - "operationId": "getTrace", - "parameters": [ { - "name": "checkId", - "in": "path", + "name": "pageable", + "in": "query", "required": true, "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/Pageable" } } ], @@ -4113,7 +4354,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseCheckTraceDto" + "$ref": "#/components/schemas/TableValueResultIncidentStateTransitionDto" } } } @@ -4201,19 +4442,18 @@ } } }, - "/api/v1/heartbeat/{token}": { + "/api/v1/forensics/policy-snapshots/{hashHex}": { "get": { "tags": [ - "Heartbeat" + "Forensics" ], - "summary": "Record a heartbeat ping (GET)", - "description": "Called by external systems (cron jobs, scheduled tasks) to signal liveness. Always returns 200 OK.", - "operationId": "pingGet", + "summary": "Fetch a policy snapshot by its content hash", + "description": "Hash is SHA-256 over canonical policy JSON, hex-encoded. Access is gated: caller's org must have evaluated against this hash at least once.", + "operationId": "getPolicySnapshot", "parameters": [ { - "name": "token", + "name": "hashHex", "in": "path", - "description": "Ping endpoint token for the heartbeat monitor", "required": true, "schema": { "type": "string" @@ -4226,7 +4466,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/HeartbeatPingResponse" + "$ref": "#/components/schemas/SingleValueResponsePolicySnapshotDto" } } } @@ -4312,51 +4552,34 @@ } } } - }, - "post": { + } + }, + "/api/v1/forensics/traces/{checkId}": { + "get": { "tags": [ - "Heartbeat" + "Forensics" ], - "summary": "Record a heartbeat ping (POST)", - "description": "Called by external systems to signal liveness with an optional JSON payload. The payload can be inspected by heartbeat_payload_contains assertions. Always returns 200 OK.", - "operationId": "pingPost", + "summary": "Replay a single check execution", + "description": "Returns every rule evaluation and state transition emitted for this scheduler-minted check_id (V92), plus the policy snapshot that governed them.", + "operationId": "getTrace", "parameters": [ { - "name": "token", + "name": "checkId", "in": "path", - "description": "Ping endpoint token for the heartbeat monitor", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "string" - } - }, - "text/plain": { - "schema": { - "type": "string" - } - }, - "*/*": { - "schema": { - "type": "string" - } - } - } - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/HeartbeatPingResponse" + "$ref": "#/components/schemas/SingleValueResponseCheckTraceDto" } } } @@ -4444,20 +4667,22 @@ } } }, - "/api/v1/incidents": { + "/api/v1/heartbeat/{token}": { "get": { "tags": [ - "Incidents" + "Heartbeat" ], - "summary": "List incidents for the authenticated org", - "operationId": "list_11", + "summary": "Record a heartbeat ping (GET)", + "description": "Called by external systems (cron jobs, scheduled tasks) to signal liveness. Always returns 200 OK.", + "operationId": "pingGet", "parameters": [ { - "name": "params", - "in": "query", + "name": "token", + "in": "path", + "description": "Ping endpoint token for the heartbeat monitor", "required": true, "schema": { - "$ref": "#/components/schemas/IncidentFilterParams" + "type": "string" } } ], @@ -4467,7 +4692,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultIncidentDto" + "$ref": "#/components/schemas/HeartbeatPingResponse" } } } @@ -4556,27 +4781,48 @@ }, "post": { "tags": [ - "Incidents" + "Heartbeat" + ], + "summary": "Record a heartbeat ping (POST)", + "description": "Called by external systems to signal liveness with an optional JSON payload. The payload can be inspected by heartbeat_payload_contains assertions. Always returns 200 OK.", + "operationId": "pingPost", + "parameters": [ + { + "name": "token", + "in": "path", + "description": "Ping endpoint token for the heartbeat monitor", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Create a manual incident", - "operationId": "create_12", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateManualIncidentRequest" + "type": "string" + } + }, + "text/plain": { + "schema": { + "type": "string" + } + }, + "*/*": { + "schema": { + "type": "string" } } - }, - "required": true + } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseIncidentDetailDto" + "$ref": "#/components/schemas/HeartbeatPingResponse" } } } @@ -4664,22 +4910,20 @@ } } }, - "/api/v1/incidents/{id}": { + "/api/v1/incidents": { "get": { "tags": [ "Incidents" ], - "summary": "Get incident details including update timeline", - "description": "Shell payload: incident row, updates, and linked status-page incidents. Trigger enrichment (forensics / check_results) is GET /{id}/trigger so first paint is not blocked on hypertable reads.", - "operationId": "get_9", + "summary": "List incidents for the authenticated org", + "operationId": "list_11", "parameters": [ { - "name": "id", - "in": "path", + "name": "params", + "in": "query", "required": true, "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/IncidentFilterParams" } } ], @@ -4689,7 +4933,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseIncidentDetailDto" + "$ref": "#/components/schemas/TableValueResultIncidentDto" } } } @@ -4776,12 +5020,124 @@ } } }, - "patch": { + "post": { "tags": [ "Incidents" ], - "summary": "Update incident title and/or severity", - "operationId": "update_15", + "summary": "Create a manual incident", + "operationId": "create_12", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateManualIncidentRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseIncidentDetailDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/incidents/{id}": { + "get": { + "tags": [ + "Incidents" + ], + "summary": "Get incident details including update timeline", + "description": "Shell payload: incident row, updates, and linked status-page incidents. Trigger enrichment (forensics / check_results) is GET /{id}/trigger so first paint is not blocked on hypertable reads.", + "operationId": "get_9", "parameters": [ { "name": "id", @@ -4793,16 +5149,126 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateIncidentRequest" - } - } - }, - "required": true - }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseIncidentDetailDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "patch": { + "tags": [ + "Incidents" + ], + "summary": "Update incident title and/or severity", + "operationId": "update_15", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateIncidentRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", @@ -5637,7 +6103,7 @@ ], "summary": "List all supported integration types", "description": "Returns the full static catalog of supported alert channel integration types with their metadata and config field schemas. Used by the frontend to dynamically render the 'Add Alert Channel' form.", - "operationId": "list_19", + "operationId": "list_20", "responses": { "200": { "description": "OK", @@ -6835,7 +7301,7 @@ "Members" ], "summary": "List organization members", - "operationId": "list_18", + "operationId": "list_19", "parameters": [ { "name": "pageable", @@ -7921,13 +8387,13 @@ } } }, - "/api/v1/monitors/{id}/pause": { + "/api/v1/monitors/{id}/mute": { "post": { "tags": [ "Monitors" ], - "summary": "Pause a monitor (set enabled=false)", - "operationId": "pause", + "summary": "Mute alert delivery without flipping enabled", + "operationId": "mute", "parameters": [ { "name": "id", @@ -7939,6 +8405,15 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MonitorOverlayRequest" + } + } + } + }, "responses": { "200": { "description": "OK", @@ -8033,14 +8508,13 @@ } } }, - "/api/v1/monitors/{id}/results": { - "get": { + "/api/v1/monitors/{id}/pause": { + "post": { "tags": [ - "Check Results" + "Monitors" ], - "summary": "List raw check results", - "description": "Returns check results for the given monitor with optional time-range, region, and pass/fail filtering. Uses cursor-based pagination — pass the returned `cursor` value on subsequent requests to retrieve the next page. The cursor encodes the original time bounds, so `from`/`to` are ignored when a cursor is present.", - "operationId": "getResults", + "summary": "Pause a monitor", + "operationId": "pause", "parameters": [ { "name": "id", @@ -8050,84 +8524,34 @@ "type": "string", "format": "uuid" } - }, - { - "name": "from", - "in": "query", - "description": "Start of time range (ISO 8601, inclusive); defaults to 24 hours ago", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "to", - "in": "query", - "description": "End of time range (ISO 8601, inclusive); defaults to now", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "cursor", - "in": "query", - "description": "Opaque cursor from a previous response for pagination", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Maximum results per page (1–200)", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 50 - }, - "example": 50 - }, - { - "name": "region", - "in": "query", - "description": "Filter by region (e.g. us-east)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "passed", - "in": "query", - "description": "Filter by pass/fail status", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MonitorOverlayRequest" + } + } + } + }, "responses": { "200": { - "description": "Paginated check results", + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/CursorPageCheckResultDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorDto" } } } }, "400": { - "description": "Invalid query parameters", + "description": "Bad request — the payload failed validation", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/CursorPageCheckResultDto" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -8143,21 +8567,21 @@ } }, "403": { - "description": "Monitor does not belong to the caller's org", + "description": "Forbidden — the actor lacks permission for this resource", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/CursorPageCheckResultDto" + "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { - "description": "Monitor not found", + "description": "Not found — the requested resource does not exist", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/CursorPageCheckResultDto" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -8205,14 +8629,14 @@ } } }, - "/api/v1/monitors/{id}/results/summary": { - "get": { + "/api/v1/monitors/{id}/publish": { + "post": { "tags": [ - "Check Results" + "Monitor definitions" ], - "summary": "Get results summary", - "description": "Returns a dashboard summary for the monitor: current status derived from the latest result per region, time-bucketed chart data, the 24-hour uptime percentage, and the selected window's uptime percentage.", - "operationId": "getSummary", + "summary": "Publish a revision as Head for this monitor's environment", + "description": "Retargets the shared Head for (definition, environment). Does not clone package bytes.", + "operationId": "publish", "parameters": [ { "name": "id", @@ -8222,40 +8646,35 @@ "type": "string", "format": "uuid" } - }, - { - "name": "chartWindow", - "in": "query", - "description": "Chart window: 24h returns hourly buckets, 7d/30d/90d return daily buckets", - "required": false, - "schema": { - "type": "string", - "enum": [ - "24h", - "7d", - "30d", - "90d" - ] - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublishRevisionRequest" + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Results summary", + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/ResultSummaryDto" + "$ref": "#/components/schemas/SingleValueResponseDefinitionHeadDto" } } } }, "400": { - "description": "Invalid chartWindow parameter", + "description": "Bad request — the payload failed validation", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseResultSummaryDto" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -8271,21 +8690,21 @@ } }, "403": { - "description": "Monitor does not belong to the caller's org", + "description": "Forbidden — the actor lacks permission for this resource", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseResultSummaryDto" + "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { - "description": "Monitor not found", + "description": "Not found — the requested resource does not exist", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseResultSummaryDto" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -8333,13 +8752,13 @@ } } }, - "/api/v1/monitors/{id}/resume": { + "/api/v1/monitors/{id}/quarantine": { "post": { "tags": [ "Monitors" ], - "summary": "Resume a monitor (set enabled=true)", - "operationId": "resume", + "summary": "Quarantine a monitor", + "operationId": "quarantine", "parameters": [ { "name": "id", @@ -8351,6 +8770,16 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuarantineMonitorRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", @@ -8445,14 +8874,13 @@ } } }, - "/api/v1/monitors/{id}/rotate-token": { + "/api/v1/monitors/{id}/release-quarantine": { "post": { "tags": [ "Monitors" ], - "summary": "Rotate the ping token for a heartbeat monitor", - "description": "Generates a new ping token. The old token remains valid for 24 hours to allow cron jobs to be updated without downtime. Only supported for HEARTBEAT monitors.", - "operationId": "rotateToken", + "summary": "Release quarantine", + "operationId": "releaseQuarantine", "parameters": [ { "name": "id", @@ -8558,14 +8986,14 @@ } } }, - "/api/v1/monitors/{id}/status-pages": { + "/api/v1/monitors/{id}/results": { "get": { "tags": [ - "Monitors" + "Check Results" ], - "summary": "List status pages that contain this monitor as a component", - "description": "Returns all status pages where this monitor appears as a component, enabling the detail page to show 'Appears On' cross-links.", - "operationId": "listStatusPagesForMonitor", + "summary": "List raw check results", + "description": "Returns check results for the given monitor with optional time-range, region, and pass/fail filtering. Uses cursor-based pagination — pass the returned `cursor` value on subsequent requests to retrieve the next page. The cursor encodes the original time bounds, so `from`/`to` are ignored when a cursor is present.", + "operationId": "getResults", "parameters": [ { "name": "id", @@ -8575,25 +9003,84 @@ "type": "string", "format": "uuid" } + }, + { + "name": "from", + "in": "query", + "description": "Start of time range (ISO 8601, inclusive); defaults to 24 hours ago", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "to", + "in": "query", + "description": "End of time range (ISO 8601, inclusive); defaults to now", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "cursor", + "in": "query", + "description": "Opaque cursor from a previous response for pagination", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Maximum results per page (1–200)", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 50 + }, + "example": 50 + }, + { + "name": "region", + "in": "query", + "description": "Filter by region (e.g. us-east)", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "passed", + "in": "query", + "description": "Filter by pass/fail status", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { "200": { - "description": "OK", + "description": "Paginated check results", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageDto" + "$ref": "#/components/schemas/CursorPageCheckResultDto" } } } }, "400": { - "description": "Bad request — the payload failed validation", + "description": "Invalid query parameters", "content": { - "application/json": { + "*/*": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CursorPageCheckResultDto" } } } @@ -8609,7 +9096,27 @@ } }, "403": { - "description": "Forbidden — the actor lacks permission for this resource", + "description": "Monitor does not belong to the caller's org", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CursorPageCheckResultDto" + } + } + } + }, + "404": { + "description": "Monitor not found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CursorPageCheckResultDto" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", "content": { "application/json": { "schema": { @@ -8618,8 +9125,96 @@ } } }, - "404": { - "description": "Not found — the requested resource does not exist", + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/monitors/{id}/results/summary": { + "get": { + "tags": [ + "Check Results" + ], + "summary": "Get results summary", + "description": "Returns a dashboard summary for the monitor: current status derived from the latest result per region, time-bucketed chart data, the 24-hour uptime percentage, and the selected window's uptime percentage.", + "operationId": "getSummary", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "chartWindow", + "in": "query", + "description": "Chart window: 24h returns hourly buckets, 7d/30d/90d return daily buckets", + "required": false, + "schema": { + "type": "string", + "enum": [ + "24h", + "7d", + "30d", + "90d" + ] + } + } + ], + "responses": { + "200": { + "description": "Results summary", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResultSummaryDto" + } + } + } + }, + "400": { + "description": "Invalid chartWindow parameter", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseResultSummaryDto" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", "content": { "application/json": { "schema": { @@ -8628,6 +9223,26 @@ } } }, + "403": { + "description": "Monitor does not belong to the caller's org", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseResultSummaryDto" + } + } + } + }, + "404": { + "description": "Monitor not found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseResultSummaryDto" + } + } + } + }, "409": { "description": "Conflict — the request collides with current resource state", "content": { @@ -8671,13 +9286,13 @@ } } }, - "/api/v1/monitors/{id}/tags": { - "get": { + "/api/v1/monitors/{id}/resume": { + "post": { "tags": [ "Monitors" ], - "summary": "Get all tags applied to a monitor", - "operationId": "getMonitorTags", + "summary": "Resume a paused monitor", + "operationId": "resume", "parameters": [ { "name": "id", @@ -8695,7 +9310,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultTagDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorDto" } } } @@ -8781,13 +9396,16 @@ } } } - }, - "post": { + } + }, + "/api/v1/monitors/{id}/revisions": { + "get": { "tags": [ - "Monitors" + "Monitor definitions" ], - "summary": "Add tags to a monitor; supports existing tag IDs and inline creation of new tags", - "operationId": "addMonitorTags", + "summary": "List revisions published in this monitor's environment", + "description": "Omits drafts never published here. Page size default 25.", + "operationId": "listRevisions", "parameters": [ { "name": "id", @@ -8797,25 +9415,23 @@ "type": "string", "format": "uuid" } + }, + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddMonitorTagsRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultTagDto" + "$ref": "#/components/schemas/TableValueResultRevisionDto" } } } @@ -8901,13 +9517,138 @@ } } } - }, - "delete": { + } + }, + "/api/v1/monitors/{id}/revisions/{revisionId}/test": { + "post": { "tags": [ - "Monitors" + "Monitor definitions" ], - "summary": "Remove tags from a monitor by their IDs", - "operationId": "removeMonitorTags", + "summary": "Run remote validation against a revision without moving Head", + "description": "Creates a Run with source=remote_validation. Does not signal.", + "operationId": "testRevision", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "revisionId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseRunDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/monitors/{id}/rollback": { + "post": { + "tags": [ + "Monitor definitions" + ], + "summary": "Roll back Head to a prior revision", + "description": "Same Head UPDATE as publish; stores reason on the Head.", + "operationId": "rollback", "parameters": [ { "name": "id", @@ -8923,15 +9664,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RemoveMonitorTagsRequest" + "$ref": "#/components/schemas/RollbackRevisionRequest" } } }, "required": true }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseDefinitionHeadDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -9016,14 +9764,13 @@ } } }, - "/api/v1/monitors/{id}/test": { - "post": { + "/api/v1/monitors/{id}/rollback-preview": { + "get": { "tags": [ - "Monitors" + "Monitor definitions" ], - "summary": "Test an existing monitor", - "description": "Runs the saved config and assertions of an existing monitor once, without persisting any result. Runs synchronously and returns the same shape as the ad-hoc test. MULTI_STEP_API and BROWSER are rejected with MONITOR_CODE_CHECK_TEST_UNAVAILABLE until fleet dry-run is available.", - "operationId": "testExisting", + "summary": "Preview rollback consequences for this environment", + "operationId": "rollbackPreview", "parameters": [ { "name": "id", @@ -9033,6 +9780,15 @@ "type": "string", "format": "uuid" } + }, + { + "name": "revisionId", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -9041,7 +9797,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseMonitorTestResultDto" + "$ref": "#/components/schemas/SingleValueResponseRollbackPreviewDto" } } } @@ -9129,14 +9885,14 @@ } } }, - "/api/v1/monitors/{id}/test-notifications": { + "/api/v1/monitors/{id}/rotate-token": { "post": { "tags": [ "Monitors" ], - "summary": "Send test notifications through the monitor's alert channels", - "description": "Sends a test alert to all specified channel IDs (must be channels attached to this monitor). If no channelIds are provided, tests all attached channels. Returns per-channel results.", - "operationId": "testNotifications", + "summary": "Rotate the ping token for a heartbeat monitor", + "description": "Generates a new ping token. The old token remains valid for 24 hours to allow cron jobs to be updated without downtime. Only supported for HEARTBEAT monitors.", + "operationId": "rotateToken", "parameters": [ { "name": "id", @@ -9148,23 +9904,13 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestMonitorNotificationsRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultTestChannelResult" + "$ref": "#/components/schemas/SingleValueResponseMonitorDto" } } } @@ -9252,14 +9998,14 @@ } } }, - "/api/v1/monitors/{id}/uptime": { + "/api/v1/monitors/{id}/runs": { "get": { "tags": [ - "Check Results" + "Monitor Runs" ], - "summary": "Get uptime statistics", - "description": "Returns uptime percentage and latency statistics for the requested time window, computed from continuous aggregates. Uses hourly aggregates for 24h/7d windows and daily aggregates for 30d/90d windows.", - "operationId": "getUptime", + "summary": "List runs for a code monitor", + "description": "Cursor page. Default limit 25.", + "operationId": "listMonitorRuns", "parameters": [ { "name": "id", @@ -9271,38 +10017,31 @@ } }, { - "name": "window", + "name": "params", "in": "query", - "description": "Time window for uptime calculation", - "required": false, + "required": true, "schema": { - "type": "string", - "enum": [ - "24h", - "7d", - "30d", - "90d" - ] + "$ref": "#/components/schemas/MonitorRunListParams" } } ], "responses": { "200": { - "description": "Uptime statistics", + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/UptimeDto" + "$ref": "#/components/schemas/CursorPageRunDto" } } } }, "400": { - "description": "Invalid window parameter", + "description": "Bad request — the payload failed validation", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseUptimeDto" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -9318,21 +10057,21 @@ } }, "403": { - "description": "Monitor does not belong to the caller's org", + "description": "Forbidden — the actor lacks permission for this resource", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseUptimeDto" + "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { - "description": "Monitor not found", + "description": "Not found — the requested resource does not exist", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseUptimeDto" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -9378,16 +10117,14 @@ } } } - } - }, - "/api/v1/monitors/{id}/versions": { - "get": { + }, + "post": { "tags": [ - "Monitors" + "Monitor Runs" ], - "summary": "List version history for a monitor", - "description": "Returns a paginated list of mutation snapshots for the monitor, newest first. Each version captures the full monitor config at the time of a PUT /monitors/{id} call.", - "operationId": "listVersions", + "summary": "Run now", + "description": "Persists a run in queued phase. 409 if no Head or any secret key is missing.", + "operationId": "runNow", "parameters": [ { "name": "id", @@ -9397,23 +10134,15 @@ "type": "string", "format": "uuid" } - }, - { - "name": "pageable", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/Pageable" - } } ], "responses": { - "200": { - "description": "OK", + "202": { + "description": "Accepted", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultMonitorVersionDto" + "$ref": "#/components/schemas/SingleValueResponseRunDto" } } } @@ -9501,14 +10230,13 @@ } } }, - "/api/v1/monitors/{id}/versions/{version}": { + "/api/v1/monitors/{id}/secret-requests": { "get": { "tags": [ - "Monitors" + "Monitor secret requests" ], - "summary": "Get a specific version snapshot for a monitor", - "description": "Returns the full monitor config snapshot captured at the given version number.", - "operationId": "getVersion", + "summary": "List secret requests for a monitor", + "operationId": "list_18", "parameters": [ { "name": "id", @@ -9518,15 +10246,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "version", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } } ], "responses": { @@ -9535,7 +10254,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseMonitorVersionDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorSecretRequestsDto" } } } @@ -9623,29 +10342,37 @@ } } }, - "/api/v1/monitors/{monitorId}/alert-channels": { + "/api/v1/monitors/{id}/secret-requests/{key}": { "put": { "tags": [ - "Monitor Alert Channels" + "Monitor secret requests" ], - "summary": "Replace the linked alert channel set for a monitor", - "operationId": "setChannels", + "summary": "Attach or clear a remapped secret for a key", + "operationId": "remap", "parameters": [ { - "name": "monitorId", + "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SetAlertChannelsRequest" + "$ref": "#/components/schemas/RemapSecretRequest" } } }, @@ -9657,7 +10384,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseListUUID" + "$ref": "#/components/schemas/SingleValueResponseMonitorSecretRequestsDto" } } } @@ -9745,16 +10472,16 @@ } } }, - "/api/v1/monitors/{monitorId}/assertions": { + "/api/v1/monitors/{id}/secret-requests/rescan": { "post": { "tags": [ - "Monitor Assertions" + "Monitor secret requests" ], - "summary": "Add an assertion to a monitor", - "operationId": "add", + "summary": "Rescan secret requests from the active package", + "operationId": "rescan", "parameters": [ { - "name": "monitorId", + "name": "id", "in": "path", "required": true, "schema": { @@ -9763,23 +10490,13 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAssertionRequest" - } - } - }, - "required": true - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseMonitorAssertionDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorSecretRequestsDto" } } } @@ -9867,25 +10584,126 @@ } } }, - "/api/v1/monitors/{monitorId}/assertions/{assertionId}": { - "put": { + "/api/v1/monitors/{id}/session": { + "get": { "tags": [ - "Monitor Assertions" + "Monitor session" ], - "summary": "Update an assertion on a monitor", - "operationId": "update_10", + "summary": "Get the monitor session", + "operationId": "getSession", "parameters": [ { - "name": "monitorId", + "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseMonitorSessionDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Monitor session" + ], + "summary": "Create or update the monitor session", + "operationId": "putSession", + "parameters": [ { - "name": "assertionId", + "name": "id", "in": "path", "required": true, "schema": { @@ -9898,7 +10716,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateAssertionRequest" + "$ref": "#/components/schemas/UpsertMonitorSessionRequest" } } }, @@ -9910,7 +10728,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseMonitorAssertionDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorSessionDto" } } } @@ -9996,25 +10814,18 @@ } } } - }, - "delete": { + } + }, + "/api/v1/monitors/{id}/session/renew": { + "post": { "tags": [ - "Monitor Assertions" + "Monitor session" ], - "summary": "Remove an assertion from a monitor", - "operationId": "remove_1", + "summary": "Renew the monitor session", + "operationId": "renewSession", "parameters": [ { - "name": "monitorId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "assertionId", + "name": "id", "in": "path", "required": true, "schema": { @@ -10024,8 +10835,15 @@ } ], "responses": { - "204": { - "description": "No Content" + "202": { + "description": "Accepted", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseRunDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -10110,16 +10928,16 @@ } } }, - "/api/v1/monitors/{monitorId}/auth": { - "put": { + "/api/v1/monitors/{id}/session/revoke": { + "post": { "tags": [ - "Monitor Auth" + "Monitor session" ], - "summary": "Update authentication config for a monitor", - "operationId": "update_9", + "summary": "Revoke the monitor session", + "operationId": "revokeSession", "parameters": [ { - "name": "monitorId", + "name": "id", "in": "path", "required": true, "schema": { @@ -10128,23 +10946,13 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateMonitorAuthRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseMonitorAuthDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorSessionDto" } } } @@ -10230,16 +11038,19 @@ } } } - }, - "post": { + } + }, + "/api/v1/monitors/{id}/status-pages": { + "get": { "tags": [ - "Monitor Auth" + "Monitors" ], - "summary": "Set authentication config for a monitor", - "operationId": "set", + "summary": "List status pages that contain this monitor as a component", + "description": "Returns all status pages where this monitor appears as a component, enabling the detail page to show 'Appears On' cross-links.", + "operationId": "listStatusPagesForMonitor", "parameters": [ { - "name": "monitorId", + "name": "id", "in": "path", "required": true, "schema": { @@ -10248,23 +11059,13 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetMonitorAuthRequest" - } - } - }, - "required": true - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseMonitorAuthDto" + "$ref": "#/components/schemas/TableValueResultStatusPageDto" } } } @@ -10350,16 +11151,18 @@ } } } - }, - "delete": { + } + }, + "/api/v1/monitors/{id}/tags": { + "get": { "tags": [ - "Monitor Auth" + "Monitors" ], - "summary": "Remove authentication config from a monitor", - "operationId": "remove", + "summary": "Get all tags applied to a monitor", + "operationId": "getMonitorTags", "parameters": [ { - "name": "monitorId", + "name": "id", "in": "path", "required": true, "schema": { @@ -10369,8 +11172,15 @@ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultTagDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -10453,21 +11263,17 @@ } } } - } - }, - "/api/v1/monitors/{monitorId}/policy": { - "get": { + }, + "post": { "tags": [ - "Incident Policies" + "Monitors" ], - "summary": "Get incident policy for a monitor", - "description": "Returns the trigger rules, confirmation settings, and recovery settings for the given monitor.", - "operationId": "get_5", + "summary": "Add tags to a monitor; supports existing tag IDs and inline creation of new tags", + "operationId": "addMonitorTags", "parameters": [ { - "name": "monitorId", + "name": "id", "in": "path", - "description": "Monitor UUID", "required": true, "schema": { "type": "string", @@ -10475,13 +11281,23 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddMonitorTagsRequest" + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Policy found", + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/IncidentPolicyDto" + "$ref": "#/components/schemas/TableValueResultTagDto" } } } @@ -10517,11 +11333,11 @@ } }, "404": { - "description": "Monitor or policy not found", + "description": "Not found — the requested resource does not exist", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseIncidentPolicyDto" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -10568,18 +11384,16 @@ } } }, - "put": { + "delete": { "tags": [ - "Incident Policies" + "Monitors" ], - "summary": "Update incident policy for a monitor", - "description": "Replaces the trigger rules, confirmation settings, and recovery settings. All fields are validated before saving.", - "operationId": "update_8", + "summary": "Remove tags from a monitor by their IDs", + "operationId": "removeMonitorTags", "parameters": [ { - "name": "monitorId", + "name": "id", "in": "path", - "description": "Monitor UUID", "required": true, "schema": { "type": "string", @@ -10591,134 +11405,15 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateIncidentPolicyRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Policy updated", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/IncidentPolicyDto" - } - } - } - }, - "400": { - "description": "Validation error in JSONB shape", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseIncidentPolicyDto" - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden — the actor lacks permission for this resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Monitor or policy not found", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseIncidentPolicyDto" - } - } - } - }, - "409": { - "description": "Conflict — the request collides with current resource state", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error — see the message field for details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad gateway — an upstream provider returned an error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable — try again shortly", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/api/v1/monitors/bulk": { - "post": { - "tags": [ - "Monitors" - ], - "summary": "Bulk action on monitors", - "description": "Applies PAUSE, RESUME, DELETE, ADD_TAG, or REMOVE_TAG to a list of monitors. Returns a partial-success response indicating which monitors succeeded and which failed.", - "operationId": "bulkAction", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BulkMonitorActionRequest" + "$ref": "#/components/schemas/RemoveMonitorTagsRequest" } } }, "required": true }, "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseBulkMonitorActionResult" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -10803,24 +11498,25 @@ } } }, - "/api/v1/monitors/test": { + "/api/v1/monitors/{id}/test": { "post": { "tags": [ "Monitors" ], - "summary": "Ad-hoc monitor test", - "description": "Executes a one-off check from an inline config without saving the monitor. Runs synchronously and returns status code, response time, assertion results, body preview, and headers. MULTI_STEP_API and BROWSER are rejected with MONITOR_CODE_CHECK_TEST_UNAVAILABLE until fleet dry-run is available.", - "operationId": "testAdHoc", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MonitorTestRequest" - } + "summary": "Test an existing monitor", + "description": "Runs the saved config and assertions of an existing monitor once, without persisting any result. Runs synchronously and returns the same shape as the ad-hoc test. MULTI_STEP_API and BROWSER are rejected with MONITOR_CODE_CHECK_TEST_UNAVAILABLE until fleet dry-run is available.", + "operationId": "testExisting", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } - }, - "required": true - }, + } + ], "responses": { "200": { "description": "OK", @@ -10915,19 +11611,18 @@ } } }, - "/api/v1/notification-dispatches": { - "get": { + "/api/v1/monitors/{id}/test-notifications": { + "post": { "tags": [ - "Notification Dispatches" + "Monitors" ], - "summary": "List all dispatches for an incident", - "description": "Returns all notification dispatches for the given incident that belong to the authenticated org's policies. Each dispatch includes delivery records for all associated channels.", - "operationId": "listByIncident", + "summary": "Send test notifications through the monitor's alert channels", + "description": "Sends a test alert to all specified channel IDs (must be channels attached to this monitor). If no channelIds are provided, tests all attached channels. Returns per-channel results.", + "operationId": "testNotifications", "parameters": [ { - "name": "incident_id", - "in": "query", - "description": "UUID of the incident to inspect", + "name": "id", + "in": "path", "required": true, "schema": { "type": "string", @@ -10935,13 +11630,23 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestMonitorNotificationsRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultNotificationDispatchDto" + "$ref": "#/components/schemas/TableValueResultTestChannelResult" } } } @@ -11029,14 +11734,13 @@ } } }, - "/api/v1/notification-dispatches/{id}": { - "get": { + "/api/v1/monitors/{id}/unmute": { + "post": { "tags": [ - "Notification Dispatches" + "Monitors" ], - "summary": "Get a single dispatch with full escalation and delivery history", - "description": "Returns the dispatch state including current escalation step, acknowledgment info, and all delivery attempts made across every step.", - "operationId": "getById_3", + "summary": "Clear mute overlay", + "operationId": "unmute", "parameters": [ { "name": "id", @@ -11054,7 +11758,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseNotificationDispatchDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorDto" } } } @@ -11142,14 +11846,14 @@ } } }, - "/api/v1/notification-dispatches/{id}/acknowledge": { - "post": { + "/api/v1/monitors/{id}/uptime": { + "get": { "tags": [ - "Notification Dispatches" + "Check Results" ], - "summary": "Acknowledge a notification dispatch", - "description": "Marks the dispatch as acknowledged. The dispatch must be in DELIVERED or ESCALATING state. Sets acknowledgedAt, acknowledgedBy (actor email), and acknowledgedVia (DASHBOARD).", - "operationId": "acknowledge", + "summary": "Get uptime statistics", + "description": "Returns uptime percentage and latency statistics for the requested time window, computed from continuous aggregates. Uses hourly aggregates for 24h/7d windows and daily aggregates for 30d/90d windows.", + "operationId": "getUptime", "parameters": [ { "name": "id", @@ -11159,25 +11863,40 @@ "type": "string", "format": "uuid" } + }, + { + "name": "window", + "in": "query", + "description": "Time window for uptime calculation", + "required": false, + "schema": { + "type": "string", + "enum": [ + "24h", + "7d", + "30d", + "90d" + ] + } } ], "responses": { "200": { - "description": "OK", + "description": "Uptime statistics", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseNotificationDispatchDto" + "$ref": "#/components/schemas/UptimeDto" } } } }, "400": { - "description": "Bad request — the payload failed validation", + "description": "Invalid window parameter", "content": { - "application/json": { + "*/*": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SingleValueResponseUptimeDto" } } } @@ -11193,21 +11912,21 @@ } }, "403": { - "description": "Forbidden — the actor lacks permission for this resource", + "description": "Monitor does not belong to the caller's org", "content": { - "application/json": { + "*/*": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SingleValueResponseUptimeDto" } } } }, "404": { - "description": "Not found — the requested resource does not exist", + "description": "Monitor not found", "content": { - "application/json": { + "*/*": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SingleValueResponseUptimeDto" } } } @@ -11255,14 +11974,14 @@ } } }, - "/api/v1/notification-dispatches/{id}/unacknowledge": { - "post": { + "/api/v1/monitors/{id}/versions": { + "get": { "tags": [ - "Notification Dispatches" + "Monitors" ], - "summary": "Unacknowledge a notification dispatch", - "description": "Reverses a mistaken acknowledgment without reopening the incident. Allowed only from ACKNOWLEDGED. Clears ack fields, stays on the current escalation step, restores nextEscalationAt, and resumes escalation (ESCALATING if more steps remain, else DELIVERED). MEMBER+.", - "operationId": "unacknowledge", + "summary": "List version history for a monitor", + "description": "Returns a paginated list of mutation snapshots for the monitor, newest first. Each version captures the full monitor config at the time of a PUT /monitors/{id} call.", + "operationId": "listVersions", "parameters": [ { "name": "id", @@ -11272,6 +11991,14 @@ "type": "string", "format": "uuid" } + }, + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" + } } ], "responses": { @@ -11280,7 +12007,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseNotificationDispatchDto" + "$ref": "#/components/schemas/TableValueResultMonitorVersionDto" } } } @@ -11368,20 +12095,41 @@ } } }, - "/api/v1/notification-policies": { + "/api/v1/monitors/{id}/versions/{version}": { "get": { "tags": [ - "Notification Policies" + "Monitors" + ], + "summary": "Get a specific version snapshot for a monitor", + "description": "Returns the full monitor config snapshot captured at the given version number.", + "operationId": "getVersion", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } ], - "summary": "List all notification policies for the authenticated org", - "operationId": "list_7", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultNotificationPolicyDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorVersionDto" } } } @@ -11467,30 +12215,43 @@ } } } - }, - "post": { + } + }, + "/api/v1/monitors/{monitorId}/alert-channels": { + "put": { "tags": [ - "Notification Policies" + "Monitor Alert Channels" + ], + "summary": "Replace the linked alert channel set for a monitor", + "operationId": "setChannels", + "parameters": [ + { + "name": "monitorId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Create a notification policy with match rules and escalation chain", - "operationId": "create_8", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateNotificationPolicyRequest" + "$ref": "#/components/schemas/SetAlertChannelsRequest" } } }, "required": true }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseNotificationPolicyDto" + "$ref": "#/components/schemas/SingleValueResponseListUUID" } } } @@ -11578,16 +12339,16 @@ } } }, - "/api/v1/notification-policies/{id}": { - "get": { + "/api/v1/monitors/{monitorId}/assertions": { + "post": { "tags": [ - "Notification Policies" + "Monitor Assertions" ], - "summary": "Get a notification policy by ID", - "operationId": "getById_1", + "summary": "Add an assertion to a monitor", + "operationId": "add", "parameters": [ { - "name": "id", + "name": "monitorId", "in": "path", "required": true, "schema": { @@ -11596,13 +12357,23 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAssertionRequest" + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseNotificationPolicyDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorAssertionDto" } } } @@ -11688,16 +12459,27 @@ } } } - }, + } + }, + "/api/v1/monitors/{monitorId}/assertions/{assertionId}": { "put": { "tags": [ - "Notification Policies" + "Monitor Assertions" ], - "summary": "Update a notification policy", - "operationId": "update_7", + "summary": "Update an assertion on a monitor", + "operationId": "update_10", "parameters": [ { - "name": "id", + "name": "monitorId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "assertionId", "in": "path", "required": true, "schema": { @@ -11710,7 +12492,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateNotificationPolicyRequest" + "$ref": "#/components/schemas/UpdateAssertionRequest" } } }, @@ -11722,7 +12504,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseNotificationPolicyDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorAssertionDto" } } } @@ -11811,13 +12593,22 @@ }, "delete": { "tags": [ - "Notification Policies" + "Monitor Assertions" ], - "summary": "Delete a notification policy", - "operationId": "delete_6", + "summary": "Remove an assertion from a monitor", + "operationId": "remove_1", "parameters": [ { - "name": "id", + "name": "monitorId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "assertionId", "in": "path", "required": true, "schema": { @@ -11913,71 +12704,41 @@ } } }, - "/api/v1/notification-policies/{id}/dispatches": { - "get": { + "/api/v1/monitors/{monitorId}/auth": { + "put": { "tags": [ - "Notification Policies" + "Monitor Auth" ], - "summary": "List dispatches (firing history) for a notification policy", - "description": "Additive optional query params: since/until/cursor/limit. When all are omitted, returns the full history (legacy). When any is set, defaults to a 30-day window and limit 50, and may include nextCursor. Response remains TableValueResult — no CursorPage swap.", - "operationId": "listDispatches", + "summary": "Update authentication config for a monitor", + "operationId": "update_9", "parameters": [ { - "name": "id", + "name": "monitorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "since", - "in": "query", - "description": "Inclusive lower bound (ISO-8601); defaults to now−30d when windowing", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "until", - "in": "query", - "description": "Exclusive upper bound (ISO-8601); defaults to now when windowing", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "cursor", - "in": "query", - "description": "Opaque cursor from a previous nextCursor", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Page size 1–100 when windowing/paginating (default 50)", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateMonitorAuthRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultNotificationDispatchDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorAuthDto" } } } @@ -12063,18 +12824,16 @@ } } } - } - }, - "/api/v1/notification-policies/{id}/test": { + }, "post": { "tags": [ - "Notification Policies" + "Monitor Auth" ], - "summary": "Dry-run: evaluate a policy's match rules against a supplied incident context", - "operationId": "test_1", + "summary": "Set authentication config for a monitor", + "operationId": "set", "parameters": [ { - "name": "id", + "name": "monitorId", "in": "path", "required": true, "schema": { @@ -12087,18 +12846,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestNotificationPolicyRequest" + "$ref": "#/components/schemas/SetMonitorAuthRequest" } } - } + }, + "required": true }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseTestMatchResult" + "$ref": "#/components/schemas/SingleValueResponseMonitorAuthDto" } } } @@ -12184,56 +12944,27 @@ } } } - } - }, - "/api/v1/notifications": { - "get": { + }, + "delete": { "tags": [ - "Notifications" + "Monitor Auth" ], - "summary": "List notifications for the current user", - "operationId": "list_17", + "summary": "Remove authentication config from a monitor", + "operationId": "remove", "parameters": [ { - "name": "unreadOnly", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "page", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "size", - "in": "query", - "required": false, + "name": "monitorId", + "in": "path", + "required": true, "schema": { - "type": "integer", - "format": "int32", - "default": 20 + "type": "string", + "format": "uuid" } } ], "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TableValueResultNotificationDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -12318,27 +13049,36 @@ } } }, - "/api/v1/notifications/{id}/read": { - "put": { + "/api/v1/monitors/{monitorId}/policy": { + "get": { "tags": [ - "Notifications" + "Incident Policies" ], - "summary": "Mark a notification as read", - "operationId": "markRead", + "summary": "Get incident policy for a monitor", + "description": "Returns the trigger rules, confirmation settings, and recovery settings for the given monitor.", + "operationId": "get_5", "parameters": [ { - "name": "id", + "name": "monitorId", "in": "path", + "description": "Monitor UUID", "required": true, "schema": { - "type": "integer", - "format": "int64" + "type": "string", + "format": "uuid" } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "Policy found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/IncidentPolicyDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -12371,11 +13111,11 @@ } }, "404": { - "description": "Not found — the requested resource does not exist", + "description": "Monitor or policy not found", "content": { - "application/json": { + "*/*": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SingleValueResponseIncidentPolicyDto" } } } @@ -12421,25 +13161,53 @@ } } } - } - }, - "/api/v1/notifications/read-all": { + }, "put": { "tags": [ - "Notifications" + "Incident Policies" ], - "summary": "Mark all notifications as read", - "operationId": "markAllRead", + "summary": "Update incident policy for a monitor", + "description": "Replaces the trigger rules, confirmation settings, and recovery settings. All fields are validated before saving.", + "operationId": "update_8", + "parameters": [ + { + "name": "monitorId", + "in": "path", + "description": "Monitor UUID", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateIncidentPolicyRequest" + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "Policy updated", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/IncidentPolicyDto" + } + } + } }, "400": { - "description": "Bad request — the payload failed validation", + "description": "Validation error in JSONB shape", "content": { - "application/json": { + "*/*": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SingleValueResponseIncidentPolicyDto" } } } @@ -12465,11 +13233,11 @@ } }, "404": { - "description": "Not found — the requested resource does not exist", + "description": "Monitor or policy not found", "content": { - "application/json": { + "*/*": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/SingleValueResponseIncidentPolicyDto" } } } @@ -12517,20 +13285,31 @@ } } }, - "/api/v1/notifications/unread-count": { - "get": { + "/api/v1/monitors/bulk": { + "post": { "tags": [ - "Notifications" + "Monitors" ], - "summary": "Get unread notification count", - "operationId": "unreadCount", + "summary": "Bulk action on monitors", + "description": "Applies PAUSE, RESUME, DELETE, ADD_TAG, or REMOVE_TAG to a list of monitors. Returns a partial-success response indicating which monitors succeeded and which failed.", + "operationId": "bulkAction", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkMonitorActionRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseLong" + "$ref": "#/components/schemas/SingleValueResponseBulkMonitorActionResult" } } } @@ -12618,20 +13397,30 @@ } } }, - "/api/v1/org": { - "get": { + "/api/v1/monitors/package-uploads": { + "post": { "tags": [ - "Organizations" + "Monitors" ], - "summary": "Get the current organization", - "operationId": "get_4", + "summary": "Mint a signed package upload URL", + "operationId": "createPackageUpload", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePackageUploadRequest" + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseOrganizationDto" + "$ref": "#/components/schemas/SingleValueResponsePackageUploadDto" } } } @@ -12717,18 +13506,21 @@ } } } - }, - "put": { + } + }, + "/api/v1/monitors/test": { + "post": { "tags": [ - "Organizations" + "Monitors" ], - "summary": "Update the current organization", - "operationId": "update_6", + "summary": "Ad-hoc monitor test", + "description": "Executes a one-off check from an inline config without saving the monitor. Runs synchronously and returns status code, response time, assertion results, body preview, and headers. MULTI_STEP_API and BROWSER are rejected with MONITOR_CODE_CHECK_TEST_UNAVAILABLE until fleet dry-run is available.", + "operationId": "testAdHoc", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateOrgDetailsRequest" + "$ref": "#/components/schemas/MonitorTestRequest" } } }, @@ -12740,7 +13532,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseOrganizationDto" + "$ref": "#/components/schemas/SingleValueResponseMonitorTestResultDto" } } } @@ -12828,20 +13620,33 @@ } } }, - "/api/v1/resource-groups": { + "/api/v1/notification-dispatches": { "get": { "tags": [ - "Resource Groups" + "Notification Dispatches" + ], + "summary": "List all dispatches for an incident", + "description": "Returns all notification dispatches for the given incident that belong to the authenticated org's policies. Each dispatch includes delivery records for all associated channels.", + "operationId": "listByIncident", + "parameters": [ + { + "name": "incident_id", + "in": "query", + "description": "UUID of the incident to inspect", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "List all resource groups for the authenticated org with health summaries", - "operationId": "list_6", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultResourceGroupDto" + "$ref": "#/components/schemas/TableValueResultNotificationDispatchDto" } } } @@ -12927,30 +13732,34 @@ } } } - }, - "post": { + } + }, + "/api/v1/notification-dispatches/{id}": { + "get": { "tags": [ - "Resource Groups" + "Notification Dispatches" ], - "summary": "Create a new resource group", - "operationId": "create_7", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateResourceGroupRequest" - } + "summary": "Get a single dispatch with full escalation and delivery history", + "description": "Returns the dispatch state including current escalation step, acknowledgment info, and all delivery attempts made across every step.", + "operationId": "getById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } - }, - "required": true - }, + } + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseResourceGroupDto" + "$ref": "#/components/schemas/SingleValueResponseNotificationDispatchDto" } } } @@ -13038,14 +13847,14 @@ } } }, - "/api/v1/resource-groups/{id}": { - "get": { + "/api/v1/notification-dispatches/{id}/acknowledge": { + "post": { "tags": [ - "Resource Groups" + "Notification Dispatches" ], - "summary": "Get a resource group by id with member statuses and inherited settings", - "description": "Pass includeMetrics=true to enrich each member with 24h uptime, chart data, and latency metrics.", - "operationId": "get_3", + "summary": "Acknowledge a notification dispatch", + "description": "Marks the dispatch as acknowledged. The dispatch must be in DELIVERED or ESCALATING state. Sets acknowledgedAt, acknowledgedBy (actor email), and acknowledgedVia (DASHBOARD).", + "operationId": "acknowledge", "parameters": [ { "name": "id", @@ -13055,15 +13864,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "includeMetrics", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } } ], "responses": { @@ -13072,7 +13872,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseResourceGroupDto" + "$ref": "#/components/schemas/SingleValueResponseNotificationDispatchDto" } } } @@ -13158,13 +13958,16 @@ } } } - }, - "put": { + } + }, + "/api/v1/notification-dispatches/{id}/unacknowledge": { + "post": { "tags": [ - "Resource Groups" + "Notification Dispatches" ], - "summary": "Update a resource group's name, description, alert policy, inherited settings, and health threshold", - "operationId": "update_5", + "summary": "Unacknowledge a notification dispatch", + "description": "Reverses a mistaken acknowledgment without reopening the incident. Allowed only from ACKNOWLEDGED. Clears ack fields, stays on the current escalation step, restores nextEscalationAt, and resumes escalation (ESCALATING if more steps remain, else DELIVERED). MEMBER+.", + "operationId": "unacknowledge", "parameters": [ { "name": "id", @@ -13176,23 +13979,13 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateResourceGroupRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseResourceGroupDto" + "$ref": "#/components/schemas/SingleValueResponseNotificationDispatchDto" } } } @@ -13278,27 +14071,25 @@ } } } - }, - "delete": { + } + }, + "/api/v1/notification-policies": { + "get": { "tags": [ - "Resource Groups" - ], - "summary": "Delete a resource group (cascades to member rows)", - "operationId": "delete_5", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Notification Policies" ], + "summary": "List all notification policies for the authenticated org", + "operationId": "list_7", "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultNotificationPolicyDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -13381,34 +14172,30 @@ } } } - } - }, - "/api/v1/resource-groups/{id}/health": { - "get": { + }, + "post": { "tags": [ - "Resource Groups" + "Notification Policies" ], - "summary": "Get the detailed health breakdown for a resource group", - "description": "Returns member counts, worst-of status, and threshold-based health evaluation. The thresholdStatus field is populated only when a health threshold is configured.", - "operationId": "getHealth", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Create a notification policy with match rules and escalation chain", + "operationId": "create_8", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateNotificationPolicyRequest" + } } - } - ], + }, + "required": true + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseResourceGroupHealthDto" + "$ref": "#/components/schemas/SingleValueResponseNotificationPolicyDto" } } } @@ -13496,14 +14283,13 @@ } } }, - "/api/v1/resource-groups/{id}/matched-policies": { + "/api/v1/notification-policies/{id}": { "get": { "tags": [ - "Resource Groups" + "Notification Policies" ], - "summary": "List notification policies that match this resource group", - "description": "Policies whose match rules evaluate true for a DEGRADED or DOWN group-origin INCIDENT_CREATED context on this resource group (includes paused)", - "operationId": "listMatchedPolicies", + "summary": "Get a notification policy by ID", + "operationId": "getById_1", "parameters": [ { "name": "id", @@ -13521,7 +14307,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultNotificationPolicyDto" + "$ref": "#/components/schemas/SingleValueResponseNotificationPolicyDto" } } } @@ -13607,15 +14393,13 @@ } } } - } - }, - "/api/v1/resource-groups/{id}/members": { - "post": { + }, + "put": { "tags": [ - "Resource Groups" + "Notification Policies" ], - "summary": "Add a monitor or service member to a resource group", - "operationId": "addMember_1", + "summary": "Update a notification policy", + "operationId": "update_7", "parameters": [ { "name": "id", @@ -13631,19 +14415,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddResourceGroupMemberRequest" + "$ref": "#/components/schemas/UpdateNotificationPolicyRequest" } } }, "required": true }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseResourceGroupMemberDto" + "$ref": "#/components/schemas/SingleValueResponseNotificationPolicyDto" } } } @@ -13729,15 +14513,13 @@ } } } - } - }, - "/api/v1/resource-groups/{id}/members/{memberId}": { + }, "delete": { "tags": [ - "Resource Groups" + "Notification Policies" ], - "summary": "Remove a member from a resource group", - "operationId": "removeMember_1", + "summary": "Delete a notification policy", + "operationId": "delete_6", "parameters": [ { "name": "id", @@ -13747,20 +14529,163 @@ "type": "string", "format": "uuid" } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/notification-policies/{id}/dispatches": { + "get": { + "tags": [ + "Notification Policies" + ], + "summary": "List dispatches (firing history) for a notification policy", + "description": "Optional query params: since/until/cursor/limit. When all are omitted, returns the full history (legacy). When any is set, defaults to a 30-day window and limit 50. Response is CursorPage (hasMore + nextCursor), the same wrapper used by other append-only history endpoints.", + "operationId": "listDispatches", + "parameters": [ { - "name": "memberId", + "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "since", + "in": "query", + "description": "Inclusive lower bound (ISO-8601); defaults to now−30d when windowing", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "until", + "in": "query", + "description": "Exclusive upper bound (ISO-8601); defaults to now when windowing", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "cursor", + "in": "query", + "description": "Opaque cursor from a previous nextCursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Page size 1–100 when windowing/paginating (default 50)", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CursorPageNotificationDispatchDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -13845,129 +14770,40 @@ } } }, - "/api/v1/secrets": { - "get": { + "/api/v1/notification-policies/{id}/test": { + "post": { "tags": [ - "Secrets" + "Notification Policies" ], - "summary": "List secrets", - "operationId": "list_5", - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TableValueResultSecretDto" - } - } - } - }, - "400": { - "description": "Bad request — the payload failed validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden — the actor lacks permission for this resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found — the requested resource does not exist", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Conflict — the request collides with current resource state", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error — see the message field for details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad gateway — an upstream provider returned an error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable — try again shortly", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "summary": "Dry-run: evaluate a policy's match rules against a supplied incident context", + "operationId": "test_1", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - } - }, - "post": { - "tags": [ - "Secrets" ], - "summary": "Create secret", - "operationId": "create_6", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateSecretRequest" + "$ref": "#/components/schemas/TestNotificationPolicyRequest" } } - }, - "required": true + } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseSecretDto" + "$ref": "#/components/schemas/SingleValueResponseTestMatchResult" } } } @@ -14055,40 +14891,51 @@ } } }, - "/api/v1/secrets/{key}": { - "put": { + "/api/v1/notifications": { + "get": { "tags": [ - "Secrets" + "Notifications" ], - "summary": "Update secret", - "operationId": "update_4", + "summary": "List notifications for the current user", + "operationId": "list_17", "parameters": [ { - "name": "key", - "in": "path", - "required": true, + "name": "unreadOnly", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "boolean", + "default": false } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSecretRequest" - } + }, + { + "name": "page", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 0 } }, - "required": true - }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 20 + } + } + ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseSecretDto" + "$ref": "#/components/schemas/TableValueResultNotificationDto" } } } @@ -14174,20 +15021,23 @@ } } } - }, - "delete": { + } + }, + "/api/v1/notifications/{id}/read": { + "put": { "tags": [ - "Secrets" + "Notifications" ], - "summary": "Delete secret", - "operationId": "delete_4", + "summary": "Mark a notification as read", + "operationId": "markRead", "parameters": [ { - "name": "key", + "name": "id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer", + "format": "int64" } } ], @@ -14278,23 +15128,16 @@ } } }, - "/api/v1/service-subscriptions": { - "get": { + "/api/v1/notifications/read-all": { + "put": { "tags": [ - "Service Subscriptions" + "Notifications" ], - "summary": "List all service subscriptions for the organization", - "operationId": "list_16", + "summary": "Mark all notifications as read", + "operationId": "markAllRead", "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TableValueResultServiceSubscriptionDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -14379,31 +15222,20 @@ } } }, - "/api/v1/service-subscriptions/{id}": { + "/api/v1/notifications/unread-count": { "get": { "tags": [ - "Service Subscriptions" - ], - "summary": "Get a subscription by its ID", - "operationId": "get_11", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Notifications" ], + "summary": "Get unread notification count", + "operationId": "unreadCount", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" + "$ref": "#/components/schemas/SingleValueResponseLong" } } } @@ -14489,28 +15321,25 @@ } } } - }, - "delete": { + } + }, + "/api/v1/org": { + "get": { "tags": [ - "Service Subscriptions" - ], - "summary": "Remove a subscription by its ID", - "description": "Removes a specific subscription (whole-service or component-level). No-op if not found.", - "operationId": "unsubscribe_1", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Organizations" ], + "summary": "Get the current organization", + "operationId": "get_4", "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseOrganizationDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -14593,32 +15422,18 @@ } } } - } - }, - "/api/v1/service-subscriptions/{id}/alert-sensitivity": { - "patch": { + }, + "put": { "tags": [ - "Service Subscriptions" - ], - "summary": "Update alert sensitivity for a subscription", - "description": "Controls which external incidents trigger alerts and whether they page anyone: ALL (any status change, paged), INCIDENTS_ONLY (real vendor incidents, paged), MAJOR_ONLY (only DOWN-level incidents, paged), AWARENESS (real vendor incidents tracked silently — visible on the dashboard but no alert channels fire; default for new subscriptions).", - "operationId": "updateAlertSensitivity", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Organizations" ], + "summary": "Update the current organization", + "operationId": "update_6", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateAlertSensitivityRequest" + "$ref": "#/components/schemas/UpdateOrgDetailsRequest" } } }, @@ -14630,7 +15445,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" + "$ref": "#/components/schemas/SingleValueResponseOrganizationDto" } } } @@ -14718,40 +15533,20 @@ } } }, - "/api/v1/service-subscriptions/{slug}": { - "post": { + "/api/v1/resource-groups": { + "get": { "tags": [ - "Service Subscriptions" - ], - "summary": "Subscribe to a service or a component of a service", - "description": "Idempotent — returns the existing subscription if an identical one exists. Omit the request body or set componentId to null for a whole-service subscription. When alertSensitivity is omitted, new subscriptions default to AWARENESS (silent tracking — the incident appears on the dashboard but no alert channels fire). PATCH /alert-sensitivity to opt in to paging. Free tier: max 10 subscriptions. Paid tier: unlimited.", - "operationId": "subscribe_1", - "parameters": [ - { - "name": "slug", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } + "Resource Groups" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceSubscribeRequest" - } - } - } - }, + "summary": "List all resource groups for the authenticated org with health summaries", + "operationId": "list_6", "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" + "$ref": "#/components/schemas/TableValueResultResourceGroupDto" } } } @@ -14837,98 +15632,30 @@ } } } - } - }, - "/api/v1/services": { - "get": { + }, + "post": { "tags": [ - "Status Data" + "Resource Groups" ], - "summary": "List all enabled services (cursor-paginated)", - "operationId": "listServices", - "parameters": [ - { - "name": "category", - "in": "query", - "description": "Filter by category (exact match)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "in": "query", - "description": "Filter by current overall_status (exact match)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "published", - "in": "query", - "description": "Filter by published status for pSEO pages", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "slaPublished", - "in": "query", - "description": "Filter by SLA page publication status", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "search", - "in": "query", - "description": "Case-insensitive substring match on service name or slug", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "in": "query", - "description": "Result ordering: 'recent' (default, newest first) or 'curated' (curated/recognizable first)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "cursor", - "in": "query", - "description": "Opaque cursor from a previous response", - "required": false, - "schema": { - "type": "string" + "summary": "Create a new resource group", + "operationId": "create_7", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateResourceGroupRequest" + } } }, - { - "name": "limit", - "in": "query", - "description": "Page size (1–100, default 20)", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - } - } - ], + "required": true + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/CursorPageServiceCatalogDto" + "$ref": "#/components/schemas/SingleValueResponseResourceGroupDto" } } } @@ -15016,37 +15743,27 @@ } } }, - "/api/v1/services/{slugOrId}": { + "/api/v1/resource-groups/{id}": { "get": { "tags": [ - "Status Data" + "Resource Groups" ], - "summary": "Get a single service by slug or UUID with current status, components, and recent incidents", - "description": "When ``summary=true``, the inline ``components`` list is trimmed to groups + showcase leaves + currently-impacted leaves + ungrouped leaves, and a ``componentsSummary`` block is added with the trimmed counts. Powers SSR for vendors with hundreds of components (Snowflake, Cloudflare, DigitalOcean) without OOM-ing the renderer. Default false for full back-compat.", - "operationId": "getService", + "summary": "Get a resource group by id with member statuses and inherited settings", + "description": "Pass includeMetrics=true to enrich each member with 24h uptime, chart data, and latency metrics.", + "operationId": "get_3", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "summary", - "in": "query", - "description": "Return a curated subset of components (groups + showcase + impacted + ungrouped) and a componentsSummary block; default false", - "required": false, - "schema": { - "type": "boolean", - "default": false + "type": "string", + "format": "uuid" } }, { - "name": "publishedOnly", + "name": "includeMetrics", "in": "query", - "description": "Resolve only published services (curated public pSEO set); 404 otherwise. Default false", "required": false, "schema": { "type": "boolean", @@ -15060,7 +15777,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseServiceDetailDto" + "$ref": "#/components/schemas/SingleValueResponseResourceGroupDto" } } } @@ -15146,72 +15863,41 @@ } } } - } - }, - "/api/v1/services/{slugOrId}/components": { - "get": { + }, + "put": { "tags": [ - "Status Data" + "Resource Groups" ], - "summary": "List active components for a service with current status and inline uptime", - "description": "When ``groupId`` is supplied, only direct children of that group are returned — used by the pSEO renderer to lazy-load the leaves under a group that summary mode trimmed. Without ``groupId`` the response includes every active component for the service. Supports pagination via ``page``/``size`` and case-insensitive name search via ``search``.", - "operationId": "getComponents", + "summary": "Update a resource group's name, description, alert policy, inherited settings, and health threshold", + "operationId": "update_5", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "groupId", - "in": "query", - "description": "Restrict result to direct children of this group component id", - "required": false, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "search", - "in": "query", - "description": "Case-insensitive substring match on component name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "Zero-based page index", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "size", - "in": "query", - "description": "Page size (default 25, max 100)", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateResourceGroupRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultServiceComponentDto" + "$ref": "#/components/schemas/SingleValueResponseResourceGroupDto" } } } @@ -15297,80 +15983,27 @@ } } } - } - }, - "/api/v1/services/{slugOrId}/components/{componentId}/uptime": { - "get": { + }, + "delete": { "tags": [ - "Status Data" + "Resource Groups" ], - "summary": "Get daily uptime data for a component", - "description": "Pass either ``period`` (preset window) or an explicit ``from``/``to`` calendar window (ISO yyyy-MM-dd, max 730 days, ``to`` defaults to today). When both are supplied, the explicit window wins.", - "operationId": "getComponentUptime", + "summary": "Delete a resource group (cascades to member rows)", + "operationId": "delete_5", "parameters": [ { - "name": "slugOrId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "componentId", + "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "period", - "in": "query", - "description": "Preset time window (used when ``from`` is omitted)", - "required": false, - "schema": { - "type": "string", - "enum": [ - "7d", - "30d", - "90d", - "1y" - ] - } - }, - { - "name": "from", - "in": "query", - "description": "Explicit window start (ISO date); overrides ``period``", - "required": false, - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "to", - "in": "query", - "description": "Explicit window end (ISO date); defaults to today", - "required": false, - "schema": { - "type": "string", - "format": "date" - } } ], "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TableValueResultComponentUptimeDayDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -15455,56 +16088,22 @@ } } }, - "/api/v1/services/{slugOrId}/components/uptime": { + "/api/v1/resource-groups/{id}/health": { "get": { "tags": [ - "Status Data" + "Resource Groups" ], - "summary": "Batch daily uptime data for all leaf components", - "description": "Returns daily uptime for every active non-group component with uptime data, keyed by component ID. Replaces N individual per-component uptime calls with a single request. Supports either a preset ``period`` or an explicit ``from``/``to`` window (ISO yyyy-MM-dd, max 730 days). The explicit window wins when both are supplied — this is what powers the sliding 90-day navigator on the public uptime history page.", - "operationId": "getBatchComponentUptime", + "summary": "Get the detailed health breakdown for a resource group", + "description": "Returns member counts, worst-of status, and threshold-based health evaluation. The thresholdStatus field is populated only when a health threshold is configured.", + "operationId": "getHealth", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "period", - "in": "query", - "description": "Preset time window (used when ``from`` is omitted)", - "required": false, - "schema": { - "type": "string", - "enum": [ - "7d", - "30d", - "90d", - "1y" - ] - } - }, - { - "name": "from", - "in": "query", - "description": "Explicit window start (ISO date); overrides ``period``", - "required": false, "schema": { "type": "string", - "format": "date" - } - }, - { - "name": "to", - "in": "query", - "description": "Explicit window end (ISO date); defaults to today", - "required": false, - "schema": { - "type": "string", - "format": "date" + "format": "uuid" } } ], @@ -15514,7 +16113,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseBatchComponentUptimeDto" + "$ref": "#/components/schemas/SingleValueResponseResourceGroupHealthDto" } } } @@ -15602,31 +16201,22 @@ } } }, - "/api/v1/services/{slugOrId}/days/{date}": { + "/api/v1/resource-groups/{id}/matched-policies": { "get": { "tags": [ - "Status Data" + "Resource Groups" ], - "summary": "One-day rollup for a service: aggregated uptime, per-component impacts, and overlapping incidents", - "description": "Powers the click/hover-to-expand panel under each uptime bar on the public status page. Single round-trip — components, sums, and overlapping incidents (with affected component names) are returned in one response.", - "operationId": "getServiceDayDetail", + "summary": "List notification policies that match this resource group", + "description": "Policies whose match rules evaluate true for a DEGRADED or DOWN group-origin INCIDENT_CREATED context on this resource group (includes paused)", + "operationId": "listMatchedPolicies", "parameters": [ { - "name": "slugOrId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "date", + "name": "id", "in": "path", - "description": "UTC calendar day in ISO format (YYYY-MM-DD)", "required": true, "schema": { "type": "string", - "format": "date" + "format": "uuid" } } ], @@ -15636,7 +16226,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseServiceDayDetailDto" + "$ref": "#/components/schemas/TableValueResultNotificationPolicyDto" } } } @@ -15724,61 +16314,41 @@ } } }, - "/api/v1/services/{slugOrId}/incidents": { - "get": { + "/api/v1/resource-groups/{id}/members": { + "post": { "tags": [ - "Status Data" + "Resource Groups" ], - "summary": "List incident history for a service (paginated)", - "operationId": "listIncidents_1", + "summary": "Add a monitor or service member to a resource group", + "operationId": "addMember_1", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "from", - "in": "query", - "description": "Earliest start date (ISO 8601 date)", - "required": false, - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "status", - "in": "query", - "description": "Filter: active (unresolved), resolved, or omit for all", - "required": false, "schema": { "type": "string", - "enum": [ - "active", - "resolved" - ] - } - }, - { - "name": "pageable", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/Pageable" + "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddResourceGroupMemberRequest" + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultServiceIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseResourceGroupMemberDto" } } } @@ -15866,24 +16436,25 @@ } } }, - "/api/v1/services/{slugOrId}/incidents/{incidentId}": { - "get": { + "/api/v1/resource-groups/{id}/members/{memberId}": { + "delete": { "tags": [ - "Status Data" + "Resource Groups" ], - "summary": "Get incident detail with full update timeline", - "operationId": "getIncident_1", + "summary": "Remove a member from a resource group", + "operationId": "removeMember_1", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "incidentId", + "name": "memberId", "in": "path", "required": true, "schema": { @@ -15893,15 +16464,8 @@ } ], "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseServiceIncidentDetailDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -15986,21 +16550,21 @@ } } }, - "/api/v1/services/{slugOrId}/live-status": { + "/api/v1/revisions/{id}": { "get": { "tags": [ - "Status Data" + "Revisions" ], - "summary": "Lightweight live-status snapshot for polling", - "description": "Returns only the current overall status, component statuses, and active incident count. Designed for frequent polling with minimal payload.", - "operationId": "getServiceLiveStatus", + "summary": "Get revision package", + "operationId": "get_12", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -16010,7 +16574,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseServiceLiveStatusDto" + "$ref": "#/components/schemas/SingleValueResponseRevisionDto" } } } @@ -16098,45 +16662,28 @@ } } }, - "/api/v1/services/{slugOrId}/maintenances": { + "/api/v1/revisions/{id}/bundle": { "get": { "tags": [ - "Status Data" + "Revisions" ], - "summary": "List scheduled maintenances for a service", - "operationId": "getScheduledMaintenances", + "summary": "Redirect to signed package download", + "description": "Returns 302 Location with a signed GET URL. 404 after downloadUntil.", + "operationId": "bundle", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "status", - "in": "query", - "description": "Filter by status (e.g. scheduled, in_progress, verifying, completed)", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } + "type": "string", + "format": "uuid" } } ], "responses": { "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TableValueResultScheduledMaintenanceDto" - } - } - } + "description": "OK" }, "400": { "description": "Bad request — the payload failed validation", @@ -16221,40 +16768,30 @@ } } }, - "/api/v1/services/{slugOrId}/poll-results": { + "/api/v1/revisions/{id}/diff/{other}": { "get": { "tags": [ - "Status Data" + "Revisions" ], - "summary": "List poll results for a service (cursor-paginated)", - "operationId": "listPollResults", + "summary": "Compare two revisions (bounded hunks)", + "operationId": "diff", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "cursor", - "in": "query", - "description": "ISO 8601 timestamp cursor from a previous response", - "required": false, - "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "limit", - "in": "query", - "description": "Page size (1–100, default 50)", - "required": false, + "name": "other", + "in": "path", + "required": true, "schema": { - "type": "integer", - "format": "int32", - "default": 50 + "type": "string", + "format": "uuid" } } ], @@ -16264,7 +16801,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/CursorPageServicePollResultDto" + "$ref": "#/components/schemas/SingleValueResponseRevisionDiffDto" } } } @@ -16352,34 +16889,21 @@ } } }, - "/api/v1/services/{slugOrId}/poll-summary": { + "/api/v1/runs": { "get": { "tags": [ - "Status Data" + "Runs" ], - "summary": "Get aggregated poll metrics and chart data for a service", - "operationId": "getPollSummary", + "summary": "List code runs", + "description": "Org index. Default from=now-30m. Page size 50.", + "operationId": "listRuns", "parameters": [ { - "name": "slugOrId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "window", + "name": "params", "in": "query", - "description": "Time window", - "required": false, + "required": true, "schema": { - "type": "string", - "enum": [ - "24h", - "7d", - "30d" - ] + "$ref": "#/components/schemas/RunListParams" } } ], @@ -16389,7 +16913,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseServicePollSummaryDto" + "$ref": "#/components/schemas/TableValueResultRunDto" } } } @@ -16477,84 +17001,21 @@ } } }, - "/api/v1/services/{slugOrId}/status-events": { + "/api/v1/runs/{id}": { "get": { "tags": [ - "Status Data" + "Runs" ], - "summary": "List curated vendor status events for a service", - "description": "Reverse-chronological merge of vendor incidents, maintenances, and rolled-up component transitions for the Dependencies Detail rail. Optional JWT + x-phelm-org-id annotates incident.opened rows with the caller's linked internal incident.", - "operationId": "listStatusEvents", + "summary": "Get a run", + "operationId": "getRun", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "types", - "in": "query", - "description": "Comma-separated type buckets: incident, maintenance, component (default: all)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "period", - "in": "query", - "description": "Preset window", - "required": false, - "schema": { - "type": "string", - "enum": [ - "7d", - "30d", - "90d" - ] - } - }, - { - "name": "from", - "in": "query", - "description": "Explicit lower bound (ISO 8601); overrides period", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "to", - "in": "query", - "description": "Explicit upper bound (ISO 8601); default now", - "required": false, "schema": { "type": "string", - "format": "date-time" - } - }, - { - "name": "cursor", - "in": "query", - "description": "Opaque cursor from a previous response", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Page size (1–100, default 50)", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 50 + "format": "uuid" } } ], @@ -16564,7 +17025,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/CursorPageStatusEventDto" + "$ref": "#/components/schemas/SingleValueResponseRunDto" } } } @@ -16652,53 +17113,22 @@ } } }, - "/api/v1/services/{slugOrId}/uptime": { + "/api/v1/runs/{id}/artifacts": { "get": { "tags": [ - "Status Data" + "Runs" ], - "summary": "Get uptime statistics for a service", - "description": "Uptime data aggregated across active non-group components.", - "operationId": "getServiceUptime", + "summary": "List run artifacts", + "description": "Complete persist manifest for this run.", + "operationId": "listRunArtifacts", "parameters": [ { - "name": "slugOrId", + "name": "id", "in": "path", "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "period", - "in": "query", - "description": "Time window", - "required": false, - "schema": { - "type": "string", - "enum": [ - "24h", - "7d", - "30d", - "90d", - "1y", - "2y", - "all" - ] - } - }, - { - "name": "granularity", - "in": "query", - "description": "Bucket granularity", - "required": false, "schema": { "type": "string", - "enum": [ - "hourly", - "daily", - "monthly" - ] + "format": "uuid" } } ], @@ -16708,7 +17138,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseServiceUptimeResponse" + "$ref": "#/components/schemas/TableValueResultRunArtifactDto" } } } @@ -16793,61 +17223,25 @@ } } } - }, - "security": [ - { - "BearerAuth": [] - } - ] + } } }, - "/api/v1/services/incidents": { - "get": { + "/api/v1/runs/{id}/cancel": { + "post": { "tags": [ - "Status Data" + "Runs" ], - "summary": "List vendor incidents across all services (paginated)", - "description": "Cross-service vendor incident feed ordered by start date descending.", - "operationId": "listCrossServiceIncidents", + "summary": "Request run cancel", + "description": "Sets cancel_requested; phase unchanged.", + "operationId": "cancelRun", "parameters": [ { - "name": "from", - "in": "query", - "description": "Earliest start date (ISO 8601 date)", - "required": false, - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "status", - "in": "query", - "description": "Filter: active (unresolved), resolved, or omit for all", - "required": false, - "schema": { - "type": "string", - "enum": [ - "active", - "resolved" - ] - } - }, - { - "name": "category", - "in": "query", - "description": "Filter by service category", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "pageable", - "in": "query", + "name": "id", + "in": "path", "required": true, "schema": { - "$ref": "#/components/schemas/Pageable" + "type": "string", + "format": "uuid" } } ], @@ -16857,7 +17251,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultServiceIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseRunDto" } } } @@ -16945,23 +17339,29 @@ } } }, - "/api/v1/services/summary": { + "/api/v1/runs/{id}/cases": { "get": { "tags": [ - "Status Data" + "Runs" ], - "summary": "Global status summary across all services", - "description": "Returns aggregate counts of services by status and a list of services currently experiencing issues.", - "operationId": "getGlobalStatusSummary", + "summary": "List run cases with nested steps", + "operationId": "listRunCases", "parameters": [ { - "name": "publishedOnly", + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "params", "in": "query", - "description": "Aggregate only published services (curated public pSEO set); default false", - "required": false, + "required": true, "schema": { - "type": "boolean", - "default": false + "$ref": "#/components/schemas/RunCaseListParams" } } ], @@ -16971,7 +17371,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseGlobalStatusSummaryDto" + "$ref": "#/components/schemas/TableValueResultRunCaseDto" } } } @@ -17059,20 +17459,45 @@ } } }, - "/api/v1/status-pages": { + "/api/v1/runs/{id}/console": { "get": { "tags": [ - "Status Pages" + "Runs" + ], + "summary": "Download raw console log", + "description": "Ungrouped text/plain console lines.", + "operationId": "getRunConsoleRaw", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "params", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/RunConsoleParams" + } + } ], - "summary": "List status pages for the workspace", - "operationId": "list_4", "responses": { "200": { "description": "OK", "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageDto" + "$ref": "#/components/schemas/SingleValueResponseRunConsoleDto" + } + }, + "text/plain": { + "schema": { + "type": "string" } } } @@ -17158,30 +17583,49 @@ } } } - }, - "post": { + } + }, + "/api/v1/runs/{id}/events": { + "get": { "tags": [ - "Status Pages" + "Runs" ], - "summary": "Create a status page", - "operationId": "create_5", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStatusPageRequest" - } + "summary": "Stream run control events", + "operationId": "streamRunEvents", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "required": true - }, + { + "name": "params", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/RunEventParams" + } + }, + { + "name": "Last-Event-ID", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "Server-sent persist control events", "content": { - "*/*": { + "text/event-stream": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" + "$ref": "#/components/schemas/RunEventDto" } } } @@ -17269,13 +17713,14 @@ } } }, - "/api/v1/status-pages/{id}": { + "/api/v1/runs/{id}/network": { "get": { "tags": [ - "Status Pages" + "Runs" ], - "summary": "Get a status page", - "operationId": "get_2", + "summary": "List run network rows", + "description": "Waterfall collection. Filters: failed, slow, stepId, xhr, source. 500 per page.", + "operationId": "listRunNetwork", "parameters": [ { "name": "id", @@ -17285,6 +17730,14 @@ "type": "string", "format": "uuid" } + }, + { + "name": "params", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/RunNetworkParams" + } } ], "responses": { @@ -17293,7 +17746,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" + "$ref": "#/components/schemas/RunNetworkDto" } } } @@ -17379,13 +17832,16 @@ } } } - }, - "put": { + } + }, + "/api/v1/runs/{id}/network/{rowId}": { + "get": { "tags": [ - "Status Pages" + "Runs" ], - "summary": "Update a status page", - "operationId": "update_3", + "summary": "Get one network row", + "description": "Includes redacted headers, bodies, and copy-as-cURL.", + "operationId": "getRunNetworkRow", "parameters": [ { "name": "id", @@ -17395,25 +17851,23 @@ "type": "string", "format": "uuid" } + }, + { + "name": "rowId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateStatusPageRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" + "$ref": "#/components/schemas/SingleValueResponseNetworkRowDto" } } } @@ -17499,13 +17953,16 @@ } } } - }, - "delete": { + } + }, + "/api/v1/runs/{id}/runner-log": { + "get": { "tags": [ - "Status Pages" + "Runs" ], - "summary": "Delete a status page", - "operationId": "delete_3", + "summary": "Snapshot in-flight runner log", + "description": "Hot Loki snapshot (text/plain) of lines so far. This is not live tail — poll this endpoint or use GET /runner-log/live (SSE). After finish, the cold file is the runner_log artifact (GET /artifacts/{id}/content). Empty while no lines have been pushed.", + "operationId": "getRunRunnerLog", "parameters": [ { "name": "id", @@ -17518,8 +17975,15 @@ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -17604,13 +18068,14 @@ } } }, - "/api/v1/status-pages/{id}/components": { + "/api/v1/runs/{id}/runner-log/live": { "get": { "tags": [ - "Status Pages" + "Runs" ], - "summary": "List all components", - "operationId": "listComponents", + "summary": "Live tail runner log", + "description": "SSE live tail of in-flight Loki lines. Same ACL as the snapshot (runs.get). Each event data is JSON {ts,line} (ts is Loki nanoseconds, line is one log line). Loki stays internal. Closes on client disconnect, idle/run-finished, or the same SSE timeout as GET /events. Cold file after finish is the runner_log artifact.", + "operationId": "streamRunRunnerLog", "parameters": [ { "name": "id", @@ -17622,13 +18087,114 @@ } } ], + "responses": { + "200": { + "description": "Server-sent runner-log lines", + "content": { + "text/event-stream": { + "schema": { + "$ref": "#/components/schemas/RunnerLogLiveEvent" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "summary": "List organization secrets", + "operationId": "list_5", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageComponentDto" + "$ref": "#/components/schemas/TableValueResultSecretDto" } } } @@ -17717,26 +18283,15 @@ }, "post": { "tags": [ - "Status Pages" - ], - "summary": "Add a component to the status page", - "operationId": "createComponent", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Secrets" ], + "summary": "Create secret", + "operationId": "create_6", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateStatusPageComponentRequest" + "$ref": "#/components/schemas/CreateSecretRequest" } } }, @@ -17748,7 +18303,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" + "$ref": "#/components/schemas/SingleValueResponseSecretDto" } } } @@ -17836,30 +18391,20 @@ } } }, - "/api/v1/status-pages/{id}/components/{componentId}": { + "/api/v1/secrets/{key}": { "put": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Update a component", - "operationId": "updateComponent", + "summary": "Update secret", + "operationId": "update_4", "parameters": [ { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "componentId", + "name": "key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -17867,7 +18412,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateStatusPageComponentRequest" + "$ref": "#/components/schemas/UpdateSecretRequest" } } }, @@ -17879,7 +18424,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" + "$ref": "#/components/schemas/SingleValueResponseSecretDto" } } } @@ -17968,27 +18513,17 @@ }, "delete": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Remove a component from the status page", - "operationId": "deleteComponent", + "summary": "Delete secret", + "operationId": "delete_4", "parameters": [ { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "componentId", + "name": "key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -18079,41 +18614,20 @@ } } }, - "/api/v1/status-pages/{id}/components/{componentId}/measured-uptime": { + "/api/v1/secrets/{key}/audit": { "get": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Get measured (check-based) component uptime history", - "description": "Additive measured daily uptime for MONITOR components (ASK-SP-2 / CHG-2). Reads time-bounded check_results_daily rollups for the linked monitor. Response source is always measured. Does not change legacy GET …/uptime incident-window semantics. days default 90, max 365.", - "operationId": "componentMeasuredUptime", + "summary": "Last update metadata for a secret", + "operationId": "audit", "parameters": [ { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "componentId", + "name": "key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "days", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 90 + "type": "string" } } ], @@ -18123,7 +18637,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageMeasuredComponentUptimeDto" + "$ref": "#/components/schemas/SingleValueResponseSecretAuditDto" } } } @@ -18211,26 +18725,24 @@ } } }, - "/api/v1/status-pages/{id}/components/{componentId}/override": { + "/api/v1/secrets/{key}/environments/{environmentId}": { "put": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Set a timed human status override on a component", - "description": "ASK-SP-1 / CHG-1. Effective currentStatus reflects the override until expiry or clear, unless an active incident takes precedence (incident > override > binding). Max expiry horizon is 24 hours.", - "operationId": "setComponentOverride", + "summary": "Write a secret value for one environment", + "operationId": "writeEnvironmentValue", "parameters": [ { - "name": "id", + "name": "key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "componentId", + "name": "environmentId", "in": "path", "required": true, "schema": { @@ -18243,22 +18755,15 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SetStatusPageComponentOverrideRequest" + "$ref": "#/components/schemas/WriteSecretEnvironmentValueRequest" } } }, "required": true }, "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -18341,40 +18846,133 @@ } } } - }, - "delete": { + } + }, + "/api/v1/secrets/{key}/usage": { + "get": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Clear a timed human status override on a component", - "operationId": "clearComponentOverride", + "summary": "Secret usage across monitors", + "operationId": "usage", "parameters": [ { - "name": "id", + "name": "key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseSecretUsageDto" + } + } } }, - { - "name": "componentId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } } } + } + } + }, + "/api/v1/service-subscriptions": { + "get": { + "tags": [ + "Service Subscriptions" ], + "summary": "List all service subscriptions for the organization", + "operationId": "list_16", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" + "$ref": "#/components/schemas/TableValueResultServiceSubscriptionDto" } } } @@ -18462,14 +19060,13 @@ } } }, - "/api/v1/status-pages/{id}/components/{componentId}/uptime": { + "/api/v1/service-subscriptions/{id}": { "get": { "tags": [ - "Status Pages" + "Service Subscriptions" ], - "summary": "Get component uptime history from published incident windows", - "description": "Legacy incident-window rollup (source semantics: incident_window). Daily % is derived from published status-page incident windows, not probe checks. For measured check-based uptime use GET …/measured-uptime (ASK-SP-2 / CHG-2).", - "operationId": "componentUptime_1", + "summary": "Get a subscription by its ID", + "operationId": "get_11", "parameters": [ { "name": "id", @@ -18479,25 +19076,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "componentId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "days", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 90 - } } ], "responses": { @@ -18506,7 +19084,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultComponentUptimeDayDto" + "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" } } } @@ -18592,15 +19170,14 @@ } } } - } - }, - "/api/v1/status-pages/{id}/components/reorder": { - "put": { + }, + "delete": { "tags": [ - "Status Pages" + "Service Subscriptions" ], - "summary": "Batch reorder components (and optionally move between groups)", - "operationId": "reorderComponents", + "summary": "Remove a subscription by its ID", + "description": "Removes a specific subscription (whole-service or component-level). No-op if not found.", + "operationId": "unsubscribe_1", "parameters": [ { "name": "id", @@ -18612,16 +19189,6 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReorderComponentsRequest" - } - } - }, - "required": true - }, "responses": { "204": { "description": "No Content" @@ -18709,13 +19276,14 @@ } } }, - "/api/v1/status-pages/{id}/domains": { - "get": { + "/api/v1/service-subscriptions/{id}/alert-sensitivity": { + "patch": { "tags": [ - "Status Pages" + "Service Subscriptions" ], - "summary": "List custom domains", - "operationId": "listDomains", + "summary": "Update alert sensitivity for a subscription", + "description": "Controls which external incidents trigger alerts and whether they page anyone: ALL (any status change, paged), INCIDENTS_ONLY (real vendor incidents, paged), MAJOR_ONLY (only DOWN-level incidents, paged), AWARENESS (real vendor incidents tracked silently — visible on the dashboard but no alert channels fire; default for new subscriptions).", + "operationId": "updateAlertSensitivity", "parameters": [ { "name": "id", @@ -18727,13 +19295,23 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAlertSensitivityRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageCustomDomainDto" + "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" } } } @@ -18819,21 +19397,23 @@ } } } - }, + } + }, + "/api/v1/service-subscriptions/{slug}": { "post": { "tags": [ - "Status Pages" + "Service Subscriptions" ], - "summary": "Add a custom domain", - "operationId": "addDomain", + "summary": "Subscribe to a service or a component of a service", + "description": "Idempotent — returns the existing subscription if an identical one exists. Omit the request body or set componentId to null for a whole-service subscription. When alertSensitivity is omitted, new subscriptions default to AWARENESS (silent tracking — the incident appears on the dashboard but no alert channels fire). PATCH /alert-sensitivity to opt in to paging. Free tier: max 10 subscriptions. Paid tier: unlimited.", + "operationId": "subscribe_1", "parameters": [ { - "name": "id", + "name": "slug", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -18841,11 +19421,10 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddCustomDomainRequest" + "$ref": "#/components/schemas/ServiceSubscribeRequest" } } - }, - "required": true + } }, "responses": { "201": { @@ -18853,7 +19432,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" + "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" } } } @@ -18941,36 +19520,99 @@ } } }, - "/api/v1/status-pages/{id}/domains/{domainId}": { - "delete": { + "/api/v1/services": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Remove a custom domain", - "operationId": "removeDomain", + "summary": "List all enabled services (cursor-paginated)", + "operationId": "listServices", "parameters": [ { - "name": "id", - "in": "path", - "required": true, + "name": "category", + "in": "query", + "description": "Filter by category (exact match)", + "required": false, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "domainId", - "in": "path", - "required": true, + "name": "status", + "in": "query", + "description": "Filter by current overall_status (exact match)", + "required": false, "schema": { - "type": "string", - "format": "uuid" + "type": "string" + } + }, + { + "name": "published", + "in": "query", + "description": "Filter by published status for pSEO pages", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "slaPublished", + "in": "query", + "description": "Filter by SLA page publication status", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "search", + "in": "query", + "description": "Case-insensitive substring match on service name or slug", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "Result ordering: 'recent' (default, newest first) or 'curated' (curated/recognizable first)", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "cursor", + "in": "query", + "description": "Opaque cursor from a previous response", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Page size (1–100, default 20)", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 20 } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CursorPageServiceCatalogDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -19055,30 +19697,41 @@ } } }, - "/api/v1/status-pages/{id}/domains/{domainId}/primary": { - "post": { + "/api/v1/services/{slugOrId}": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Mark a verified custom domain as the page's primary host", - "operationId": "setPrimaryDomain", + "summary": "Get a single service by slug or UUID with current status, components, and recent incidents", + "description": "When ``summary=true``, the inline ``components`` list is trimmed to groups + showcase leaves + currently-impacted leaves + ungrouped leaves, and a ``componentsSummary`` block is added with the trimmed counts. Powers SSR for vendors with hundreds of components (Snowflake, Cloudflare, DigitalOcean) without OOM-ing the renderer. Default false for full back-compat.", + "operationId": "getService", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "domainId", - "in": "path", - "required": true, + "name": "summary", + "in": "query", + "description": "Return a curated subset of components (groups + showcase + impacted + ungrouped) and a componentsSummary block; default false", + "required": false, "schema": { - "type": "string", - "format": "uuid" + "type": "boolean", + "default": false + } + }, + { + "name": "publishedOnly", + "in": "query", + "description": "Resolve only published services (curated public pSEO set); 404 otherwise. Default false", + "required": false, + "schema": { + "type": "boolean", + "default": false } } ], @@ -19088,7 +19741,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" + "$ref": "#/components/schemas/SingleValueResponseServiceDetailDto" } } } @@ -19176,31 +19829,61 @@ } } }, - "/api/v1/status-pages/{id}/domains/{domainId}/verify": { - "post": { + "/api/v1/services/{slugOrId}/components": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Trigger domain verification check", - "operationId": "verifyDomain", + "summary": "List active components for a service with current status and inline uptime", + "description": "When ``groupId`` is supplied, only direct children of that group are returned — used by the pSEO renderer to lazy-load the leaves under a group that summary mode trimmed. Without ``groupId`` the response includes every active component for the service. Supports pagination via ``page``/``size`` and case-insensitive name search via ``search``.", + "operationId": "getComponents", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "domainId", - "in": "path", - "required": true, + "name": "groupId", + "in": "query", + "description": "Restrict result to direct children of this group component id", + "required": false, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "search", + "in": "query", + "description": "Case-insensitive substring match on component name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "Zero-based page index", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "size", + "in": "query", + "description": "Page size (default 25, max 100)", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } } ], "responses": { @@ -19209,7 +19892,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" + "$ref": "#/components/schemas/TableValueResultServiceComponentDto" } } } @@ -19297,22 +19980,66 @@ } } }, - "/api/v1/status-pages/{id}/groups": { + "/api/v1/services/{slugOrId}/components/{componentId}/uptime": { "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "List component groups with nested components", - "operationId": "listGroups", + "summary": "Get daily uptime data for a component", + "description": "Pass either ``period`` (preset window) or an explicit ``from``/``to`` calendar window (ISO yyyy-MM-dd, max 730 days, ``to`` defaults to today). When both are supplied, the explicit window wins.", + "operationId": "getComponentUptime", "parameters": [ { - "name": "id", + "name": "slugOrId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "componentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "period", + "in": "query", + "description": "Preset time window (used when ``from`` is omitted)", + "required": false, + "schema": { + "type": "string", + "enum": [ + "7d", + "30d", + "90d", + "1y" + ] + } + }, + { + "name": "from", + "in": "query", + "description": "Explicit window start (ISO date); overrides ``period``", + "required": false, + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "to", + "in": "query", + "description": "Explicit window end (ISO date); defaults to today", + "required": false, + "schema": { + "type": "string", + "format": "date" + } } ], "responses": { @@ -19321,7 +20048,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageComponentGroupDto" + "$ref": "#/components/schemas/TableValueResultComponentUptimeDayDto" } } } @@ -19407,41 +20134,68 @@ } } } - }, - "post": { + } + }, + "/api/v1/services/{slugOrId}/components/uptime": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Create a component group", - "operationId": "createGroup", + "summary": "Batch daily uptime data for all leaf components", + "description": "Returns daily uptime for every active non-group component with uptime data, keyed by component ID. Replaces N individual per-component uptime calls with a single request. Supports either a preset ``period`` or an explicit ``from``/``to`` window (ISO yyyy-MM-dd, max 730 days). The explicit window wins when both are supplied — this is what powers the sliding 90-day navigator on the public uptime history page.", + "operationId": "getBatchComponentUptime", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "period", + "in": "query", + "description": "Preset time window (used when ``from`` is omitted)", + "required": false, "schema": { "type": "string", - "format": "uuid" + "enum": [ + "7d", + "30d", + "90d", + "1y" + ] } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStatusPageComponentGroupRequest" - } + }, + { + "name": "from", + "in": "query", + "description": "Explicit window start (ISO date); overrides ``period``", + "required": false, + "schema": { + "type": "string", + "format": "date" } }, - "required": true - }, + { + "name": "to", + "in": "query", + "description": "Explicit window end (ISO date); defaults to today", + "required": false, + "schema": { + "type": "string", + "format": "date" + } + } + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentGroupDto" + "$ref": "#/components/schemas/SingleValueResponseBatchComponentUptimeDto" } } } @@ -19529,50 +20283,41 @@ } } }, - "/api/v1/status-pages/{id}/groups/{groupId}": { - "put": { + "/api/v1/services/{slugOrId}/days/{date}": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Update a component group", - "operationId": "updateGroup", + "summary": "One-day rollup for a service: aggregated uptime, per-component impacts, and overlapping incidents", + "description": "Powers the click/hover-to-expand panel under each uptime bar on the public status page. Single round-trip — components, sums, and overlapping incidents (with affected component names) are returned in one response.", + "operationId": "getServiceDayDetail", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "groupId", + "name": "date", "in": "path", + "description": "UTC calendar day in ISO format (YYYY-MM-DD)", "required": true, "schema": { "type": "string", - "format": "uuid" + "format": "date" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateStatusPageComponentGroupRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentGroupDto" + "$ref": "#/components/schemas/SingleValueResponseServiceDayDetailDto" } } } @@ -19658,152 +20403,45 @@ } } } - }, - "delete": { + } + }, + "/api/v1/services/{slugOrId}/incidents": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Delete a component group (components become ungrouped)", - "operationId": "deleteGroup", + "summary": "List incident history for a service (paginated)", + "operationId": "listIncidents_1", "parameters": [ { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "groupId", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad request — the payload failed validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden — the actor lacks permission for this resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found — the requested resource does not exist", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Conflict — the request collides with current resource state", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error — see the message field for details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad gateway — an upstream provider returned an error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "type": "string" } }, - "503": { - "description": "Service unavailable — try again shortly", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/api/v1/status-pages/{id}/incidents": { - "get": { - "tags": [ - "Status Pages" - ], - "summary": "List incidents for this status page (paginated)", - "operationId": "listIncidents", - "parameters": [ { - "name": "id", - "in": "path", - "required": true, + "name": "from", + "in": "query", + "description": "Earliest start date (ISO 8601 date)", + "required": false, "schema": { "type": "string", - "format": "uuid" + "format": "date" } }, { "name": "status", "in": "query", + "description": "Filter: active (unresolved), resolved, or omit for all", "required": false, "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" - ] - } + "type": "string", + "enum": [ + "active", + "resolved" + ] } }, { @@ -19821,7 +20459,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageIncidentDto" + "$ref": "#/components/schemas/TableValueResultServiceIncidentDto" } } } @@ -19907,16 +20545,26 @@ } } } - }, - "post": { + } + }, + "/api/v1/services/{slugOrId}/incidents/{incidentId}": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Create a status page incident (manual)", - "operationId": "createIncident", + "summary": "Get incident detail with full update timeline", + "operationId": "getIncident_1", "parameters": [ { - "name": "id", + "name": "slugOrId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "incidentId", "in": "path", "required": true, "schema": { @@ -19925,23 +20573,13 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStatusPageIncidentRequest" - } - } - }, - "required": true - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseServiceIncidentDetailDto" } } } @@ -20029,30 +20667,21 @@ } } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}": { + "/api/v1/services/{slugOrId}/live-status": { "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Get incident details with timeline", - "operationId": "getIncident", + "summary": "Lightweight live-status snapshot for polling", + "description": "Returns only the current overall status, component statuses, and active incident count. Designed for frequent polling with minimal payload.", + "operationId": "getServiceLiveStatus", "parameters": [ { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "incidentId", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -20062,7 +20691,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseServiceLiveStatusDto" } } } @@ -20148,50 +20777,44 @@ } } } - }, - "put": { + } + }, + "/api/v1/services/{slugOrId}/maintenances": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Update an incident", - "operationId": "updateIncident", + "summary": "List scheduled maintenances for a service", + "operationId": "getScheduledMaintenances", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "incidentId", - "in": "path", - "required": true, + "name": "status", + "in": "query", + "description": "Filter by status (e.g. scheduled, in_progress, verifying, completed)", + "required": false, "schema": { - "type": "string", - "format": "uuid" + "type": "array", + "items": { + "type": "string" + } } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateStatusPageIncidentRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/TableValueResultScheduledMaintenanceDto" } } } @@ -20277,36 +20900,55 @@ } } } - }, - "delete": { + } + }, + "/api/v1/services/{slugOrId}/poll-results": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Delete an incident", - "operationId": "deleteIncident", + "summary": "List poll results for a service (cursor-paginated)", + "operationId": "listPollResults", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "incidentId", - "in": "path", - "required": true, + "name": "cursor", + "in": "query", + "description": "ISO 8601 timestamp cursor from a previous response", + "required": false, "schema": { - "type": "string", - "format": "uuid" + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Page size (1–100, default 50)", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 50 } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CursorPageServicePollResultDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -20391,36 +21033,47 @@ } } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}/dismiss": { - "post": { + "/api/v1/services/{slugOrId}/poll-summary": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Dismiss a draft incident (soft-deletes: resolves without publishing)", - "operationId": "dismissIncident", + "summary": "Get aggregated poll metrics and chart data for a service", + "operationId": "getPollSummary", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "incidentId", - "in": "path", - "required": true, + "name": "window", + "in": "query", + "description": "Time window", + "required": false, "schema": { "type": "string", - "format": "uuid" + "enum": [ + "24h", + "7d", + "30d" + ] } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseServicePollSummaryDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -20505,49 +21158,94 @@ } } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}/publish": { - "post": { + "/api/v1/services/{slugOrId}/status-events": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Publish a draft incident (sets publishedAt, applies component statuses, notifies subscribers)", - "operationId": "publishIncident", + "summary": "List curated vendor status events for a service", + "description": "Reverse-chronological merge of vendor incidents, maintenances, and rolled-up component transitions for the Dependencies Detail rail. Optional JWT + x-phelm-org-id annotates incident.opened rows with the caller's linked internal incident.", + "operationId": "listStatusEvents", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "types", + "in": "query", + "description": "Comma-separated type buckets: incident, maintenance, component (default: all)", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "period", + "in": "query", + "description": "Preset window", + "required": false, "schema": { "type": "string", - "format": "uuid" + "enum": [ + "7d", + "30d", + "90d" + ] } }, { - "name": "incidentId", - "in": "path", - "required": true, + "name": "from", + "in": "query", + "description": "Explicit lower bound (ISO 8601); overrides period", + "required": false, "schema": { "type": "string", - "format": "uuid" + "format": "date-time" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublishStatusPageIncidentRequest" - } + }, + { + "name": "to", + "in": "query", + "description": "Explicit upper bound (ISO 8601); default now", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "cursor", + "in": "query", + "description": "Opaque cursor from a previous response", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Page size (1–100, default 50)", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 50 } } - }, + ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/CursorPageStatusEventDto" } } } @@ -20635,50 +21333,63 @@ } } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}/updates": { - "post": { + "/api/v1/services/{slugOrId}/uptime": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Post an incident timeline update", - "operationId": "postIncidentUpdate", + "summary": "Get uptime statistics for a service", + "description": "Uptime data aggregated across active non-group components.", + "operationId": "getServiceUptime", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "period", + "in": "query", + "description": "Time window", + "required": false, "schema": { "type": "string", - "format": "uuid" + "enum": [ + "24h", + "7d", + "30d", + "90d", + "1y", + "2y", + "all" + ] } }, { - "name": "incidentId", - "in": "path", - "required": true, + "name": "granularity", + "in": "query", + "description": "Bucket granularity", + "required": false, "schema": { "type": "string", - "format": "uuid" + "enum": [ + "hourly", + "daily", + "monthly" + ] } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStatusPageIncidentUpdateRequest" - } - } - }, - "required": true - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseServiceUptimeResponse" } } } @@ -20763,62 +21474,71 @@ } } } - } + }, + "security": [ + { + "BearerAuth": [] + } + ] } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}/updates/{updateId}": { - "patch": { + "/api/v1/services/incidents": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Edit an existing incident timeline update body", - "operationId": "patchIncidentUpdate", + "summary": "List vendor incidents across all services (paginated)", + "description": "Cross-service vendor incident feed ordered by start date descending.", + "operationId": "listCrossServiceIncidents", "parameters": [ { - "name": "id", - "in": "path", - "required": true, + "name": "from", + "in": "query", + "description": "Earliest start date (ISO 8601 date)", + "required": false, "schema": { "type": "string", - "format": "uuid" + "format": "date" } }, { - "name": "incidentId", - "in": "path", - "required": true, + "name": "status", + "in": "query", + "description": "Filter: active (unresolved), resolved, or omit for all", + "required": false, "schema": { "type": "string", - "format": "uuid" + "enum": [ + "active", + "resolved" + ] } }, { - "name": "updateId", - "in": "path", + "name": "category", + "in": "query", + "description": "Filter by service category", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "pageable", + "in": "query", "required": true, "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/Pageable" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateStatusPageIncidentUpdateRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentUpdateDto" + "$ref": "#/components/schemas/TableValueResultServiceIncidentDto" } } } @@ -20906,38 +21626,37 @@ } } }, - "/api/v1/status-pages/{id}/layout/reorder": { - "put": { + "/api/v1/services/summary": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Reorder page-level layout: groups and ungrouped components share one ordering", - "operationId": "reorderLayout", + "summary": "Global status summary across all services", + "description": "Returns aggregate counts of services by status and a list of services currently experiencing issues.", + "operationId": "getGlobalStatusSummary", "parameters": [ { - "name": "id", - "in": "path", - "required": true, + "name": "publishedOnly", + "in": "query", + "description": "Aggregate only published services (curated public pSEO set); default false", + "required": false, "schema": { - "type": "string", - "format": "uuid" + "type": "boolean", + "default": false } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReorderPageLayoutRequest" + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseGlobalStatusSummaryDto" + } } } }, - "required": true - }, - "responses": { - "204": { - "description": "No Content" - }, "400": { "description": "Bad request — the payload failed validation", "content": { @@ -21021,56 +21740,20 @@ } } }, - "/api/v1/status-pages/{id}/maintenance": { + "/api/v1/status-pages": { "get": { "tags": [ "Status Pages" ], - "summary": "List maintenance windows for this status page (paginated)", - "operationId": "listMaintenance", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "status", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" - ] - } - } - }, - { - "name": "pageable", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/Pageable" - } - } - ], + "summary": "List status pages for the workspace", + "operationId": "list_4", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageIncidentDto" + "$ref": "#/components/schemas/TableValueResultStatusPageDto" } } } @@ -21161,24 +21844,13 @@ "tags": [ "Status Pages" ], - "summary": "Schedule a maintenance window", - "operationId": "createMaintenance", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], + "summary": "Create a status page", + "operationId": "create_5", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateStatusPageMaintenanceRequest" + "$ref": "#/components/schemas/CreateStatusPageRequest" } } }, @@ -21190,7 +21862,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" } } } @@ -21278,13 +21950,13 @@ } } }, - "/api/v1/status-pages/{id}/maintenance/{windowId}": { + "/api/v1/status-pages/{id}": { "get": { "tags": [ "Status Pages" ], - "summary": "Get a maintenance window with timeline", - "operationId": "getMaintenance", + "summary": "Get a status page", + "operationId": "get_2", "parameters": [ { "name": "id", @@ -21294,15 +21966,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "windowId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "responses": { @@ -21311,7 +21974,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" } } } @@ -21402,8 +22065,8 @@ "tags": [ "Status Pages" ], - "summary": "Update a maintenance window", - "operationId": "updateMaintenance", + "summary": "Update a status page", + "operationId": "update_3", "parameters": [ { "name": "id", @@ -21413,22 +22076,13 @@ "type": "string", "format": "uuid" } - }, - { - "name": "windowId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateStatusPageIncidentRequest" + "$ref": "#/components/schemas/UpdateStatusPageRequest" } } }, @@ -21440,7 +22094,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" } } } @@ -21531,8 +22185,8 @@ "tags": [ "Status Pages" ], - "summary": "Cancel a maintenance window", - "operationId": "deleteMaintenance", + "summary": "Delete a status page", + "operationId": "delete_3", "parameters": [ { "name": "id", @@ -21542,15 +22196,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "windowId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "responses": { @@ -21640,13 +22285,13 @@ } } }, - "/api/v1/status-pages/{id}/maintenance/{windowId}/dismiss": { - "post": { + "/api/v1/status-pages/{id}/components": { + "get": { "tags": [ "Status Pages" ], - "summary": "Dismiss a draft maintenance window", - "operationId": "dismissMaintenance", + "summary": "List all components", + "operationId": "listComponents", "parameters": [ { "name": "id", @@ -21656,9 +22301,110 @@ "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultStatusPageComponentDto" + } + } + } }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Status Pages" + ], + "summary": "Add a component to the status page", + "operationId": "createComponent", + "parameters": [ { - "name": "windowId", + "name": "id", "in": "path", "required": true, "schema": { @@ -21667,9 +22413,26 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateStatusPageComponentRequest" + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "No Content" + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -21754,13 +22517,13 @@ } } }, - "/api/v1/status-pages/{id}/maintenance/{windowId}/publish": { - "post": { + "/api/v1/status-pages/{id}/components/{componentId}": { + "put": { "tags": [ "Status Pages" ], - "summary": "Publish a draft maintenance window", - "operationId": "publishMaintenance", + "summary": "Update a component", + "operationId": "updateComponent", "parameters": [ { "name": "id", @@ -21772,7 +22535,7 @@ } }, { - "name": "windowId", + "name": "componentId", "in": "path", "required": true, "schema": { @@ -21785,10 +22548,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PublishStatusPageIncidentRequest" + "$ref": "#/components/schemas/UpdateStatusPageComponentRequest" } } - } + }, + "required": true }, "responses": { "200": { @@ -21796,7 +22560,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" } } } @@ -21882,15 +22646,13 @@ } } } - } - }, - "/api/v1/status-pages/{id}/maintenance/{windowId}/updates": { - "post": { + }, + "delete": { "tags": [ "Status Pages" ], - "summary": "Post a maintenance window timeline update", - "operationId": "postMaintenanceUpdate", + "summary": "Remove a component from the status page", + "operationId": "deleteComponent", "parameters": [ { "name": "id", @@ -21902,7 +22664,7 @@ } }, { - "name": "windowId", + "name": "componentId", "in": "path", "required": true, "schema": { @@ -21911,26 +22673,9 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStatusPageIncidentUpdateRequest" - } - } - }, - "required": true - }, "responses": { - "201": { - "description": "Created", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -22015,13 +22760,14 @@ } } }, - "/api/v1/status-pages/{id}/maintenance/{windowId}/updates/{updateId}": { - "patch": { + "/api/v1/status-pages/{id}/components/{componentId}/measured-uptime": { + "get": { "tags": [ "Status Pages" ], - "summary": "Edit an existing maintenance timeline update body", - "operationId": "patchMaintenanceUpdate", + "summary": "Get measured (check-based) component uptime history", + "description": "Additive measured daily uptime for MONITOR components (ASK-SP-2 / CHG-2). Reads time-bounded check_results_daily rollups for the linked monitor. Response source is always measured. Does not change legacy GET …/uptime incident-window semantics. days default 90, max 365.", + "operationId": "componentMeasuredUptime", "parameters": [ { "name": "id", @@ -22033,7 +22779,7 @@ } }, { - "name": "windowId", + "name": "componentId", "in": "path", "required": true, "schema": { @@ -22042,32 +22788,23 @@ } }, { - "name": "updateId", - "in": "path", - "required": true, + "name": "days", + "in": "query", + "required": false, "schema": { - "type": "string", - "format": "uuid" + "type": "integer", + "format": "int32", + "default": 90 } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateStatusPageIncidentUpdateRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentUpdateDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageMeasuredComponentUptimeDto" } } } @@ -22155,14 +22892,14 @@ } } }, - "/api/v1/status-pages/{id}/notification-deliveries": { - "get": { + "/api/v1/status-pages/{id}/components/{componentId}/override": { + "put": { "tags": [ "Status Pages" ], - "summary": "List notification delivery receipts", - "description": "Returns delivery rows for this status page (newest first). Optional filters: incidentId, eventType.", - "operationId": "listNotificationDeliveries", + "summary": "Set a timed human status override on a component", + "description": "ASK-SP-1 / CHG-1. Effective currentStatus reflects the override until expiry or clear, unless an active incident takes precedence (incident > override > binding). Max expiry horizon is 24 hours.", + "operationId": "setComponentOverride", "parameters": [ { "name": "id", @@ -22174,36 +22911,32 @@ } }, { - "name": "incidentId", - "in": "query", - "required": false, + "name": "componentId", + "in": "path", + "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "eventType", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "SUBSCRIPTION_CONFIRMATION", - "INCIDENT_CREATED", - "INCIDENT_UPDATED", - "INCIDENT_RESOLVED" - ] - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetStatusPageComponentOverrideRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageNotificationDeliveryDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" } } } @@ -22289,15 +23022,13 @@ } } } - } - }, - "/api/v1/status-pages/{id}/notification-deliveries/{deliveryId}": { - "get": { + }, + "delete": { "tags": [ "Status Pages" ], - "summary": "Get a notification delivery receipt", - "operationId": "getNotificationDelivery", + "summary": "Clear a timed human status override on a component", + "operationId": "clearComponentOverride", "parameters": [ { "name": "id", @@ -22309,7 +23040,7 @@ } }, { - "name": "deliveryId", + "name": "componentId", "in": "path", "required": true, "schema": { @@ -22324,7 +23055,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageNotificationDeliveryDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" } } } @@ -22412,14 +23143,14 @@ } } }, - "/api/v1/status-pages/{id}/notification-deliveries/{deliveryId}/retry": { - "post": { + "/api/v1/status-pages/{id}/components/{componentId}/uptime": { + "get": { "tags": [ "Status Pages" ], - "summary": "Retry a failed notification delivery", - "description": "Queues a FAILED delivery for another attempt. Refuses terminal attempt_count (~5). Idempotent when already RETRY_PENDING.", - "operationId": "retryNotificationDelivery", + "summary": "Get component uptime history from published incident windows", + "description": "Legacy incident-window rollup (source semantics: incident_window). Daily % is derived from published status-page incident windows, not probe checks. For measured check-based uptime use GET …/measured-uptime (ASK-SP-2 / CHG-2).", + "operationId": "componentUptime_1", "parameters": [ { "name": "id", @@ -22431,119 +23162,7 @@ } }, { - "name": "deliveryId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageNotificationDeliveryDto" - } - } - } - }, - "400": { - "description": "Bad request — the payload failed validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden — the actor lacks permission for this resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found — the requested resource does not exist", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Conflict — the request collides with current resource state", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error — see the message field for details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad gateway — an upstream provider returned an error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable — try again shortly", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/api/v1/status-pages/{id}/subscribers": { - "get": { - "tags": [ - "Status Pages" - ], - "summary": "List subscribers including awaiting confirmation (paginated)", - "operationId": "listSubscribers", - "parameters": [ - { - "name": "id", + "name": "componentId", "in": "path", "required": true, "schema": { @@ -22552,11 +23171,13 @@ } }, { - "name": "pageable", + "name": "days", "in": "query", - "required": true, + "required": false, "schema": { - "$ref": "#/components/schemas/Pageable" + "type": "integer", + "format": "int32", + "default": 90 } } ], @@ -22566,7 +23187,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageSubscriberDto" + "$ref": "#/components/schemas/TableValueResultComponentUptimeDayDto" } } } @@ -22652,13 +23273,15 @@ } } } - }, - "post": { + } + }, + "/api/v1/status-pages/{id}/components/reorder": { + "put": { "tags": [ "Status Pages" ], - "summary": "Add a subscriber; requireConfirmation=true for EMAIL double opt-in, omit/false confirms immediately", - "operationId": "addSubscriber", + "summary": "Batch reorder components (and optionally move between groups)", + "operationId": "reorderComponents", "parameters": [ { "name": "id", @@ -22674,22 +23297,15 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AdminAddSubscriberRequest" + "$ref": "#/components/schemas/ReorderComponentsRequest" } } }, "required": true }, "responses": { - "201": { - "description": "Created", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageSubscriberDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -22774,13 +23390,13 @@ } } }, - "/api/v1/status-pages/{id}/subscribers/{subscriberId}": { - "delete": { + "/api/v1/status-pages/{id}/domains": { + "get": { "tags": [ "Status Pages" ], - "summary": "Remove a subscriber", - "operationId": "removeSubscriber", + "summary": "List custom domains", + "operationId": "listDomains", "parameters": [ { "name": "id", @@ -22790,119 +23406,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "subscriberId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad request — the payload failed validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden — the actor lacks permission for this resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found — the requested resource does not exist", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Conflict — the request collides with current resource state", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error — see the message field for details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad gateway — an upstream provider returned an error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable — try again shortly", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/api/v1/tags": { - "get": { - "tags": [ - "Tags" - ], - "summary": "List tags for the authenticated organization", - "operationId": "list_3", - "parameters": [ - { - "name": "pageable", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/Pageable" - } } ], "responses": { @@ -22911,7 +23414,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultTagDto" + "$ref": "#/components/schemas/TableValueResultStatusPageCustomDomainDto" } } } @@ -23000,15 +23503,26 @@ }, "post": { "tags": [ - "Tags" + "Status Pages" + ], + "summary": "Add a custom domain", + "operationId": "addDomain", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Create a new tag", - "operationId": "create_4", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateTagRequest" + "$ref": "#/components/schemas/AddCustomDomainRequest" } } }, @@ -23020,7 +23534,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseTagDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" } } } @@ -23108,13 +23622,13 @@ } } }, - "/api/v1/tags/{id}": { - "get": { + "/api/v1/status-pages/{id}/domains/{domainId}": { + "delete": { "tags": [ - "Tags" + "Status Pages" ], - "summary": "Get a tag by ID", - "operationId": "getById", + "summary": "Remove a custom domain", + "operationId": "removeDomain", "parameters": [ { "name": "id", @@ -23124,18 +23638,20 @@ "type": "string", "format": "uuid" } + }, + { + "name": "domainId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseTagDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -23218,13 +23734,15 @@ } } } - }, - "put": { + } + }, + "/api/v1/status-pages/{id}/domains/{domainId}/primary": { + "post": { "tags": [ - "Tags" + "Status Pages" ], - "summary": "Update a tag's name and/or color", - "operationId": "update_2", + "summary": "Mark a verified custom domain as the page's primary host", + "operationId": "setPrimaryDomain", "parameters": [ { "name": "id", @@ -23234,25 +23752,24 @@ "type": "string", "format": "uuid" } + }, + { + "name": "domainId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateTagRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseTagDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" } } } @@ -23338,13 +23855,15 @@ } } } - }, - "delete": { + } + }, + "/api/v1/status-pages/{id}/domains/{domainId}/verify": { + "post": { "tags": [ - "Tags" + "Status Pages" ], - "summary": "Delete a tag (cascades to all monitor associations)", - "operationId": "delete_2", + "summary": "Trigger domain verification check", + "operationId": "verifyDomain", "parameters": [ { "name": "id", @@ -23354,11 +23873,27 @@ "type": "string", "format": "uuid" } + }, + { + "name": "domainId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -23443,122 +23978,21 @@ } } }, - "/api/v1/vaults/rotate": { - "post": { - "tags": [ - "Vault" - ], - "summary": "Rotate DEK", - "description": "Generates a new Data Encryption Key, re-encrypts all secrets and alert-channel configs, and bumps the vault version. Admin-only. Pipeline DEK caches expire within ~10 minutes.", - "operationId": "rotateDek", - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseDekRotationResultDto" - } - } - } - }, - "400": { - "description": "Bad request — the payload failed validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden — the actor lacks permission for this resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found — the requested resource does not exist", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "409": { - "description": "Conflict — the request collides with current resource state", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error — see the message field for details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad gateway — an upstream provider returned an error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable — try again shortly", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - } - } - }, - "/api/v1/webhooks": { + "/api/v1/status-pages/{id}/groups": { "get": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "List webhook endpoints for the authenticated org", - "operationId": "list_2", + "summary": "List component groups with nested components", + "operationId": "listGroups", "parameters": [ { - "name": "pageable", - "in": "query", + "name": "id", + "in": "path", "required": true, "schema": { - "$ref": "#/components/schemas/Pageable" + "type": "string", + "format": "uuid" } } ], @@ -23568,7 +24002,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultWebhookEndpointDto" + "$ref": "#/components/schemas/TableValueResultStatusPageComponentGroupDto" } } } @@ -23657,15 +24091,26 @@ }, "post": { "tags": [ - "Webhooks" + "Status Pages" + ], + "summary": "Create a component group", + "operationId": "createGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Register a new webhook endpoint", - "operationId": "create_3", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateWebhookEndpointRequest" + "$ref": "#/components/schemas/CreateStatusPageComponentGroupRequest" } } }, @@ -23677,7 +24122,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentGroupDto" } } } @@ -23765,13 +24210,13 @@ } } }, - "/api/v1/webhooks/{id}": { - "get": { + "/api/v1/status-pages/{id}/groups/{groupId}": { + "put": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Get a single webhook endpoint", - "operationId": "get_1", + "summary": "Update a component group", + "operationId": "updateGroup", "parameters": [ { "name": "id", @@ -23781,15 +24226,34 @@ "type": "string", "format": "uuid" } + }, + { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateStatusPageComponentGroupRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentGroupDto" } } } @@ -23876,12 +24340,12 @@ } } }, - "put": { + "delete": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Update a webhook endpoint", - "operationId": "update_1", + "summary": "Delete a component group (components become ungrouped)", + "operationId": "deleteGroup", "parameters": [ { "name": "id", @@ -23891,28 +24355,20 @@ "type": "string", "format": "uuid" } + }, + { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateWebhookEndpointRequest" - } - } - }, - "required": true - }, "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -23995,13 +24451,15 @@ } } } - }, - "delete": { + } + }, + "/api/v1/status-pages/{id}/incidents": { + "get": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Delete a webhook endpoint", - "operationId": "delete_1", + "summary": "List incidents for this status page (paginated)", + "operationId": "listIncidents", "parameters": [ { "name": "id", @@ -24011,11 +24469,43 @@ "type": "string", "format": "uuid" } + }, + { + "name": "status", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] + } + } + }, + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" + } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultStatusPageIncidentDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -24098,15 +24588,13 @@ } } } - } - }, - "/api/v1/webhooks/{id}/deliveries": { - "get": { + }, + "post": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "List recent deliveries for a webhook endpoint", - "operationId": "listDeliveries", + "summary": "Create a status page incident (manual)", + "operationId": "createIncident", "parameters": [ { "name": "id", @@ -24116,25 +24604,25 @@ "type": "string", "format": "uuid" } - }, - { - "name": "limit", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateStatusPageIncidentRequest" + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultWebhookDeliveryDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -24222,13 +24710,13 @@ } } }, - "/api/v1/webhooks/{id}/test": { - "post": { + "/api/v1/status-pages/{id}/incidents/{incidentId}": { + "get": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Send a test delivery to a webhook endpoint", - "operationId": "test", + "summary": "Get incident details with timeline", + "operationId": "getIncident", "parameters": [ { "name": "id", @@ -24238,24 +24726,24 @@ "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestWebhookEndpointRequest" - } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookTestResult" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -24341,23 +24829,50 @@ } } } - } - }, - "/api/v1/webhooks/events": { - "get": { + }, + "put": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "List all available webhook event types", - "description": "Returns the full catalog of supported outbound webhook event types with their surface grouping and human-readable descriptions. Use this to populate subscription checkboxes when creating or updating a webhook endpoint.", - "operationId": "listEvents", + "summary": "Update an incident", + "operationId": "updateIncident", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateStatusPageIncidentRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/WebhookEventCatalogResponse" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -24443,25 +24958,36 @@ } } } - } - }, - "/api/v1/webhooks/signing-secret": { - "get": { + }, + "delete": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Get signing secret metadata for the authenticated org", - "operationId": "getSigningSecretInfo", - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookSigningSecretDto" - } - } + "summary": "Delete an incident", + "operationId": "deleteIncident", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } + } + ], + "responses": { + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -24546,24 +25072,37 @@ } } }, - "/api/v1/webhooks/signing-secret/rotate": { + "/api/v1/status-pages/{id}/incidents/{incidentId}/dismiss": { "post": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Generate or rotate the organization webhook signing secret", - "operationId": "rotateSigningSecret", - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseString" - } - } + "summary": "Dismiss a draft incident (soft-deletes: resolves without publishing)", + "operationId": "dismissIncident", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, "400": { "description": "Bad request — the payload failed validation", "content": { @@ -24647,30 +25186,49 @@ } } }, - "/api/v1/workspaces": { - "get": { + "/api/v1/status-pages/{id}/incidents/{incidentId}/publish": { + "post": { "tags": [ - "Workspaces" + "Status Pages" ], - "summary": "List workspaces", - "operationId": "list_1", + "summary": "Publish a draft incident (sets publishedAt, applies component statuses, notifies subscribers)", + "operationId": "publishIncident", "parameters": [ { - "name": "pageable", - "in": "query", + "name": "id", + "in": "path", "required": true, "schema": { - "$ref": "#/components/schemas/Pageable" + "type": "string", + "format": "uuid" + } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublishStatusPageIncidentRequest" + } + } + } + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultWorkspaceDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -24756,18 +25314,40 @@ } } } - }, + } + }, + "/api/v1/status-pages/{id}/incidents/{incidentId}/updates": { "post": { "tags": [ - "Workspaces" + "Status Pages" + ], + "summary": "Post an incident timeline update", + "operationId": "postIncidentUpdate", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Create workspace", - "operationId": "create_2", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateWorkspaceRequest" + "$ref": "#/components/schemas/CreateStatusPageIncidentUpdateRequest" } } }, @@ -24779,7 +25359,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWorkspaceDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -24867,31 +25447,59 @@ } } }, - "/api/v1/workspaces/{workspaceId}": { - "get": { + "/api/v1/status-pages/{id}/incidents/{incidentId}/updates/{updateId}": { + "patch": { "tags": [ - "Workspaces" + "Status Pages" ], - "summary": "Get workspace by ID", - "operationId": "get", + "summary": "Edit an existing incident timeline update body", + "operationId": "patchIncidentUpdate", "parameters": [ { - "name": "workspaceId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "uuid" + } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "updateId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateStatusPageIncidentUpdateRequest" + } + } + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWorkspaceDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentUpdateDto" } } } @@ -24977,21 +25585,23 @@ } } } - }, + } + }, + "/api/v1/status-pages/{id}/layout/reorder": { "put": { "tags": [ - "Workspaces" + "Status Pages" ], - "summary": "Update workspace", - "operationId": "update", + "summary": "Reorder page-level layout: groups and ungrouped components share one ordering", + "operationId": "reorderLayout", "parameters": [ { - "name": "workspaceId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "uuid" } } ], @@ -24999,19 +25609,149 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateWorkspaceRequest" + "$ref": "#/components/schemas/ReorderPageLayoutRequest" } } }, "required": true }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/maintenance": { + "get": { + "tags": [ + "Status Pages" + ], + "summary": "List maintenance windows for this status page (paginated)", + "operationId": "listMaintenance", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "status", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] + } + } + }, + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" + } + } + ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWorkspaceDto" + "$ref": "#/components/schemas/TableValueResultStatusPageIncidentDto" } } } @@ -25098,26 +25838,43 @@ } } }, - "delete": { + "post": { "tags": [ - "Workspaces" + "Status Pages" ], - "summary": "Delete workspace", - "operationId": "delete", + "summary": "Schedule a maintenance window", + "operationId": "createMaintenance", "parameters": [ { - "name": "workspaceId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateStatusPageMaintenanceRequest" + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "No Content" + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -25201,204 +25958,4128 @@ } } } - } - }, - "components": { - "schemas": { - "AcknowledgeAllIncidentsResponse": { - "required": [ - "acknowledged", - "skipped" + }, + "/api/v1/status-pages/{id}/maintenance/{windowId}": { + "get": { + "tags": [ + "Status Pages" ], - "type": "object", - "properties": { - "acknowledged": { - "type": "array", - "description": "Dispatches successfully acknowledged in this request", - "items": { - "$ref": "#/components/schemas/NotificationDispatchDto" + "summary": "Get a maintenance window with timeline", + "operationId": "getMaintenance", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "skipped": { - "type": "array", - "description": "Dispatches skipped (already acked or not in an acknowledgeable state)", - "items": { - "$ref": "#/components/schemas/SkippedDispatch" + { + "name": "windowId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, - "description": "Result of acknowledging all acknowledgeable dispatches for an incident" - }, - "AcquireDeployLockRequest": { - "required": [ - "lockedBy" - ], - "type": "object", - "properties": { - "lockedBy": { - "minLength": 1, - "type": "string", - "description": "Identity of the lock requester (e.g. hostname, CI job ID)" - }, - "ttlMinutes": { - "type": "integer", - "description": "Lock TTL in minutes (default: 30, max: 60)", - "format": "int32", - "nullable": true, - "example": 30 - } - }, - "description": "Request to acquire a deploy lock for the current workspace" - }, - "AddCustomDomainRequest": { - "required": [ - "hostname" ], - "type": "object", - "properties": { - "hostname": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$", - "type": "string", - "description": "Custom hostname, e.g. status.acme.com" - } - } - }, - "AddIncidentUpdateRequest": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "Update message or post-mortem notes", - "nullable": true + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + } + } + } }, - "newStatus": { - "type": "string", - "description": "Updated incident status; null to keep current status", - "nullable": true, - "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" - ] + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "notifySubscribers": { - "type": "boolean", - "description": "Whether to notify subscribers of this update" - } - }, - "required": [ - "notifySubscribers" - ] - }, - "AddMonitorTagsRequest": { - "type": "object", - "properties": { - "tagIds": { - "type": "array", - "description": "IDs of existing org tags to attach", - "nullable": true, - "items": { - "type": "string", - "description": "IDs of existing org tags to attach", - "format": "uuid" + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } } }, - "newTags": { - "type": "array", - "description": "New tags to create (if not already present) and attach", - "nullable": true, - "items": { - "$ref": "#/components/schemas/NewTagRequest" + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } } - } - }, - "description": "Request body for adding tags to a monitor. Provide existing tag IDs, inline new tags, or both." - }, - "AddResourceGroupMemberRequest": { - "required": [ - "memberId", - "memberType" - ], - "type": "object", - "properties": { - "memberType": { - "minLength": 1, - "pattern": "monitor|service", - "type": "string", - "description": "Type of member: 'monitor' or 'service'" }, - "memberId": { - "type": "string", - "description": "ID of the monitor or service to add", - "format": "uuid" - } - }, - "description": "Request body for adding a member to a resource group" - }, - "AdminAddSubscriberRequest": { - "type": "object", - "properties": { - "email": { - "maxLength": 320, - "minLength": 0, - "type": "string", - "description": "Email for EMAIL channel; legacy clients may send only this", - "format": "email", - "nullable": true + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "channel": { - "type": "string", - "description": "Delivery channel (default: EMAIL)", - "nullable": true, - "enum": [ - "EMAIL", - "SMS", - "WEBHOOK" - ] + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "destination": { - "maxLength": 2048, - "minLength": 0, - "type": "string", - "description": "Channel destination (email, phone, or webhook URL)", - "nullable": true + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "componentIds": { - "type": "array", - "description": "Component IDs to scope; omit to leave existing scope; empty list widens to the whole page", - "nullable": true, - "items": { - "type": "string", - "description": "Component IDs to scope; omit to leave existing scope; empty list widens to the whole page", - "format": "uuid" + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } } }, - "requireConfirmation": { - "type": "boolean", - "description": "When true (EMAIL only), create unconfirmed and send opt-in; null/false confirms immediately", - "nullable": true + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } } }, - "AffectedComponent": { - "required": [ - "componentId", - "status" + "put": { + "tags": [ + "Status Pages" ], - "type": "object", - "properties": { - "componentId": { - "type": "string", - "description": "Status page component ID", - "format": "uuid" - }, - "status": { - "type": "string", - "description": "Component status during this incident", - "enum": [ + "summary": "Update a maintenance window", + "operationId": "updateMaintenance", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "windowId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateStatusPageIncidentRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Status Pages" + ], + "summary": "Cancel a maintenance window", + "operationId": "deleteMaintenance", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "windowId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/maintenance/{windowId}/dismiss": { + "post": { + "tags": [ + "Status Pages" + ], + "summary": "Dismiss a draft maintenance window", + "operationId": "dismissMaintenance", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "windowId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/maintenance/{windowId}/publish": { + "post": { + "tags": [ + "Status Pages" + ], + "summary": "Publish a draft maintenance window", + "operationId": "publishMaintenance", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "windowId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublishStatusPageIncidentRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/maintenance/{windowId}/updates": { + "post": { + "tags": [ + "Status Pages" + ], + "summary": "Post a maintenance window timeline update", + "operationId": "postMaintenanceUpdate", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "windowId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateStatusPageIncidentUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/maintenance/{windowId}/updates/{updateId}": { + "patch": { + "tags": [ + "Status Pages" + ], + "summary": "Edit an existing maintenance timeline update body", + "operationId": "patchMaintenanceUpdate", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "windowId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "updateId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateStatusPageIncidentUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentUpdateDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/notification-deliveries": { + "get": { + "tags": [ + "Status Pages" + ], + "summary": "List notification delivery receipts", + "description": "Returns delivery rows for this status page (newest first). Optional filters: incidentId, eventType.", + "operationId": "listNotificationDeliveries", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "incidentId", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "eventType", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "SUBSCRIPTION_CONFIRMATION", + "INCIDENT_CREATED", + "INCIDENT_UPDATED", + "INCIDENT_RESOLVED" + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultStatusPageNotificationDeliveryDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/notification-deliveries/{deliveryId}": { + "get": { + "tags": [ + "Status Pages" + ], + "summary": "Get a notification delivery receipt", + "operationId": "getNotificationDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "deliveryId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageNotificationDeliveryDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/notification-deliveries/{deliveryId}/retry": { + "post": { + "tags": [ + "Status Pages" + ], + "summary": "Retry a failed notification delivery", + "description": "Queues a FAILED delivery for another attempt. Refuses terminal attempt_count (~5). Idempotent when already RETRY_PENDING.", + "operationId": "retryNotificationDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "deliveryId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageNotificationDeliveryDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/subscribers": { + "get": { + "tags": [ + "Status Pages" + ], + "summary": "List subscribers including awaiting confirmation (paginated)", + "operationId": "listSubscribers", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultStatusPageSubscriberDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Status Pages" + ], + "summary": "Add a subscriber; requireConfirmation=true for EMAIL double opt-in, omit/false confirms immediately", + "operationId": "addSubscriber", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdminAddSubscriberRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageSubscriberDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/status-pages/{id}/subscribers/{subscriberId}": { + "delete": { + "tags": [ + "Status Pages" + ], + "summary": "Remove a subscriber", + "operationId": "removeSubscriber", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "subscriberId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/tags": { + "get": { + "tags": [ + "Tags" + ], + "summary": "List tags for the authenticated organization", + "operationId": "list_3", + "parameters": [ + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultTagDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Tags" + ], + "summary": "Create a new tag", + "operationId": "create_4", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTagRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseTagDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/tags/{id}": { + "get": { + "tags": [ + "Tags" + ], + "summary": "Get a tag by ID", + "operationId": "getById", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseTagDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Tags" + ], + "summary": "Update a tag's name and/or color", + "operationId": "update_2", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTagRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseTagDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "summary": "Delete a tag (cascades to all monitor associations)", + "operationId": "delete_2", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/vaults/rotate": { + "post": { + "tags": [ + "Vault" + ], + "summary": "Rotate DEK", + "description": "Generates a new Data Encryption Key, re-encrypts all secrets and alert-channel configs, and bumps the vault version. Admin-only. Pipeline DEK caches expire within ~10 minutes.", + "operationId": "rotateDek", + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseDekRotationResultDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/webhooks": { + "get": { + "tags": [ + "Webhooks" + ], + "summary": "List webhook endpoints for the authenticated org", + "operationId": "list_2", + "parameters": [ + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultWebhookEndpointDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Webhooks" + ], + "summary": "Register a new webhook endpoint", + "operationId": "create_3", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateWebhookEndpointRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/webhooks/{id}": { + "get": { + "tags": [ + "Webhooks" + ], + "summary": "Get a single webhook endpoint", + "operationId": "get_1", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Webhooks" + ], + "summary": "Update a webhook endpoint", + "operationId": "update_1", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWebhookEndpointRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Webhooks" + ], + "summary": "Delete a webhook endpoint", + "operationId": "delete_1", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/webhooks/{id}/deliveries": { + "get": { + "tags": [ + "Webhooks" + ], + "summary": "List recent deliveries for a webhook endpoint", + "operationId": "listDeliveries", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 20 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultWebhookDeliveryDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/webhooks/{id}/test": { + "post": { + "tags": [ + "Webhooks" + ], + "summary": "Send a test delivery to a webhook endpoint", + "operationId": "test", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestWebhookEndpointRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseWebhookTestResult" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/webhooks/events": { + "get": { + "tags": [ + "Webhooks" + ], + "summary": "List all available webhook event types", + "description": "Returns the full catalog of supported outbound webhook event types with their surface grouping and human-readable descriptions. Use this to populate subscription checkboxes when creating or updating a webhook endpoint.", + "operationId": "listEvents", + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WebhookEventCatalogResponse" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/webhooks/signing-secret": { + "get": { + "tags": [ + "Webhooks" + ], + "summary": "Get signing secret metadata for the authenticated org", + "operationId": "getSigningSecretInfo", + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseWebhookSigningSecretDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/webhooks/signing-secret/rotate": { + "post": { + "tags": [ + "Webhooks" + ], + "summary": "Generate or rotate the organization webhook signing secret", + "operationId": "rotateSigningSecret", + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseString" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "summary": "List workspaces", + "operationId": "list_1", + "parameters": [ + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TableValueResultWorkspaceDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "Workspaces" + ], + "summary": "Create workspace", + "operationId": "create_2", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateWorkspaceRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseWorkspaceDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/workspaces/{workspaceId}": { + "get": { + "tags": [ + "Workspaces" + ], + "summary": "Get workspace by ID", + "operationId": "get", + "parameters": [ + { + "name": "workspaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseWorkspaceDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "summary": "Update workspace", + "operationId": "update", + "parameters": [ + { + "name": "workspaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWorkspaceRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseWorkspaceDto" + } + } + } + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "summary": "Delete workspace", + "operationId": "delete", + "parameters": [ + { + "name": "workspaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "503": { + "description": "Service unavailable — try again shortly", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "AcknowledgeAllIncidentsResponse": { + "required": [ + "acknowledged", + "skipped" + ], + "type": "object", + "properties": { + "acknowledged": { + "type": "array", + "description": "Dispatches successfully acknowledged in this request", + "items": { + "$ref": "#/components/schemas/NotificationDispatchDto" + } + }, + "skipped": { + "type": "array", + "description": "Dispatches skipped (already acked or not in an acknowledgeable state)", + "items": { + "$ref": "#/components/schemas/SkippedDispatch" + } + } + }, + "description": "Result of acknowledging all acknowledgeable dispatches for an incident" + }, + "AcquireDeployLockRequest": { + "required": [ + "lockedBy" + ], + "type": "object", + "properties": { + "lockedBy": { + "minLength": 1, + "type": "string", + "description": "Identity of the lock requester (e.g. hostname, CI job ID)" + }, + "ttlMinutes": { + "type": "integer", + "description": "Lock TTL in minutes (default: 30, max: 60)", + "format": "int32", + "nullable": true, + "example": 30 + } + }, + "description": "Request to acquire a deploy lock for the current workspace" + }, + "AddCustomDomainRequest": { + "required": [ + "hostname" + ], + "type": "object", + "properties": { + "hostname": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$", + "type": "string", + "description": "Custom hostname, e.g. status.acme.com" + } + } + }, + "AddIncidentUpdateRequest": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "Update message or post-mortem notes", + "nullable": true + }, + "newStatus": { + "type": "string", + "description": "Updated incident status; null to keep current status", + "nullable": true, + "enum": [ + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" + ] + }, + "notifySubscribers": { + "type": "boolean", + "description": "Whether to notify subscribers of this update" + } + }, + "required": [ + "notifySubscribers" + ] + }, + "AddMonitorTagsRequest": { + "type": "object", + "properties": { + "tagIds": { + "type": "array", + "description": "IDs of existing org tags to attach", + "nullable": true, + "items": { + "type": "string", + "description": "IDs of existing org tags to attach", + "format": "uuid" + } + }, + "newTags": { + "type": "array", + "description": "New tags to create (if not already present) and attach", + "nullable": true, + "items": { + "$ref": "#/components/schemas/NewTagRequest" + } + } + }, + "description": "Request body for adding tags to a monitor. Provide existing tag IDs, inline new tags, or both." + }, + "AddResourceGroupMemberRequest": { + "required": [ + "memberId", + "memberType" + ], + "type": "object", + "properties": { + "memberType": { + "minLength": 1, + "pattern": "monitor|service", + "type": "string", + "description": "Type of member: 'monitor' or 'service'" + }, + "memberId": { + "type": "string", + "description": "ID of the monitor or service to add", + "format": "uuid" + } + }, + "description": "Request body for adding a member to a resource group" + }, + "AdminAddSubscriberRequest": { + "type": "object", + "properties": { + "email": { + "maxLength": 320, + "minLength": 0, + "type": "string", + "description": "Email for EMAIL channel; legacy clients may send only this", + "format": "email", + "nullable": true + }, + "channel": { + "type": "string", + "description": "Delivery channel (default: EMAIL)", + "nullable": true, + "enum": [ + "EMAIL", + "SMS", + "WEBHOOK" + ] + }, + "destination": { + "maxLength": 2048, + "minLength": 0, + "type": "string", + "description": "Channel destination (email, phone, or webhook URL)", + "nullable": true + }, + "componentIds": { + "type": "array", + "description": "Component IDs to scope; omit to leave existing scope; empty list widens to the whole page", + "nullable": true, + "items": { + "type": "string", + "description": "Component IDs to scope; omit to leave existing scope; empty list widens to the whole page", + "format": "uuid" + } + }, + "requireConfirmation": { + "type": "boolean", + "description": "When true (EMAIL only), create unconfirmed and send opt-in; null/false confirms immediately", + "nullable": true + } + } + }, + "AffectedComponent": { + "required": [ + "componentId", + "status" + ], + "type": "object", + "properties": { + "componentId": { + "type": "string", + "description": "Status page component ID", + "format": "uuid" + }, + "status": { + "type": "string", + "description": "Component status during this incident", + "enum": [ "OPERATIONAL", "DEGRADED_PERFORMANCE", "PARTIAL_OUTAGE", @@ -25407,3497 +30088,4803 @@ ] } }, - "description": "Updated affected components; null preserves current" + "description": "Updated affected components; null preserves current" + }, + "AlertChannelDisplayConfig": { + "type": "object", + "properties": { + "recipients": { + "type": "array", + "description": "Email recipients list (email channels)", + "nullable": true, + "items": { + "type": "string", + "description": "Email recipients list (email channels)" + } + }, + "region": { + "type": "string", + "description": "OpsGenie API region: us or eu", + "nullable": true + }, + "severityOverride": { + "type": "string", + "description": "PagerDuty severity override (critical, error, warning, info)", + "nullable": true + }, + "mentionRoleId": { + "type": "string", + "description": "Discord role ID to mention in notifications", + "nullable": true + }, + "customHeaders": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Custom HTTP headers for webhook requests", + "nullable": true + }, + "description": "Custom HTTP headers for webhook requests", + "nullable": true + }, + "chatId": { + "type": "string", + "description": "Telegram chat ID", + "nullable": true + }, + "priority": { + "type": "string", + "description": "Pushover notification priority override", + "nullable": true + }, + "channel": { + "type": "string", + "description": "Mattermost channel override", + "nullable": true + }, + "routingKey": { + "type": "string", + "description": "Splunk On-Call routing key", + "nullable": true + }, + "deviceIden": { + "type": "string", + "description": "Pushbullet target device identifier", + "nullable": true + }, + "teamId": { + "type": "string", + "description": "Linear team ID for issue creation", + "nullable": true + }, + "visibility": { + "type": "string", + "description": "incident.io incident visibility", + "nullable": true + }, + "severity": { + "type": "string", + "description": "Rootly incident severity slug", + "nullable": true + }, + "site": { + "type": "string", + "description": "Datadog site region", + "nullable": true + }, + "projectKey": { + "type": "string", + "description": "Jira project key", + "nullable": true + }, + "phoneNumber": { + "type": "string", + "description": "Recipient phone number in E.164 format (SMS / phone-call channels)", + "nullable": true + }, + "verifiedPhoneNumberId": { + "type": "integer", + "description": "Id of the org verified_phone_number row bound to this channel", + "format": "int64", + "nullable": true + }, + "phoneNumbers": { + "type": "array", + "description": "Deprecated mirror of phoneNumber as a length-1 list for older clients", + "nullable": true, + "items": { + "type": "string", + "description": "Deprecated mirror of phoneNumber as a length-1 list for older clients" + } + }, + "voiceLanguage": { + "type": "string", + "description": "BCP-47 voice language for phone-call TTS (e.g. en-US, de-DE)", + "nullable": true + }, + "preferredLanguage": { + "type": "string", + "description": "Preferred language for SMS/voice (BCP-47, e.g. en-US, de-DE)", + "nullable": true + } + }, + "description": "Non-sensitive alert channel configuration metadata" + }, + "AlertChannelDto": { + "required": [ + "channelType", + "createdAt", + "enabled", + "id", + "name", + "updatedAt" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique alert channel identifier", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "Human-readable channel name" + }, + "channelType": { + "type": "string", + "description": "Channel integration type (e.g. SLACK, PAGERDUTY, EMAIL)", + "enum": [ + "email", + "webhook", + "slack", + "pagerduty", + "opsgenie", + "teams", + "discord", + "telegram", + "google_chat", + "pushover", + "mattermost", + "splunk_oncall", + "pushbullet", + "linear", + "incident_io", + "rootly", + "zapier", + "datadog", + "jira", + "gitlab", + "sms", + "phone_call" + ] + }, + "displayConfig": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/AlertChannelDisplayConfig" + } + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether this channel is enabled and will receive alerts" + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the channel was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "Timestamp when the channel was last updated", + "format": "date-time" + }, + "configHash": { + "type": "string", + "description": "SHA-256 hash of the channel config; use for change detection", + "nullable": true + }, + "managedBy": { + "type": "string", + "description": "Source that created/owns this channel: DASHBOARD, CLI, TERRAFORM, MCP, or API. Null on channels created before this attribution column existed.", + "nullable": true, + "enum": [ + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" + ] + }, + "lastDeliveryAt": { + "type": "string", + "description": "Timestamp of the most recent delivery attempt", + "format": "date-time", + "nullable": true + }, + "lastDeliveryStatus": { + "type": "string", + "description": "Outcome of the most recent delivery (SUCCESS, FAILED, etc.)", + "nullable": true + } + }, + "description": "Alert channel with non-sensitive configuration metadata" + }, + "AlertDeliveryDto": { + "required": [ + "channel", + "channelId", + "channelType", + "createdAt", + "eventType", + "id", + "incidentId", + "status", + "stepNumber", + "fireCount", + "attemptCount" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "incidentId": { + "type": "string", + "description": "Incident that triggered this delivery", + "format": "uuid" + }, + "dispatchId": { + "type": "string", + "description": "Notification dispatch that created this delivery", + "format": "uuid", + "nullable": true + }, + "channelId": { + "type": "string", + "description": "Alert channel ID", + "format": "uuid" + }, + "channel": { + "type": "string", + "description": "Human-readable channel name" + }, + "channelType": { + "type": "string", + "description": "Alert channel type (e.g. slack, email, webhook)" + }, + "status": { + "type": "string", + "description": "Current delivery status", + "enum": [ + "PENDING", + "DELIVERED", + "RETRY_PENDING", + "FAILED", + "CANCELLED", + "SKIPPED_NO_CREDIT", + "SKIPPED_UNVERIFIED", + "SKIPPED_OPTED_OUT", + "SKIPPED_RATE_LIMITED" + ] + }, + "eventType": { + "type": "string", + "description": "Incident lifecycle event that triggered this delivery", + "enum": [ + "INCIDENT_CREATED", + "INCIDENT_RESOLVED", + "INCIDENT_REOPENED" + ] + }, + "stepNumber": { + "type": "integer", + "description": "1-based escalation step this delivery belongs to", + "format": "int32" + }, + "fireCount": { + "type": "integer", + "description": "Fire sequence within the step: 1 = initial, 2+ = repeat re-fires", + "format": "int32" + }, + "attemptCount": { + "type": "integer", + "description": "Number of delivery attempts made", + "format": "int32" + }, + "lastAttemptAt": { + "type": "string", + "description": "When the last attempt was made", + "format": "date-time", + "nullable": true + }, + "nextRetryAt": { + "type": "string", + "description": "When the next retry is scheduled (null if not retrying)", + "format": "date-time", + "nullable": true + }, + "deliveredAt": { + "type": "string", + "description": "Timestamp when the delivery was confirmed (null if not yet delivered)", + "format": "date-time", + "nullable": true + }, + "errorMessage": { + "type": "string", + "description": "Error message from the last failed attempt", + "nullable": true + }, + "createdAt": { + "type": "string", + "format": "date-time" + } + }, + "description": "Delivery record for a single channel within a notification dispatch" + }, + "ApiKeyAuthConfig": { + "required": [ + "type", + "headerName" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "api_key" + ] + }, + "headerName": { + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-_]+$", + "type": "string", + "description": "HTTP header name that carries the API key" + }, + "vaultSecretId": { + "type": "string", + "description": "Vault secret ID for the API key value", + "format": "uuid", + "nullable": true + } + } + }, + "ApiKeyCreateResponse": { + "required": [ + "createdAt", + "key", + "name", + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique API key identifier", + "format": "int32" + }, + "name": { + "minLength": 1, + "type": "string", + "description": "Human-readable name for this API key" + }, + "key": { + "minLength": 1, + "type": "string", + "description": "Full API key value in dh_live_* format; store this now" + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the key was created", + "format": "date-time" + }, + "expiresAt": { + "type": "string", + "description": "Timestamp when the key expires; null if no expiration", + "format": "date-time", + "nullable": true + } + }, + "description": "Created API key with the full key value — store it now, it won't be shown again" + }, + "ApiKeyDto": { + "required": [ + "createdAt", + "key", + "name", + "updatedAt", + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique API key identifier", + "format": "int32" + }, + "name": { + "minLength": 1, + "type": "string", + "description": "Human-readable name for this API key" + }, + "key": { + "minLength": 1, + "type": "string", + "description": "Full API key value in dh_live_* format" + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the key was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "Timestamp when the key was last updated", + "format": "date-time" + }, + "lastUsedAt": { + "type": "string", + "description": "Timestamp of the most recent API call; null if never used", + "format": "date-time", + "nullable": true + }, + "revokedAt": { + "type": "string", + "description": "Timestamp when the key was revoked; null if active", + "format": "date-time", + "nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Timestamp when the key expires; null if no expiration", + "format": "date-time", + "nullable": true + } + }, + "description": "API key for programmatic access to the DevHelm API" + }, + "ArtifactTraceMeta": { + "type": "object", + "properties": { + "actionCount": { + "type": "integer", + "description": "Action count in the trace", + "format": "int32", + "nullable": true + }, + "snapshotCount": { + "type": "integer", + "description": "Snapshot count in the trace", + "format": "int32", + "nullable": true + }, + "nearbyActions": { + "type": "array", + "description": "Actions around the failure, teardown labelled", + "nullable": true, + "items": { + "$ref": "#/components/schemas/TraceNearbyAction" + } + }, + "entryPoints": { + "type": "array", + "description": "Four doorways into the downloaded file", + "nullable": true, + "items": { + "$ref": "#/components/schemas/TraceEntryPoint" + } + } + }, + "description": "Packed trace doorway; do not unpack the zip" + }, + "ArtifactViewport": { + "required": [ + "dpr", + "height", + "width" + ], + "type": "object", + "properties": { + "width": { + "type": "integer", + "description": "Viewport width in CSS pixels", + "format": "int32" + }, + "height": { + "type": "integer", + "description": "Viewport height in CSS pixels", + "format": "int32" + }, + "dpr": { + "type": "integer", + "description": "Device pixel ratio at capture", + "format": "int32" + } + }, + "description": "Screenshot viewport" + }, + "AssertionResultDto": { + "required": [ + "severity", + "type", + "passed" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Assertion type", + "example": "status_code" + }, + "passed": { + "type": "boolean", + "description": "Whether the assertion passed" + }, + "severity": { + "type": "string", + "description": "Assertion severity", + "enum": [ + "fail", + "warn" + ] + }, + "message": { + "type": "string", + "description": "Human-readable result message", + "nullable": true + }, + "expected": { + "type": "string", + "description": "Expected value", + "nullable": true, + "example": "200" + }, + "actual": { + "type": "string", + "description": "Actual value observed", + "nullable": true, + "example": "503" + } + }, + "description": "Result of evaluating a single assertion against a check result" + }, + "AssertionTestResultDto": { + "required": [ + "assertionType", + "message", + "severity", + "passed" + ], + "type": "object", + "properties": { + "assertionType": { + "type": "string", + "description": "Assertion type evaluated", + "enum": [ + "status_code", + "response_time", + "body_contains", + "json_path", + "header_value", + "regex_body", + "dns_resolves", + "dns_response_time", + "dns_expected_ips", + "dns_expected_cname", + "dns_record_contains", + "dns_record_equals", + "dns_txt_contains", + "dns_min_answers", + "dns_max_answers", + "dns_response_time_warn", + "dns_ttl_low", + "dns_ttl_high", + "mcp_connects", + "mcp_response_time", + "mcp_has_capability", + "mcp_tool_available", + "mcp_min_tools", + "mcp_protocol_version", + "mcp_response_time_warn", + "mcp_tool_count_changed", + "ssl_expiry", + "response_size", + "redirect_count", + "redirect_target", + "response_time_warn", + "tcp_connects", + "tcp_response_time", + "tcp_response_time_warn", + "icmp_reachable", + "icmp_response_time", + "icmp_response_time_warn", + "icmp_packet_loss", + "heartbeat_received", + "heartbeat_max_interval", + "heartbeat_interval_drift", + "heartbeat_payload_contains" + ] + }, + "passed": { + "type": "boolean", + "description": "Whether the assertion passed" + }, + "severity": { + "type": "string", + "description": "Assertion severity: FAIL or WARN", + "enum": [ + "fail", + "warn" + ] + }, + "message": { + "type": "string", + "description": "Human-readable result description" + }, + "expected": { + "type": "string", + "description": "Expected value", + "nullable": true + }, + "actual": { + "type": "string", + "description": "Actual value observed during the test", + "nullable": true + } + } + }, + "AuditEventDto": { + "required": [ + "action", + "createdAt", + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique audit event identifier", + "format": "int64" + }, + "actorId": { + "type": "integer", + "description": "User ID who performed the action; null for system actions", + "format": "int32", + "nullable": true + }, + "actorEmail": { + "type": "string", + "description": "Email of the actor; null for system actions", + "nullable": true + }, + "action": { + "type": "string", + "description": "Audit action type (e.g. monitor.created, api_key.revoked)" + }, + "resourceType": { + "type": "string", + "description": "Type of resource affected (e.g. monitor, api_key)", + "nullable": true + }, + "resourceId": { + "type": "string", + "description": "ID of the affected resource", + "nullable": true + }, + "resourceName": { + "type": "string", + "description": "Human-readable name of the affected resource", + "nullable": true + }, + "metadata": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/AuditMetadata" + } + ] + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the action was performed", + "format": "date-time" + } + } + }, + "AuditMetadata": { + "description": "Typed metadata payload attached to an audit event; null for actions that carry no extra context.", + "nullable": true, + "discriminator": { + "propertyName": "kind", + "mapping": { + "member_role_changed": "#/components/schemas/MemberRoleChangedMetadata" + } + }, + "oneOf": [ + { + "$ref": "#/components/schemas/MemberRoleChangedMetadata" + } + ] + }, + "AuthMeResponse": { + "required": [ + "key", + "organization", + "plan", + "rateLimits" + ], + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/KeyInfo" + }, + "organization": { + "$ref": "#/components/schemas/OrgInfo" + }, + "plan": { + "$ref": "#/components/schemas/PlanInfo" + }, + "rateLimits": { + "$ref": "#/components/schemas/RateLimitInfo" + } + }, + "description": "Identity, organization, plan, and rate-limit info for the authenticated API key" + }, + "BasicAuthConfig": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + }, + "vaultSecretId": { + "type": "string", + "description": "Vault secret ID holding Basic auth username and password", + "format": "uuid", + "nullable": true + } + }, + "required": [ + "type" + ] + }, + "BatchComponentUptimeDto": { + "required": [ + "components" + ], + "type": "object", + "properties": { + "components": { + "type": "object", + "additionalProperties": { + "type": "array", + "description": "Map of component ID → list of per-day uptime entries (oldest → newest)", + "items": { + "$ref": "#/components/schemas/ComponentUptimeDayDto" + } + }, + "description": "Map of component ID → list of per-day uptime entries (oldest → newest)" + } + }, + "description": "Batch daily uptime per component, keyed by component ID" + }, + "BearerAuthConfig": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "bearer" + ] + }, + "vaultSecretId": { + "type": "string", + "description": "Vault secret ID holding the bearer token value", + "format": "uuid", + "nullable": true + } + }, + "required": [ + "type" + ] }, - "AlertChannelDisplayConfig": { + "BodyContainsAssertion": { + "required": [ + "type", + "substring" + ], "type": "object", "properties": { - "recipients": { + "type": { + "type": "string", + "enum": [ + "body_contains" + ] + }, + "substring": { + "minLength": 1, + "type": "string", + "description": "Substring that must appear in the response body" + } + } + }, + "BulkMonitorActionRequest": { + "required": [ + "action", + "monitorIds" + ], + "type": "object", + "properties": { + "monitorIds": { + "maxItems": 200, + "minItems": 0, "type": "array", - "description": "Email recipients list (email channels)", + "description": "IDs of monitors to act on (max 200)", + "items": { + "type": "string", + "description": "IDs of monitors to act on (max 200)", + "format": "uuid" + } + }, + "action": { + "type": "string", + "description": "Action to apply to every monitor in the bulk request", + "enum": [ + "PAUSE", + "RESUME", + "DELETE", + "ADD_TAG", + "REMOVE_TAG" + ] + }, + "tagIds": { + "type": "array", + "description": "Tag IDs to attach or detach (required for ADD_TAG and REMOVE_TAG)", "nullable": true, "items": { "type": "string", - "description": "Email recipients list (email channels)" + "description": "Tag IDs to attach or detach (required for ADD_TAG and REMOVE_TAG)", + "format": "uuid" } }, - "region": { + "newTags": { + "type": "array", + "description": "New tags to create and attach (only for ADD_TAG)", + "nullable": true, + "items": { + "$ref": "#/components/schemas/NewTagRequest" + } + } + }, + "description": "Request body for performing a bulk action on multiple monitors" + }, + "BulkMonitorActionResult": { + "required": [ + "failed", + "succeeded" + ], + "type": "object", + "properties": { + "succeeded": { + "type": "array", + "description": "IDs of monitors on which the action succeeded", + "items": { + "type": "string", + "description": "IDs of monitors on which the action succeeded", + "format": "uuid" + } + }, + "failed": { + "type": "array", + "description": "Monitors on which the action failed, with the reason for each failure", + "items": { + "$ref": "#/components/schemas/FailureDetail" + } + } + }, + "description": "Result of a bulk monitor action, including partial-success details" + }, + "CapturePolicy": { + "type": "object", + "properties": { + "screenshots": { "type": "string", - "description": "OpsGenie API region: us or eu", - "nullable": true + "description": "When to capture screenshots", + "nullable": true, + "enum": [ + "always", + "on_failure", + "off" + ] }, - "severityOverride": { + "trace": { "type": "string", - "description": "PagerDuty severity override (critical, error, warning, info)", - "nullable": true + "description": "When to capture a Playwright trace", + "nullable": true, + "enum": [ + "always", + "on_failure", + "off" + ] }, - "mentionRoleId": { + "video": { "type": "string", - "description": "Discord role ID to mention in notifications", - "nullable": true + "description": "When to capture video", + "nullable": true, + "enum": [ + "always", + "on_failure", + "off" + ] + } + }, + "description": "When to capture screenshots, traces, and video during a code run" + }, + "CategoryDto": { + "required": [ + "category", + "serviceCount" + ], + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Category name (e.g. CI/CD, Cloud, Payments)" }, - "customHeaders": { + "serviceCount": { + "type": "integer", + "description": "Number of services in this category", + "format": "int64" + } + }, + "description": "Service category with its count of catalog entries" + }, + "ChangeRoleRequest": { + "required": [ + "orgRole" + ], + "type": "object", + "properties": { + "orgRole": { + "type": "string", + "description": "New role to assign", + "enum": [ + "OWNER", + "ADMIN", + "MEMBER" + ] + } + }, + "description": "Update an organization member's role" + }, + "ChangeStatusRequest": { + "required": [ + "status" + ], + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "New membership status (ACTIVE or SUSPENDED)", + "enum": [ + "INVITED", + "ACTIVE", + "SUSPENDED", + "LEFT", + "REMOVED", + "DECLINED" + ] + } + }, + "description": "Update an organization member's status" + }, + "ChartBucketDto": { + "required": [ + "bucket" + ], + "type": "object", + "properties": { + "bucket": { + "type": "string", + "description": "Start of the time bucket (ISO 8601)", + "format": "date-time", + "example": "2026-03-12T10:00:00Z" + }, + "uptimePercent": { + "type": "number", + "description": "Uptime percentage for this bucket; null when no data", + "format": "double", + "nullable": true, + "example": 100 + }, + "avgLatencyMs": { + "type": "number", + "description": "Weighted average latency in milliseconds for this bucket", + "format": "double", + "nullable": true, + "example": 120.3 + }, + "p95LatencyMs": { + "type": "number", + "description": "95th percentile latency in milliseconds (max across regions)", + "format": "double", + "nullable": true, + "example": 250 + }, + "p99LatencyMs": { + "type": "number", + "description": "99th percentile latency in milliseconds (max across regions)", + "format": "double", + "nullable": true, + "example": 480 + } + }, + "description": "Aggregated metrics for a time bucket" + }, + "CheckResultDetailsDto": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer", + "description": "HTTP status code of the response", + "format": "int32", + "nullable": true, + "example": 200 + }, + "responseHeaders": { "type": "object", "additionalProperties": { - "type": "string", - "description": "Custom HTTP headers for webhook requests", - "nullable": true + "type": "array", + "description": "HTTP response headers", + "nullable": true, + "items": { + "type": "string", + "description": "HTTP response headers", + "nullable": true + } }, - "description": "Custom HTTP headers for webhook requests", + "description": "HTTP response headers", "nullable": true }, - "chatId": { + "responseBodySnapshot": { "type": "string", - "description": "Telegram chat ID", + "description": "Raw response body snapshot (may be HTML, XML, JSON, or plain text)", "nullable": true }, - "priority": { - "type": "string", - "description": "Pushover notification priority override", - "nullable": true + "assertionResults": { + "type": "array", + "description": "Individual assertion evaluation results", + "nullable": true, + "items": { + "$ref": "#/components/schemas/AssertionResultDto" + } }, - "channel": { + "tlsInfo": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/TlsInfoDto" + } + ] + }, + "redirectCount": { + "type": "integer", + "description": "Number of HTTP redirects followed", + "format": "int32", + "nullable": true, + "example": 2 + }, + "redirectTarget": { "type": "string", - "description": "Mattermost channel override", + "description": "Final URL after redirects", "nullable": true }, - "routingKey": { + "responseSizeBytes": { + "type": "integer", + "description": "Response body size in bytes", + "format": "int32", + "nullable": true, + "example": 4096 + }, + "checkDetails": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/CheckTypeDetailsDto" + } + ] + } + }, + "description": "Type-specific details captured during a check execution" + }, + "CheckResultDto": { + "required": [ + "id", + "region", + "timestamp", + "passed" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "Splunk On-Call routing key", - "nullable": true + "description": "Unique identifier of the check result", + "format": "uuid" }, - "deviceIden": { + "timestamp": { "type": "string", - "description": "Pushbullet target device identifier", - "nullable": true + "description": "Timestamp when the check was executed (ISO 8601)", + "format": "date-time" }, - "teamId": { + "region": { "type": "string", - "description": "Linear team ID for issue creation", - "nullable": true + "description": "Region where the check was executed", + "example": "us-east" }, - "visibility": { + "responseTimeMs": { + "type": "integer", + "description": "Response time in milliseconds", + "format": "int32", + "nullable": true, + "example": 123 + }, + "passed": { + "type": "boolean", + "description": "Whether the check passed", + "example": true + }, + "failureReason": { "type": "string", - "description": "incident.io incident visibility", + "description": "Reason for failure when passed=false", "nullable": true }, - "severity": { + "severityHint": { "type": "string", - "description": "Rootly incident severity slug", + "description": "Severity hint: 'down' for hard failures, 'degraded' for warn-only failures, null when passing", "nullable": true }, - "site": { + "details": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/CheckResultDetailsDto" + } + ] + }, + "checkId": { "type": "string", - "description": "Datadog site region", + "description": "Unique execution trace ID for cross-service correlation", + "format": "uuid", "nullable": true + } + }, + "description": "A single check result from a monitor run" + }, + "CheckTraceDto": { + "required": [ + "checkId", + "evaluations", + "transitions" + ], + "type": "object", + "properties": { + "checkId": { + "type": "string", + "description": "The check execution ID this trace is keyed by", + "format": "uuid" }, - "projectKey": { + "evaluations": { + "type": "array", + "description": "All rule evaluations that ran for this check", + "items": { + "$ref": "#/components/schemas/RuleEvaluationDto" + } + }, + "transitions": { + "type": "array", + "description": "State-machine transitions this check caused (may be empty if nothing fired)", + "items": { + "$ref": "#/components/schemas/IncidentStateTransitionDto" + } + }, + "policySnapshot": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/PolicySnapshotDto" + } + ] + } + } + }, + "CheckTypeDetailsDto": { + "description": "Check-type-specific details — polymorphic by check_type discriminator", + "discriminator": { + "propertyName": "check_type", + "mapping": { + "http": "#/components/schemas/Http", + "tcp": "#/components/schemas/Tcp", + "icmp": "#/components/schemas/Icmp", + "dns": "#/components/schemas/Dns", + "mcp_server": "#/components/schemas/McpServer", + "code": "#/components/schemas/Code" + } + }, + "oneOf": [ + { + "$ref": "#/components/schemas/Http" + }, + { + "$ref": "#/components/schemas/Tcp" + }, + { + "$ref": "#/components/schemas/Icmp" + }, + { + "$ref": "#/components/schemas/Dns" + }, + { + "$ref": "#/components/schemas/McpServer" + }, + { + "$ref": "#/components/schemas/Code" + } + ] + }, + "Code": { + "type": "object", + "description": "Code check (browser / multi-step API) specific details", + "properties": { + "check_type": { "type": "string", - "description": "Jira project key", - "nullable": true + "enum": [ + "code" + ] }, - "phoneNumber": { + "exitCode": { + "type": "integer", + "description": "Container exit code (0 = pass)", + "format": "int32" + }, + "stdoutSnippet": { "type": "string", - "description": "Recipient phone number in E.164 format (SMS / phone-call channels)", + "description": "Truncated stdout from the container", "nullable": true }, - "verifiedPhoneNumberId": { - "type": "integer", - "description": "Id of the org verified_phone_number row bound to this channel", - "format": "int64", + "stderrSnippet": { + "type": "string", + "description": "Truncated stderr from the container", "nullable": true }, - "phoneNumbers": { + "steps": { "type": "array", - "description": "Deprecated mirror of phoneNumber as a length-1 list for older clients", + "description": "Named steps extracted from Playwright test output", "nullable": true, "items": { - "type": "string", - "description": "Deprecated mirror of phoneNumber as a length-1 list for older clients" + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/CodeCheckStep" + } + ] } }, - "voiceLanguage": { + "failureKind": { "type": "string", - "description": "BCP-47 voice language for phone-call TTS (e.g. en-US, de-DE)", + "description": "Failure classification: timeout, assertion, or error", "nullable": true }, - "preferredLanguage": { - "type": "string", - "description": "Preferred language for SMS/voice (BCP-47, e.g. en-US, de-DE)", + "timedOut": { + "type": "boolean", + "description": "Whether the run hit a step/total/run-budget timeout", "nullable": true } }, - "description": "Non-sensitive alert channel configuration metadata" + "required": [ + "check_type", + "exitCode" + ] }, - "AlertChannelDto": { + "CodeCheckStep": { "required": [ - "channelType", - "createdAt", - "enabled", - "id", "name", - "updatedAt" + "status" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "Unique alert channel identifier", - "format": "uuid" - }, "name": { "type": "string", - "description": "Human-readable channel name" + "description": "Step name from test.step() or test() call" }, - "channelType": { + "status": { "type": "string", - "description": "Channel integration type (e.g. SLACK, PAGERDUTY, EMAIL)", - "enum": [ - "email", - "webhook", - "slack", - "pagerduty", - "opsgenie", - "teams", - "discord", - "telegram", - "google_chat", - "pushover", - "mattermost", - "splunk_oncall", - "pushbullet", - "linear", - "incident_io", - "rootly", - "zapier", - "datadog", - "jira", - "gitlab", - "sms", - "phone_call" - ] - }, - "displayConfig": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/AlertChannelDisplayConfig" - } - ] + "description": "Step outcome: passed, failed, skipped, or timedOut" }, - "enabled": { - "type": "boolean", - "description": "Whether this channel is enabled and will receive alerts" + "durationMs": { + "type": "integer", + "description": "Step duration in milliseconds", + "format": "int32", + "nullable": true }, - "createdAt": { + "error": { "type": "string", - "description": "Timestamp when the channel was created", - "format": "date-time" + "description": "Error message if the step failed", + "nullable": true + } + }, + "description": "A single named step within a code check execution" + }, + "ComponentImpact": { + "required": [ + "componentId", + "componentName", + "uptimePercentage", + "partialOutageSeconds", + "majorOutageSeconds" + ], + "type": "object", + "properties": { + "componentId": { + "type": "string", + "description": "Status page component UUID", + "format": "uuid" }, - "updatedAt": { + "componentName": { "type": "string", - "description": "Timestamp when the channel was last updated", - "format": "date-time" + "description": "Component display name" }, - "configHash": { + "groupName": { "type": "string", - "description": "SHA-256 hash of the channel config; use for change detection", + "description": "Parent group display name when the component belongs to a group", "nullable": true }, - "managedBy": { - "type": "string", - "description": "Source that created/owns this channel: DASHBOARD, CLI, TERRAFORM, MCP, or API. Null on channels created before this attribution column existed.", - "nullable": true, - "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" - ] + "uptimePercentage": { + "type": "number", + "description": "Computed uptime % for this component on this day", + "format": "double" }, - "lastDeliveryAt": { + "partialOutageSeconds": { + "type": "integer", + "description": "Seconds of partial outage observed on this day", + "format": "int32" + }, + "majorOutageSeconds": { + "type": "integer", + "description": "Seconds of major outage observed on this day", + "format": "int32" + } + }, + "description": "One component's uptime contribution for the day" + }, + "ComponentPosition": { + "required": [ + "componentId", + "displayOrder" + ], + "type": "object", + "properties": { + "componentId": { "type": "string", - "description": "Timestamp of the most recent delivery attempt", - "format": "date-time", - "nullable": true + "description": "Component ID", + "format": "uuid" }, - "lastDeliveryStatus": { + "displayOrder": { + "type": "integer", + "description": "New display order (0-based)", + "format": "int32" + }, + "groupId": { "type": "string", - "description": "Outcome of the most recent delivery (SUCCESS, FAILED, etc.)", + "description": "Target group ID, null for ungrouped", + "format": "uuid", "nullable": true } }, - "description": "Alert channel with non-sensitive configuration metadata" + "description": "A single component position" }, - "AlertDeliveryDto": { + "ComponentSample": { "required": [ - "channel", - "channelId", - "channelType", - "createdAt", - "eventType", - "id", - "incidentId", - "status", - "stepNumber", - "fireCount", - "attemptCount" + "componentId", + "newStatus" ], "type": "object", "properties": { - "id": { + "componentId": { "type": "string", + "description": "Component ID", "format": "uuid" }, - "incidentId": { + "componentName": { "type": "string", - "description": "Incident that triggered this delivery", - "format": "uuid" + "description": "Component display name", + "nullable": true }, - "dispatchId": { + "oldStatus": { "type": "string", - "description": "Notification dispatch that created this delivery", - "format": "uuid", + "description": "Previous status before the flip", "nullable": true }, - "channelId": { + "newStatus": { "type": "string", - "description": "Alert channel ID", - "format": "uuid" + "description": "New status after the flip" + } + }, + "description": "One component sample inside a transition rollup" + }, + "ComponentsSummaryDto": { + "required": [ + "groupComponentCounts", + "includedCount", + "totalCount" + ], + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "description": "Total active components for this service across all groups", + "format": "int32" }, - "channel": { + "includedCount": { + "type": "integer", + "description": "Number of components actually returned in the inline ``components`` list", + "format": "int32" + }, + "groupComponentCounts": { + "type": "object", + "additionalProperties": { + "type": "integer", + "description": "Per-group active leaf count, keyed by group component id (UUID stringified). Empty when the service has no groups; lets the UI render \"show all N\" affordances without a second round trip", + "format": "int32" + }, + "description": "Per-group active leaf count, keyed by group component id (UUID stringified). Empty when the service has no groups; lets the UI render \"show all N\" affordances without a second round trip" + } + } + }, + "ComponentStatusDto": { + "required": [ + "id", + "name", + "status" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "Human-readable channel name" + "description": "Component UUID" }, - "channelType": { + "name": { "type": "string", - "description": "Alert channel type (e.g. slack, email, webhook)" + "description": "Human-readable component name" }, "status": { "type": "string", - "description": "Current delivery status", - "enum": [ - "PENDING", - "DELIVERED", - "RETRY_PENDING", - "FAILED", - "CANCELLED", - "SKIPPED_NO_CREDIT", - "SKIPPED_UNVERIFIED", - "SKIPPED_OPTED_OUT", - "SKIPPED_RATE_LIMITED" - ] + "description": "Current component status, e.g. operational, degraded_performance" + } + }, + "description": "Current status of each active component" + }, + "ComponentTransitionEventDto": { + "required": [ + "componentSample", + "newStatus", + "componentCount" + ], + "type": "object", + "properties": { + "newStatus": { + "type": "string", + "description": "New status that defines this rollup bucket" }, - "eventType": { + "componentCount": { + "type": "integer", + "description": "Total components in the 5-minute rollup bucket", + "format": "int32" + }, + "componentSample": { + "type": "array", + "description": "Up to 5 sample components from the bucket", + "items": { + "$ref": "#/components/schemas/ComponentSample" + } + } + }, + "description": "Rolled-up component status transitions for a status-events rail row" + }, + "ComponentUptimeDayDto": { + "required": [ + "date", + "partialOutageSeconds", + "majorOutageSeconds", + "degradedSeconds", + "uptimePercentage" + ], + "type": "object", + "properties": { + "date": { "type": "string", - "description": "Incident lifecycle event that triggered this delivery", - "enum": [ - "INCIDENT_CREATED", - "INCIDENT_RESOLVED", - "INCIDENT_REOPENED" - ] + "description": "Start-of-day timestamp for this bucket (UTC midnight, ISO 8601)", + "format": "date-time" }, - "stepNumber": { + "partialOutageSeconds": { "type": "integer", - "description": "1-based escalation step this delivery belongs to", + "description": "Seconds of partial outage observed on this day", "format": "int32" }, - "fireCount": { + "majorOutageSeconds": { "type": "integer", - "description": "Fire sequence within the step: 1 = initial, 2+ = repeat re-fires", + "description": "Seconds of major outage observed on this day", "format": "int32" }, - "attemptCount": { + "degradedSeconds": { "type": "integer", - "description": "Number of delivery attempts made", + "description": "Seconds the component spent in degraded performance on this day", "format": "int32" }, - "lastAttemptAt": { - "type": "string", - "description": "When the last attempt was made", - "format": "date-time", - "nullable": true + "uptimePercentage": { + "type": "number", + "description": "Computed uptime percentage using the weighted formula (degraded does not lower it)", + "format": "double" }, - "nextRetryAt": { - "type": "string", - "description": "When the next retry is scheduled (null if not retrying)", - "format": "date-time", - "nullable": true + "incidents": { + "type": "array", + "description": "Incidents that overlapped this day, in display order", + "nullable": true, + "items": { + "$ref": "#/components/schemas/IncidentRef" + } + } + }, + "description": "Daily uptime data for a component" + }, + "ComponentUptimeSummaryDto": { + "required": [ + "source" + ], + "type": "object", + "properties": { + "day": { + "type": "number", + "description": "Uptime percentage over the last 24 hours", + "format": "double", + "nullable": true, + "example": 99.95 }, - "deliveredAt": { - "type": "string", - "description": "Timestamp when the delivery was confirmed (null if not yet delivered)", - "format": "date-time", - "nullable": true + "week": { + "type": "number", + "description": "Uptime percentage over the last 7 days", + "format": "double", + "nullable": true, + "example": 99.98 }, - "errorMessage": { - "type": "string", - "description": "Error message from the last failed attempt", - "nullable": true + "month": { + "type": "number", + "description": "Uptime percentage over the last 30 days", + "format": "double", + "nullable": true, + "example": 99.92 }, - "createdAt": { + "source": { "type": "string", - "format": "date-time" + "description": "Data source: vendor_reported or incident_derived", + "example": "vendor_reported" } }, - "description": "Delivery record for a single channel within a notification dispatch" + "description": "Inline uptime percentages for 24h, 7d, 30d" }, - "ApiKeyAuthConfig": { + "ConfirmationPolicy": { "required": [ "type", - "headerName" + "minRegionsFailing", + "maxWaitSeconds" ], "type": "object", "properties": { "type": { "type": "string", + "description": "How incident confirmation is coordinated across regions", "enum": [ - "api_key" + "multi_region" ] }, - "headerName": { + "minRegionsFailing": { + "type": "integer", + "description": "Minimum failing regions required to confirm an incident", + "format": "int32" + }, + "maxWaitSeconds": { + "type": "integer", + "description": "Maximum seconds to wait for enough regions to fail after first trigger", + "format": "int32" + } + }, + "description": "Multi-region confirmation settings" + }, + "ConsoleGroupDto": { + "required": [ + "level", + "sourceUrl", + "text", + "count" + ], + "type": "object", + "properties": { + "level": { "minLength": 1, - "pattern": "^[A-Za-z0-9\\-_]+$", "type": "string", - "description": "HTTP header name that carries the API key" + "description": "UI bucket: error, warning, or info" }, - "vaultSecretId": { + "text": { + "minLength": 1, "type": "string", - "description": "Vault secret ID for the API key value", - "format": "uuid", + "description": "Repeated message text" + }, + "count": { + "type": "integer", + "description": "How many times this message occurred", + "format": "int32" + }, + "sourceUrl": { + "minLength": 1, + "type": "string", + "description": "Source URL of the first occurrence" + }, + "stepIdFirst": { + "type": "string", + "description": "First step that logged this message", + "nullable": true + }, + "stepIdLast": { + "type": "string", + "description": "Last step that logged this message", "nullable": true } - } + }, + "description": "Grouped console messages" }, - "ApiKeyCreateResponse": { + "ConsoleLineDto": { "required": [ - "createdAt", - "key", - "name", - "id" + "id", + "level", + "sourceUrl", + "text", + "ts", + "lineNumber", + "columnNumber" ], "type": "object", "properties": { "id": { - "type": "integer", - "description": "Unique API key identifier", - "format": "int32" + "minLength": 1, + "type": "string", + "description": "Stable line id from capture" }, - "name": { + "stepId": { + "type": "string", + "description": "Step this line belonged to", + "nullable": true + }, + "level": { "minLength": 1, "type": "string", - "description": "Human-readable name for this API key" + "description": "UI bucket: error, warning, or info" }, - "key": { + "text": { "minLength": 1, "type": "string", - "description": "Full API key value in dh_live_* format; store this now" + "description": "Console message text" }, - "createdAt": { + "sourceUrl": { + "minLength": 1, "type": "string", - "description": "Timestamp when the key was created", - "format": "date-time" + "description": "Script URL that logged this line" + }, + "lineNumber": { + "type": "integer", + "description": "Source line number", + "format": "int32" + }, + "columnNumber": { + "type": "integer", + "description": "Source column number", + "format": "int32" + }, + "ts": { + "minLength": 1, + "type": "string", + "description": "When the line was captured" + } + }, + "description": "One console line" + }, + "CreateAlertChannelRequest": { + "required": [ + "config", + "name" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Human-readable name for this alert channel" + }, + "config": { + "oneOf": [ + { + "$ref": "#/components/schemas/DatadogChannelConfig" + }, + { + "$ref": "#/components/schemas/DiscordChannelConfig" + }, + { + "$ref": "#/components/schemas/EmailChannelConfig" + }, + { + "$ref": "#/components/schemas/GitLabChannelConfig" + }, + { + "$ref": "#/components/schemas/GoogleChatChannelConfig" + }, + { + "$ref": "#/components/schemas/IncidentIoChannelConfig" + }, + { + "$ref": "#/components/schemas/JiraChannelConfig" + }, + { + "$ref": "#/components/schemas/LinearChannelConfig" + }, + { + "$ref": "#/components/schemas/MattermostChannelConfig" + }, + { + "$ref": "#/components/schemas/OpsGenieChannelConfig" + }, + { + "$ref": "#/components/schemas/PagerDutyChannelConfig" + }, + { + "$ref": "#/components/schemas/PhoneCallChannelConfig" + }, + { + "$ref": "#/components/schemas/PushbulletChannelConfig" + }, + { + "$ref": "#/components/schemas/PushoverChannelConfig" + }, + { + "$ref": "#/components/schemas/RootlyChannelConfig" + }, + { + "$ref": "#/components/schemas/SlackChannelConfig" + }, + { + "$ref": "#/components/schemas/SmsChannelConfig" + }, + { + "$ref": "#/components/schemas/SplunkOnCallChannelConfig" + }, + { + "$ref": "#/components/schemas/TeamsChannelConfig" + }, + { + "$ref": "#/components/schemas/TelegramChannelConfig" + }, + { + "$ref": "#/components/schemas/WebhookChannelConfig" + }, + { + "$ref": "#/components/schemas/ZapierChannelConfig" + } + ] }, - "expiresAt": { + "managedBy": { "type": "string", - "description": "Timestamp when the key expires; null if no expiration", - "format": "date-time", - "nullable": true + "description": "Source creating this channel: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API when omitted.", + "nullable": true, + "enum": [ + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" + ] } - }, - "description": "Created API key with the full key value — store it now, it won't be shown again" + } }, - "ApiKeyDto": { + "CreateApiKeyRequest": { "required": [ - "createdAt", - "key", - "name", - "updatedAt", - "id" + "name" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Unique API key identifier", - "format": "int32" - }, "name": { - "minLength": 1, - "type": "string", - "description": "Human-readable name for this API key" - }, - "key": { - "minLength": 1, - "type": "string", - "description": "Full API key value in dh_live_* format" - }, - "createdAt": { - "type": "string", - "description": "Timestamp when the key was created", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "description": "Timestamp when the key was last updated", - "format": "date-time" - }, - "lastUsedAt": { - "type": "string", - "description": "Timestamp of the most recent API call; null if never used", - "format": "date-time", - "nullable": true - }, - "revokedAt": { + "maxLength": 200, + "minLength": 0, "type": "string", - "description": "Timestamp when the key was revoked; null if active", - "format": "date-time", - "nullable": true + "description": "Human-readable name to identify this API key" }, "expiresAt": { "type": "string", - "description": "Timestamp when the key expires; null if no expiration", + "description": "Optional expiration timestamp in ISO 8601 format", "format": "date-time", "nullable": true } - }, - "description": "API key for programmatic access to the DevHelm API" + } }, - "AssertionResultDto": { + "CreateAssertionRequest": { "required": [ - "severity", - "type", - "passed" + "config" ], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Assertion type", - "example": "status_code" - }, - "passed": { - "type": "boolean", - "description": "Whether the assertion passed" + "config": { + "oneOf": [ + { + "$ref": "#/components/schemas/BodyContainsAssertion" + }, + { + "$ref": "#/components/schemas/DnsExpectedCnameAssertion" + }, + { + "$ref": "#/components/schemas/DnsExpectedIpsAssertion" + }, + { + "$ref": "#/components/schemas/DnsMaxAnswersAssertion" + }, + { + "$ref": "#/components/schemas/DnsMinAnswersAssertion" + }, + { + "$ref": "#/components/schemas/DnsRecordContainsAssertion" + }, + { + "$ref": "#/components/schemas/DnsRecordEqualsAssertion" + }, + { + "$ref": "#/components/schemas/DnsResolvesAssertion" + }, + { + "$ref": "#/components/schemas/DnsResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/DnsResponseTimeWarnAssertion" + }, + { + "$ref": "#/components/schemas/DnsTtlHighAssertion" + }, + { + "$ref": "#/components/schemas/DnsTtlLowAssertion" + }, + { + "$ref": "#/components/schemas/DnsTxtContainsAssertion" + }, + { + "$ref": "#/components/schemas/HeaderValueAssertion" + }, + { + "$ref": "#/components/schemas/HeartbeatIntervalDriftAssertion" + }, + { + "$ref": "#/components/schemas/HeartbeatMaxIntervalAssertion" + }, + { + "$ref": "#/components/schemas/HeartbeatPayloadContainsAssertion" + }, + { + "$ref": "#/components/schemas/HeartbeatReceivedAssertion" + }, + { + "$ref": "#/components/schemas/IcmpPacketLossAssertion" + }, + { + "$ref": "#/components/schemas/IcmpReachableAssertion" + }, + { + "$ref": "#/components/schemas/IcmpResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/IcmpResponseTimeWarnAssertion" + }, + { + "$ref": "#/components/schemas/JsonPathAssertion" + }, + { + "$ref": "#/components/schemas/McpConnectsAssertion" + }, + { + "$ref": "#/components/schemas/McpHasCapabilityAssertion" + }, + { + "$ref": "#/components/schemas/McpMinToolsAssertion" + }, + { + "$ref": "#/components/schemas/McpProtocolVersionAssertion" + }, + { + "$ref": "#/components/schemas/McpResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/McpResponseTimeWarnAssertion" + }, + { + "$ref": "#/components/schemas/McpToolAvailableAssertion" + }, + { + "$ref": "#/components/schemas/McpToolCountChangedAssertion" + }, + { + "$ref": "#/components/schemas/RedirectCountAssertion" + }, + { + "$ref": "#/components/schemas/RedirectTargetAssertion" + }, + { + "$ref": "#/components/schemas/RegexBodyAssertion" + }, + { + "$ref": "#/components/schemas/ResponseSizeAssertion" + }, + { + "$ref": "#/components/schemas/ResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/ResponseTimeWarnAssertion" + }, + { + "$ref": "#/components/schemas/SslExpiryAssertion" + }, + { + "$ref": "#/components/schemas/StatusCodeAssertion" + }, + { + "$ref": "#/components/schemas/TcpConnectsAssertion" + }, + { + "$ref": "#/components/schemas/TcpResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/TcpResponseTimeWarnAssertion" + } + ] }, "severity": { "type": "string", - "description": "Assertion severity", + "description": "Outcome severity: FAIL (fails the check) or WARN (warns without failing, default: FAIL)", + "nullable": true, "enum": [ "fail", "warn" ] - }, - "message": { - "type": "string", - "description": "Human-readable result message", - "nullable": true - }, - "expected": { - "type": "string", - "description": "Expected value", - "nullable": true, - "example": "200" - }, - "actual": { - "type": "string", - "description": "Actual value observed", - "nullable": true, - "example": "503" } }, - "description": "Result of evaluating a single assertion against a check result" + "description": "Replace all assertions. Null preserves current" }, - "AssertionTestResultDto": { + "CreateEnvironmentRequest": { "required": [ - "assertionType", - "message", - "severity", - "passed" + "name", + "slug" ], "type": "object", "properties": { - "assertionType": { - "type": "string", - "description": "Assertion type evaluated", - "enum": [ - "status_code", - "response_time", - "body_contains", - "json_path", - "header_value", - "regex_body", - "dns_resolves", - "dns_response_time", - "dns_expected_ips", - "dns_expected_cname", - "dns_record_contains", - "dns_record_equals", - "dns_txt_contains", - "dns_min_answers", - "dns_max_answers", - "dns_response_time_warn", - "dns_ttl_low", - "dns_ttl_high", - "mcp_connects", - "mcp_response_time", - "mcp_has_capability", - "mcp_tool_available", - "mcp_min_tools", - "mcp_protocol_version", - "mcp_response_time_warn", - "mcp_tool_count_changed", - "ssl_expiry", - "response_size", - "redirect_count", - "redirect_target", - "response_time_warn", - "tcp_connects", - "tcp_response_time", - "tcp_response_time_warn", - "icmp_reachable", - "icmp_response_time", - "icmp_response_time_warn", - "icmp_packet_loss", - "heartbeat_received", - "heartbeat_max_interval", - "heartbeat_interval_drift", - "heartbeat_payload_contains" - ] - }, - "passed": { - "type": "boolean", - "description": "Whether the assertion passed" - }, - "severity": { + "name": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "Assertion severity: FAIL or WARN", - "enum": [ - "fail", - "warn" - ] + "description": "Human-readable environment name" }, - "message": { + "slug": { + "maxLength": 100, + "minLength": 0, + "pattern": "^[a-z0-9][a-z0-9_-]*$", "type": "string", - "description": "Human-readable result description" + "description": "URL-safe identifier (lowercase alphanumeric, hyphens, underscores)" }, - "expected": { - "type": "string", - "description": "Expected value", + "variables": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Initial key-value variable pairs for this environment", + "nullable": true + }, + "description": "Initial key-value variable pairs for this environment", "nullable": true }, - "actual": { - "type": "string", - "description": "Actual value observed during the test", + "isDefault": { + "type": "boolean", + "description": "Whether this is the default environment for new monitors (default: false)", "nullable": true } } }, - "AuditEventDto": { + "CreateInviteRequest": { "required": [ - "action", - "createdAt", - "id" + "email", + "roleOffered" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Unique audit event identifier", - "format": "int64" - }, - "actorId": { - "type": "integer", - "description": "User ID who performed the action; null for system actions", - "format": "int32", - "nullable": true - }, - "actorEmail": { - "type": "string", - "description": "Email of the actor; null for system actions", - "nullable": true - }, - "action": { - "type": "string", - "description": "Audit action type (e.g. monitor.created, api_key.revoked)" - }, - "resourceType": { - "type": "string", - "description": "Type of resource affected (e.g. monitor, api_key)", - "nullable": true - }, - "resourceId": { + "email": { + "minLength": 1, "type": "string", - "description": "ID of the affected resource", - "nullable": true + "description": "Email address to invite", + "format": "email" }, - "resourceName": { + "roleOffered": { "type": "string", - "description": "Human-readable name of the affected resource", - "nullable": true - }, - "metadata": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/AuditMetadata" - } + "description": "Role to assign on acceptance", + "enum": [ + "OWNER", + "ADMIN", + "MEMBER" ] - }, - "createdAt": { - "type": "string", - "description": "Timestamp when the action was performed", - "format": "date-time" - } - } - }, - "AuditMetadata": { - "description": "Typed metadata payload attached to an audit event; null for actions that carry no extra context.", - "nullable": true, - "discriminator": { - "propertyName": "kind", - "mapping": { - "member_role_changed": "#/components/schemas/MemberRoleChangedMetadata" } }, - "oneOf": [ - { - "$ref": "#/components/schemas/MemberRoleChangedMetadata" - } - ] + "description": "Invite a new member to the organization by email" }, - "AuthMeResponse": { + "CreateMaintenanceWindowRequest": { "required": [ - "key", - "organization", - "plan", - "rateLimits" + "endsAt", + "startsAt" ], "type": "object", "properties": { - "key": { - "$ref": "#/components/schemas/KeyInfo" + "monitorId": { + "type": "string", + "description": "Monitor to attach this maintenance window to; null for org-wide", + "format": "uuid", + "nullable": true }, - "organization": { - "$ref": "#/components/schemas/OrgInfo" + "startsAt": { + "type": "string", + "description": "Scheduled start of the maintenance window (ISO 8601)", + "format": "date-time" }, - "plan": { - "$ref": "#/components/schemas/PlanInfo" + "endsAt": { + "type": "string", + "description": "Scheduled end of the maintenance window (ISO 8601)", + "format": "date-time" }, - "rateLimits": { - "$ref": "#/components/schemas/RateLimitInfo" - } - }, - "description": "Identity, organization, plan, and rate-limit info for the authenticated API key" - }, - "BasicAuthConfig": { - "type": "object", - "properties": { - "type": { + "repeatRule": { + "maxLength": 100, + "minLength": 0, "type": "string", - "enum": [ - "basic" - ] + "description": "Reserved: iCal RRULE for recurring windows (stored but not yet honored)", + "nullable": true }, - "vaultSecretId": { + "reason": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "Vault secret ID holding Basic auth username and password", - "format": "uuid", + "description": "Human-readable reason for the maintenance (max 500 chars)", "nullable": true - } - }, - "required": [ - "type" - ] - }, - "BatchComponentUptimeDto": { - "required": [ - "components" - ], - "type": "object", - "properties": { - "components": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "Map of component ID → list of per-day uptime entries (oldest → newest)", - "items": { - "$ref": "#/components/schemas/ComponentUptimeDayDto" - } - }, - "description": "Map of component ID → list of per-day uptime entries (oldest → newest)" - } - }, - "description": "Batch daily uptime per component, keyed by component ID" + }, + "suppressAlerts": { + "type": "boolean", + "description": "Whether to suppress alerts during this window (default: true)", + "nullable": true + } + } }, - "BearerAuthConfig": { + "CreateManualIncidentRequest": { + "required": [ + "severity", + "title" + ], "type": "object", "properties": { - "type": { + "title": { + "minLength": 1, + "type": "string", + "description": "Short summary of the incident" + }, + "severity": { "type": "string", + "description": "Incident severity: DOWN, DEGRADED, or MAINTENANCE", "enum": [ - "bearer" + "DOWN", + "DEGRADED", + "MAINTENANCE" ] }, - "vaultSecretId": { + "monitorId": { "type": "string", - "description": "Vault secret ID holding the bearer token value", + "description": "Monitor to associate with this incident", + "format": "uuid", + "nullable": true + }, + "body": { + "type": "string", + "description": "Detailed description or context for the incident", + "nullable": true + }, + "serviceId": { + "type": "string", + "description": "Vendor service to link; optional for Dependencies create CTA", + "format": "uuid", + "nullable": true + }, + "serviceIncidentId": { + "type": "string", + "description": "Vendor incident to link; idempotent if an active org incident already links it", "format": "uuid", "nullable": true } - }, - "required": [ - "type" - ] + } }, - "BodyContainsAssertion": { + "CreateMonitorRequest": { "required": [ - "type", - "substring" + "name", + "type" ], "type": "object", "properties": { + "name": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Human-readable name for this monitor" + }, "type": { "type": "string", + "description": "Monitor protocol type", "enum": [ - "body_contains" + "HTTP", + "DNS", + "MCP_SERVER", + "TCP", + "ICMP", + "HEARTBEAT", + "BROWSER", + "MULTI_STEP_API" ] }, - "substring": { - "minLength": 1, - "type": "string", - "description": "Substring that must appear in the response body" - } - } - }, - "BulkMonitorActionRequest": { - "required": [ - "action", - "monitorIds" - ], - "type": "object", - "properties": { - "monitorIds": { - "maxItems": 200, - "minItems": 0, + "config": { + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/DnsMonitorConfig" + }, + { + "$ref": "#/components/schemas/HeartbeatMonitorConfig" + }, + { + "$ref": "#/components/schemas/HttpMonitorConfig" + }, + { + "$ref": "#/components/schemas/IcmpMonitorConfig" + }, + { + "$ref": "#/components/schemas/McpServerMonitorConfig" + }, + { + "$ref": "#/components/schemas/ScriptMonitorConfig" + }, + { + "$ref": "#/components/schemas/TcpMonitorConfig" + } + ] + }, + "frequencySeconds": { + "maximum": 86400, + "minimum": 10, + "type": "integer", + "description": "Check frequency in seconds (10–86400). Null defaults to the plan minimum", + "format": "int32", + "nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Whether the monitor is active (default: true)", + "nullable": true + }, + "regions": { "type": "array", - "description": "IDs of monitors to act on (max 200)", + "description": "Probe regions to run checks from. Allowed values are deployment-dependent. Production: us-east, us-west, eu-west, ap-south", + "nullable": true, "items": { "type": "string", - "description": "IDs of monitors to act on (max 200)", - "format": "uuid" + "description": "Probe regions to run checks from. Allowed values are deployment-dependent. Production: us-east, us-west, eu-west, ap-south" } }, - "action": { + "managedBy": { "type": "string", - "description": "Action to apply to every monitor in the bulk request", + "description": "Source that created this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API", + "nullable": true, "enum": [ - "PAUSE", - "RESUME", - "DELETE", - "ADD_TAG", - "REMOVE_TAG" + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" ] }, - "tagIds": { + "environmentId": { + "type": "string", + "description": "Environment to associate with this monitor. Required for browser and multi-step monitors", + "format": "uuid", + "nullable": true + }, + "assertions": { "type": "array", - "description": "Tag IDs to attach or detach (required for ADD_TAG and REMOVE_TAG)", + "description": "Assertions to evaluate against each check result", "nullable": true, "items": { - "type": "string", - "description": "Tag IDs to attach or detach (required for ADD_TAG and REMOVE_TAG)", - "format": "uuid" + "$ref": "#/components/schemas/CreateAssertionRequest" } }, - "newTags": { - "type": "array", - "description": "New tags to create and attach (only for ADD_TAG)", + "auth": { "nullable": true, - "items": { - "$ref": "#/components/schemas/NewTagRequest" - } - } - }, - "description": "Request body for performing a bulk action on multiple monitors" - }, - "BulkMonitorActionResult": { - "required": [ - "failed", - "succeeded" - ], - "type": "object", - "properties": { - "succeeded": { + "allOf": [ + { + "$ref": "#/components/schemas/MonitorAuthConfig" + } + ] + }, + "incidentPolicy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/UpdateIncidentPolicyRequest" + } + ] + }, + "alertChannelIds": { "type": "array", - "description": "IDs of monitors on which the action succeeded", + "description": "Alert channels to notify when this monitor triggers", + "nullable": true, "items": { "type": "string", - "description": "IDs of monitors on which the action succeeded", + "description": "Alert channels to notify when this monitor triggers", "format": "uuid" } }, - "failed": { - "type": "array", - "description": "Monitors on which the action failed, with the reason for each failure", - "items": { - "$ref": "#/components/schemas/FailureDetail" - } - } - }, - "description": "Result of a bulk monitor action, including partial-success details" - }, - "CategoryDto": { - "required": [ - "category", - "serviceCount" - ], - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Category name (e.g. CI/CD, Cloud, Payments)" + "tags": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/AddMonitorTagsRequest" + } + ] }, - "serviceCount": { + "capturePolicy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/CapturePolicy" + } + ] + }, + "fastRetryMaxAttempts": { + "maximum": 10, + "minimum": 0, "type": "integer", - "description": "Number of services in this category", - "format": "int64" + "description": "Fast-retry attempts after failure. Null or 0 disables", + "format": "int32", + "nullable": true + }, + "definitionId": { + "type": "string", + "description": "Existing definition to reuse for a sibling monitor", + "format": "uuid", + "nullable": true + }, + "package": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/MonitorPackageSpec" + } + ] } - }, - "description": "Service category with its count of catalog entries" + } }, - "ChangeRoleRequest": { + "CreateNotificationPolicyRequest": { "required": [ - "orgRole" + "escalation", + "name" ], "type": "object", "properties": { - "orgRole": { + "name": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "New role to assign", - "enum": [ - "OWNER", - "ADMIN", - "MEMBER" - ] + "description": "Human-readable name for this policy" + }, + "description": { + "maxLength": 500, + "minLength": 0, + "type": "string", + "description": "Optional note; omit or null when unused", + "nullable": true + }, + "matchRules": { + "type": "array", + "description": "Match rules to evaluate (all must pass; omit or empty for catch-all)", + "nullable": true, + "items": { + "$ref": "#/components/schemas/MatchRule" + } + }, + "escalation": { + "$ref": "#/components/schemas/EscalationChain" + }, + "enabled": { + "type": "boolean", + "description": "Whether this policy is enabled (default true)", + "nullable": true, + "default": true + }, + "priority": { + "type": "integer", + "description": "Evaluation priority; higher value = evaluated first (default 0)", + "format": "int32", + "nullable": true, + "default": 0 } }, - "description": "Update an organization member's role" + "description": "Request body for creating a notification policy" }, - "ChangeStatusRequest": { + "CreatePackageUploadRequest": { "required": [ - "status" + "digest" ], "type": "object", "properties": { - "status": { + "digest": { + "maxLength": 64, + "minLength": 64, "type": "string", - "description": "New membership status (ACTIVE or SUSPENDED)", - "enum": [ - "INVITED", - "ACTIVE", - "SUSPENDED", - "LEFT", - "REMOVED", - "DECLINED" - ] + "description": "SHA-256 hex digest of the package zip to upload (64 chars)" } - }, - "description": "Update an organization member's status" + } }, - "ChartBucketDto": { + "CreateResourceGroupRequest": { "required": [ - "bucket" + "name" ], "type": "object", "properties": { - "bucket": { + "name": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "Start of the time bucket (ISO 8601)", - "format": "date-time", - "example": "2026-03-12T10:00:00Z" - }, - "uptimePercent": { - "type": "number", - "description": "Uptime percentage for this bucket; null when no data", - "format": "double", - "nullable": true, - "example": 100 + "description": "Human-readable name for this group" }, - "avgLatencyMs": { - "type": "number", - "description": "Weighted average latency in milliseconds for this bucket", - "format": "double", - "nullable": true, - "example": 120.3 + "description": { + "maxLength": 500, + "minLength": 0, + "type": "string", + "description": "Optional description (max 500)", + "nullable": true }, - "p95LatencyMs": { - "type": "number", - "description": "95th percentile latency in milliseconds (max across regions)", - "format": "double", - "nullable": true, - "example": 250 + "alertPolicyId": { + "type": "string", + "description": "Optional notification policy to apply for this group", + "format": "uuid", + "nullable": true }, - "p99LatencyMs": { - "type": "number", - "description": "99th percentile latency in milliseconds (max across regions)", - "format": "double", - "nullable": true, - "example": 480 - } - }, - "description": "Aggregated metrics for a time bucket" - }, - "CheckResultDetailsDto": { - "type": "object", - "properties": { - "statusCode": { + "defaultFrequency": { + "maximum": 86400, + "minimum": 30, "type": "integer", - "description": "HTTP status code of the response", + "description": "Default check frequency in seconds applied to members (30–86400)", "format": "int32", - "nullable": true, - "example": 200 - }, - "responseHeaders": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "HTTP response headers", - "nullable": true, - "items": { - "type": "string", - "description": "HTTP response headers", - "nullable": true - } - }, - "description": "HTTP response headers", - "nullable": true - }, - "responseBodySnapshot": { - "type": "string", - "description": "Raw response body snapshot (may be HTML, XML, JSON, or plain text)", "nullable": true }, - "assertionResults": { + "defaultRegions": { "type": "array", - "description": "Individual assertion evaluation results", + "description": "Default regions applied to member monitors", "nullable": true, "items": { - "$ref": "#/components/schemas/AssertionResultDto" + "type": "string", + "description": "Default regions applied to member monitors" } }, - "tlsInfo": { + "defaultRetryStrategy": { "nullable": true, "allOf": [ { - "$ref": "#/components/schemas/TlsInfoDto" + "$ref": "#/components/schemas/RetryStrategy" } ] }, - "redirectCount": { + "defaultAlertChannels": { + "type": "array", + "description": "Default alert channel IDs applied to member monitors", + "nullable": true, + "items": { + "type": "string", + "description": "Default alert channel IDs applied to member monitors", + "format": "uuid" + } + }, + "defaultEnvironmentId": { + "type": "string", + "description": "Default environment ID applied to member monitors", + "format": "uuid", + "nullable": true + }, + "healthThresholdType": { + "type": "string", + "description": "Health threshold type: COUNT or PERCENTAGE", + "nullable": true, + "enum": [ + "COUNT", + "PERCENTAGE" + ] + }, + "healthThresholdValue": { + "maximum": 100, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false, + "type": "number", + "description": "Health threshold value: count (0+) or percentage (0–100)", + "nullable": true + }, + "suppressMemberAlerts": { + "type": "boolean", + "description": "Suppress member-level alert notifications when group manages alerting", + "nullable": true + }, + "confirmationDelaySeconds": { + "maximum": 600, + "minimum": 0, "type": "integer", - "description": "Number of HTTP redirects followed", + "description": "Confirmation delay in seconds before group incident creation (0–600)", "format": "int32", + "nullable": true + }, + "recoveryCooldownMinutes": { + "maximum": 60, + "minimum": 0, + "type": "integer", + "description": "Recovery cooldown in minutes after group incident resolves (0–60)", + "format": "int32", + "nullable": true + }, + "managedBy": { + "type": "string", + "description": "Source creating this group: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API when omitted.", "nullable": true, - "example": 2 + "enum": [ + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" + ] + } + }, + "description": "Request body for creating a resource group" + }, + "CreateSecretRequest": { + "required": [ + "key", + "value" + ], + "type": "object", + "properties": { + "key": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Unique secret key within the workspace (max 255 chars)" }, - "redirectTarget": { + "value": { + "maxLength": 32768, + "minLength": 0, "type": "string", - "description": "Final URL after redirects", + "description": "Secret value, stored encrypted (max 32KB)" + } + } + }, + "CreateStatusPageComponentGroupRequest": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Group display name" + }, + "description": { + "maxLength": 500, + "minLength": 0, + "type": "string", + "description": "Optional group description", "nullable": true }, - "responseSizeBytes": { + "displayOrder": { "type": "integer", - "description": "Response body size in bytes", + "description": "Position in the group list", "format": "int32", - "nullable": true, - "example": 4096 + "nullable": true }, - "checkDetails": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/CheckTypeDetailsDto" - } - ] + "defaultOpen": { + "type": "boolean", + "description": "Initial expand/collapse state when a visitor first loads the page; renderer may auto-expand on active incidents (default: true)", + "nullable": true } - }, - "description": "Type-specific details captured during a check execution" + } }, - "CheckResultDto": { + "CreateStatusPageComponentRequest": { "required": [ - "id", - "region", - "timestamp", - "passed" + "name", + "type" ], "type": "object", "properties": { - "id": { + "name": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "Unique identifier of the check result", - "format": "uuid" + "description": "Component display name" }, - "timestamp": { + "description": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "Timestamp when the check was executed (ISO 8601)", - "format": "date-time" + "description": "Optional description shown on expand", + "nullable": true }, - "region": { + "type": { "type": "string", - "description": "Region where the check was executed", - "example": "us-east" + "description": "Component type: MONITOR, GROUP, STATIC, or DEPENDENCY", + "enum": [ + "MONITOR", + "GROUP", + "STATIC", + "DEPENDENCY" + ] }, - "responseTimeMs": { - "type": "integer", - "description": "Response time in milliseconds", - "format": "int32", - "nullable": true, - "example": 123 + "monitorId": { + "type": "string", + "description": "Monitor ID (required when type=MONITOR)", + "format": "uuid", + "nullable": true }, - "passed": { - "type": "boolean", - "description": "Whether the check passed", - "example": true + "resourceGroupId": { + "type": "string", + "description": "Resource group ID (required when type=GROUP)", + "format": "uuid", + "nullable": true }, - "failureReason": { + "serviceSubscriptionId": { "type": "string", - "description": "Reason for failure when passed=false", + "description": "Service subscription (Dependency) ID — required when type=DEPENDENCY. Bind an existing org subscription; catalog picks must create the subscription first, then pass its id", + "format": "uuid", "nullable": true }, - "severityHint": { + "groupId": { "type": "string", - "description": "Severity hint: 'down' for hard failures, 'degraded' for warn-only failures, null when passing", + "description": "Component group ID for visual grouping", + "format": "uuid", "nullable": true }, - "details": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/CheckResultDetailsDto" - } - ] + "showUptime": { + "type": "boolean", + "description": "Whether to show the uptime bar (default: true; false for DEPENDENCY)", + "nullable": true }, - "checkId": { + "displayOrder": { + "type": "integer", + "description": "Position in the component list", + "format": "int32", + "nullable": true + }, + "excludeFromOverall": { + "type": "boolean", + "description": "Exclude from overall status calculation (default: false; true for DEPENDENCY)", + "nullable": true + }, + "startDate": { "type": "string", - "description": "Unique execution trace ID for cross-service correlation", - "format": "uuid", + "description": "Date from which to start showing uptime; defaults to component creation. Set earlier to backdate (e.g. launch day); clamped at the monitor's createdAt for MONITOR-type components", + "format": "date", "nullable": true } - }, - "description": "A single check result from a monitor run" + } }, - "CheckTraceDto": { + "CreateStatusPageIncidentRequest": { "required": [ - "checkId", - "evaluations", - "transitions" + "body", + "impact", + "title" ], "type": "object", "properties": { - "checkId": { + "title": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "The check execution ID this trace is keyed by", - "format": "uuid" - }, - "evaluations": { - "type": "array", - "description": "All rule evaluations that ran for this check", - "items": { - "$ref": "#/components/schemas/RuleEvaluationDto" - } - }, - "transitions": { - "type": "array", - "description": "State-machine transitions this check caused (may be empty if nothing fired)", - "items": { - "$ref": "#/components/schemas/IncidentStateTransitionDto" - } + "description": "Customer-facing incident title" }, - "policySnapshot": { + "status": { + "type": "string", + "description": "Initial status (default: INVESTIGATING)", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/PolicySnapshotDto" - } + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" ] - } - } - }, - "CheckTypeDetailsDto": { - "description": "Check-type-specific details — polymorphic by check_type discriminator", - "discriminator": { - "propertyName": "check_type", - "mapping": { - "http": "#/components/schemas/Http", - "tcp": "#/components/schemas/Tcp", - "icmp": "#/components/schemas/Icmp", - "dns": "#/components/schemas/Dns", - "mcp_server": "#/components/schemas/McpServer", - "code": "#/components/schemas/Code" - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/Http" }, - { - "$ref": "#/components/schemas/Tcp" - }, - { - "$ref": "#/components/schemas/Icmp" - }, - { - "$ref": "#/components/schemas/Dns" - }, - { - "$ref": "#/components/schemas/McpServer" - }, - { - "$ref": "#/components/schemas/Code" - } - ] - }, - "Code": { - "type": "object", - "description": "Code check (browser / multi-step API) specific details", - "properties": { - "check_type": { + "impact": { "type": "string", + "description": "Impact level: NONE, MINOR, MAJOR, or CRITICAL", "enum": [ - "code" + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" ] }, - "exitCode": { - "type": "integer", - "description": "Container exit code (0 = pass)", - "format": "int32" - }, - "stdoutSnippet": { - "type": "string", - "description": "Truncated stdout from the container", - "nullable": true - }, - "stderrSnippet": { + "body": { + "minLength": 1, "type": "string", - "description": "Truncated stderr from the container", - "nullable": true + "description": "Initial update body in markdown" }, - "steps": { + "affectedComponents": { "type": "array", - "description": "Named steps extracted from Playwright test output", + "description": "Component IDs affected by this incident", "nullable": true, "items": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/CodeCheckStep" - } - ] + "$ref": "#/components/schemas/AffectedComponent" } }, - "failureKind": { - "type": "string", - "description": "Failure classification: timeout, assertion, or error", + "notifySubscribers": { + "type": "boolean", + "description": "Whether to email confirmed subscribers about this incident (default: true)", "nullable": true }, - "timedOut": { - "type": "boolean", - "description": "Whether the run hit a step/total/run-budget timeout", + "monitoringIncidentId": { + "type": "string", + "description": "Monitoring incident ID to link this status page incident to; null for standalone", + "format": "uuid", "nullable": true } - }, - "required": [ - "check_type", - "exitCode" - ] + } }, - "CodeCheckStep": { + "CreateStatusPageIncidentUpdateRequest": { "required": [ - "name", + "body", "status" ], "type": "object", "properties": { - "name": { + "status": { "type": "string", - "description": "Step name from test.step() or test() call" + "description": "Incident status at this point in the timeline", + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] }, - "status": { + "body": { + "minLength": 1, "type": "string", - "description": "Step outcome: passed, failed, skipped, or timedOut" + "description": "Update body in markdown" }, - "durationMs": { - "type": "integer", - "description": "Step duration in milliseconds", - "format": "int32", + "notifySubscribers": { + "type": "boolean", + "description": "Whether to email confirmed subscribers about this update (default: true)", "nullable": true }, - "error": { - "type": "string", - "description": "Error message if the step failed", - "nullable": true + "affectedComponents": { + "type": "array", + "description": "Updated affected components; null preserves current", + "nullable": true, + "items": { + "$ref": "#/components/schemas/AffectedComponent" + } } - }, - "description": "A single named step within a code check execution" + } }, - "ComponentImpact": { + "CreateStatusPageMaintenanceRequest": { "required": [ - "componentId", - "componentName", - "uptimePercentage", - "partialOutageSeconds", - "majorOutageSeconds" + "body", + "impact", + "scheduledFor", + "title" ], "type": "object", "properties": { - "componentId": { + "title": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "Status page component UUID", - "format": "uuid" + "description": "Customer-facing maintenance title" }, - "componentName": { + "status": { "type": "string", - "description": "Component display name" + "description": "Initial status (default: INVESTIGATING)", + "nullable": true, + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] }, - "groupName": { + "impact": { "type": "string", - "description": "Parent group display name when the component belongs to a group", - "nullable": true + "description": "Impact level: NONE, MINOR, MAJOR, or CRITICAL", + "enum": [ + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" + ] }, - "uptimePercentage": { - "type": "number", - "description": "Computed uptime % for this component on this day", - "format": "double" + "body": { + "minLength": 1, + "type": "string", + "description": "Initial update body in markdown" }, - "partialOutageSeconds": { - "type": "integer", - "description": "Seconds of partial outage observed on this day", - "format": "int32" + "affectedComponents": { + "type": "array", + "description": "Component IDs affected by this window", + "nullable": true, + "items": { + "$ref": "#/components/schemas/AffectedComponent" + } }, - "majorOutageSeconds": { - "type": "integer", - "description": "Seconds of major outage observed on this day", - "format": "int32" - } - }, - "description": "One component's uptime contribution for the day" - }, - "ComponentPosition": { - "required": [ - "componentId", - "displayOrder" - ], - "type": "object", - "properties": { - "componentId": { + "scheduledFor": { "type": "string", - "description": "Component ID", - "format": "uuid" - }, - "displayOrder": { - "type": "integer", - "description": "New display order (0-based)", - "format": "int32" + "description": "Maintenance start time", + "format": "date-time" }, - "groupId": { + "scheduledUntil": { "type": "string", - "description": "Target group ID, null for ungrouped", - "format": "uuid", + "description": "Maintenance end time", + "format": "date-time", + "nullable": true + }, + "autoResolve": { + "type": "boolean", + "description": "Auto-resolve at scheduledUntil (default: false)", + "nullable": true + }, + "notifySubscribers": { + "type": "boolean", + "description": "Whether to email confirmed subscribers about this window (default: true)", "nullable": true } - }, - "description": "A single component position" + } }, - "ComponentSample": { + "CreateStatusPageRequest": { "required": [ - "componentId", - "newStatus" + "name", + "slug" ], "type": "object", "properties": { - "componentId": { + "name": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "Component ID", - "format": "uuid" + "description": "Human-readable name for this status page" }, - "componentName": { + "slug": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$", "type": "string", - "description": "Component display name", - "nullable": true + "description": "URL slug (lowercase, hyphens, globally unique)" }, - "oldStatus": { + "description": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "Previous status before the flip", + "description": "Optional description shown below the page header", "nullable": true }, - "newStatus": { + "branding": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/StatusPageBranding" + } + ] + }, + "visibility": { "type": "string", - "description": "New status after the flip" - } - }, - "description": "One component sample inside a transition rollup" - }, - "ComponentsSummaryDto": { - "required": [ - "groupComponentCounts", - "includedCount", - "totalCount" - ], - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "description": "Total active components for this service across all groups", - "format": "int32" + "description": "Page visibility: PUBLIC, PASSWORD, or IP_RESTRICTED (default: PUBLIC)", + "nullable": true, + "enum": [ + "PUBLIC", + "PASSWORD", + "IP_RESTRICTED" + ] }, - "includedCount": { - "type": "integer", - "description": "Number of components actually returned in the inline ``components`` list", - "format": "int32" + "enabled": { + "type": "boolean", + "description": "Whether the page is enabled (default: true)", + "nullable": true }, - "groupComponentCounts": { - "type": "object", - "additionalProperties": { - "type": "integer", - "description": "Per-group active leaf count, keyed by group component id (UUID stringified). Empty when the service has no groups; lets the UI render \"show all N\" affordances without a second round trip", - "format": "int32" - }, - "description": "Per-group active leaf count, keyed by group component id (UUID stringified). Empty when the service has no groups; lets the UI render \"show all N\" affordances without a second round trip" + "incidentMode": { + "type": "string", + "description": "Incident mode: MANUAL, REVIEW, or AUTOMATIC (default: AUTOMATIC)", + "nullable": true, + "enum": [ + "MANUAL", + "REVIEW", + "AUTOMATIC" + ] + }, + "managedBy": { + "type": "string", + "description": "Source creating this page: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API when omitted.", + "nullable": true, + "enum": [ + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" + ] } } }, - "ComponentStatusDto": { + "CreateTagRequest": { "required": [ - "id", - "name", - "status" + "name" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "Component UUID" - }, "name": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "Human-readable component name" + "description": "Tag name, unique within the org" }, - "status": { + "color": { + "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "type": "string", - "description": "Current component status, e.g. operational, degraded_performance" + "description": "Hex color code (defaults to #6B7280 if omitted)", + "nullable": true } }, - "description": "Current status of each active component" + "description": "Request body for creating a tag" }, - "ComponentTransitionEventDto": { + "CreateWebhookEndpointRequest": { "required": [ - "componentSample", - "newStatus", - "componentCount" + "subscribedEvents", + "url" ], "type": "object", "properties": { - "newStatus": { + "url": { + "maxLength": 2048, + "minLength": 0, "type": "string", - "description": "New status that defines this rollup bucket" + "description": "HTTPS endpoint that receives webhook event payloads" }, - "componentCount": { - "type": "integer", - "description": "Total components in the 5-minute rollup bucket", - "format": "int32" + "description": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Optional human-readable description", + "nullable": true }, - "componentSample": { + "subscribedEvents": { + "minItems": 1, "type": "array", - "description": "Up to 5 sample components from the bucket", + "description": "Event types to deliver", "items": { - "$ref": "#/components/schemas/ComponentSample" + "minLength": 1, + "type": "string", + "enum": [ + "monitor.created", + "monitor.updated", + "monitor.deleted", + "incident.created", + "incident.resolved", + "incident.reopened", + "service.status_changed", + "service.component_changed", + "service.incident_created", + "service.incident_updated", + "service.incident_resolved" + ] } } - }, - "description": "Rolled-up component status transitions for a status-events rail row" + } }, - "ComponentUptimeDayDto": { + "CreateWorkspaceRequest": { "required": [ - "date", - "partialOutageSeconds", - "majorOutageSeconds", - "degradedSeconds", - "uptimePercentage" + "name" ], "type": "object", "properties": { - "date": { + "name": { + "minLength": 1, "type": "string", - "description": "Start-of-day timestamp for this bucket (UTC midnight, ISO 8601)", - "format": "date-time" + "description": "Workspace name" + } + }, + "description": "Create a new workspace within the organization" + }, + "CreditPolicy": { + "type": "object", + "properties": { + "summary": { + "type": "string", + "description": "Brief summary of credit policy", + "nullable": true }, - "partialOutageSeconds": { + "maxCreditPercent": { "type": "integer", - "description": "Seconds of partial outage observed on this day", - "format": "int32" + "description": "Max credit as percent of monthly fee", + "format": "int32", + "nullable": true }, - "majorOutageSeconds": { + "claimWindowDays": { "type": "integer", - "description": "Seconds of major outage observed on this day", - "format": "int32" + "description": "Days to submit a credit claim after eligibility", + "format": "int32", + "nullable": true }, - "degradedSeconds": { + "creditApplicationDays": { "type": "integer", - "description": "Seconds the component spent in degraded performance on this day", - "format": "int32" - }, - "uptimePercentage": { - "type": "number", - "description": "Computed uptime percentage using the weighted formula (degraded does not lower it)", - "format": "double" + "description": "Days for credit to be applied after approval", + "format": "int32", + "nullable": true }, - "incidents": { + "tiers": { "type": "array", - "description": "Incidents that overlapped this day, in display order", + "description": "Credit tiers by uptime threshold", "nullable": true, "items": { - "$ref": "#/components/schemas/IncidentRef" + "$ref": "#/components/schemas/CreditTier" } } }, - "description": "Daily uptime data for a component" + "description": "Service credit policy for SLA violations" }, - "ComponentUptimeSummaryDto": { + "CreditTier": { "required": [ - "source" + "uptimeRange" ], "type": "object", "properties": { - "day": { - "type": "number", - "description": "Uptime percentage over the last 24 hours", - "format": "double", - "nullable": true, - "example": 99.95 + "uptimeRange": { + "type": "string", + "description": "Uptime range, e.g. '99.1% – 99.98%'" }, - "week": { - "type": "number", - "description": "Uptime percentage over the last 7 days", - "format": "double", - "nullable": true, - "example": 99.98 + "creditPercent": { + "type": "integer", + "description": "Credit percent of monthly fee", + "format": "int32", + "nullable": true }, - "month": { - "type": "number", - "description": "Uptime percentage over the last 30 days", - "format": "double", - "nullable": true, - "example": 99.92 + "formula": { + "type": "string", + "description": "Credit formula when percent is not a fixed number", + "nullable": true }, - "source": { + "notes": { "type": "string", - "description": "Data source: vendor_reported or incident_derived", - "example": "vendor_reported" + "description": "Additional notes on this credit tier", + "nullable": true } }, - "description": "Inline uptime percentages for 24h, 7d, 30d" + "description": "Credit tiers by uptime threshold" }, - "ConfirmationPolicy": { + "CursorPageCheckResultDto": { "required": [ - "type", - "minRegionsFailing", - "maxWaitSeconds" + "data", + "hasMore" ], "type": "object", "properties": { - "type": { - "type": "string", - "description": "How incident confirmation is coordinated across regions", - "enum": [ - "multi_region" - ] + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/CheckResultDto" + } }, - "minRegionsFailing": { - "type": "integer", - "description": "Minimum failing regions required to confirm an incident", - "format": "int32" + "nextCursor": { + "type": "string", + "description": "Opaque cursor for the next page; null when there are no more results", + "nullable": true }, - "maxWaitSeconds": { - "type": "integer", - "description": "Maximum seconds to wait for enough regions to fail after first trigger", - "format": "int32" + "hasMore": { + "type": "boolean", + "description": "Whether more results exist beyond this page" } }, - "description": "Multi-region confirmation settings" + "description": "Cursor-paginated response for time-series and append-only data" }, - "CreateAlertChannelRequest": { + "CursorPageIncidentActivityEventDto": { "required": [ - "config", - "name" + "data", + "hasMore" ], "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "description": "Human-readable name for this alert channel" - }, - "config": { - "oneOf": [ - { - "$ref": "#/components/schemas/DatadogChannelConfig" - }, - { - "$ref": "#/components/schemas/DiscordChannelConfig" - }, - { - "$ref": "#/components/schemas/EmailChannelConfig" - }, - { - "$ref": "#/components/schemas/GitLabChannelConfig" - }, - { - "$ref": "#/components/schemas/GoogleChatChannelConfig" - }, - { - "$ref": "#/components/schemas/IncidentIoChannelConfig" - }, - { - "$ref": "#/components/schemas/JiraChannelConfig" - }, - { - "$ref": "#/components/schemas/LinearChannelConfig" - }, - { - "$ref": "#/components/schemas/MattermostChannelConfig" - }, - { - "$ref": "#/components/schemas/OpsGenieChannelConfig" - }, - { - "$ref": "#/components/schemas/PagerDutyChannelConfig" - }, - { - "$ref": "#/components/schemas/PhoneCallChannelConfig" - }, - { - "$ref": "#/components/schemas/PushbulletChannelConfig" - }, - { - "$ref": "#/components/schemas/PushoverChannelConfig" - }, - { - "$ref": "#/components/schemas/RootlyChannelConfig" - }, - { - "$ref": "#/components/schemas/SlackChannelConfig" - }, - { - "$ref": "#/components/schemas/SmsChannelConfig" - }, - { - "$ref": "#/components/schemas/SplunkOnCallChannelConfig" - }, - { - "$ref": "#/components/schemas/TeamsChannelConfig" - }, - { - "$ref": "#/components/schemas/TelegramChannelConfig" - }, - { - "$ref": "#/components/schemas/WebhookChannelConfig" - }, - { - "$ref": "#/components/schemas/ZapierChannelConfig" - } - ] + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/IncidentActivityEventDto" + } }, - "managedBy": { + "nextCursor": { "type": "string", - "description": "Source creating this channel: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API when omitted.", - "nullable": true, - "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" - ] + "description": "Opaque cursor for the next page; null when there are no more results", + "nullable": true + }, + "hasMore": { + "type": "boolean", + "description": "Whether more results exist beyond this page" } - } + }, + "description": "Cursor-paginated response for time-series and append-only data" }, - "CreateApiKeyRequest": { + "CursorPageNotificationDispatchDto": { "required": [ - "name" + "data", + "hasMore" ], "type": "object", "properties": { - "name": { - "maxLength": 200, - "minLength": 0, - "type": "string", - "description": "Human-readable name to identify this API key" + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/NotificationDispatchDto" + } }, - "expiresAt": { + "nextCursor": { "type": "string", - "description": "Optional expiration timestamp in ISO 8601 format", - "format": "date-time", + "description": "Opaque cursor for the next page; null when there are no more results", "nullable": true + }, + "hasMore": { + "type": "boolean", + "description": "Whether more results exist beyond this page" } - } + }, + "description": "Cursor-paginated response for time-series and append-only data" }, - "CreateAssertionRequest": { + "CursorPageRunDto": { "required": [ - "config" + "data", + "hasMore" ], "type": "object", "properties": { - "config": { - "oneOf": [ - { - "$ref": "#/components/schemas/BodyContainsAssertion" - }, - { - "$ref": "#/components/schemas/DnsExpectedCnameAssertion" - }, - { - "$ref": "#/components/schemas/DnsExpectedIpsAssertion" - }, - { - "$ref": "#/components/schemas/DnsMaxAnswersAssertion" - }, - { - "$ref": "#/components/schemas/DnsMinAnswersAssertion" - }, - { - "$ref": "#/components/schemas/DnsRecordContainsAssertion" - }, - { - "$ref": "#/components/schemas/DnsRecordEqualsAssertion" - }, - { - "$ref": "#/components/schemas/DnsResolvesAssertion" - }, - { - "$ref": "#/components/schemas/DnsResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/DnsResponseTimeWarnAssertion" - }, - { - "$ref": "#/components/schemas/DnsTtlHighAssertion" - }, - { - "$ref": "#/components/schemas/DnsTtlLowAssertion" - }, - { - "$ref": "#/components/schemas/DnsTxtContainsAssertion" - }, - { - "$ref": "#/components/schemas/HeaderValueAssertion" - }, - { - "$ref": "#/components/schemas/HeartbeatIntervalDriftAssertion" - }, - { - "$ref": "#/components/schemas/HeartbeatMaxIntervalAssertion" - }, - { - "$ref": "#/components/schemas/HeartbeatPayloadContainsAssertion" - }, - { - "$ref": "#/components/schemas/HeartbeatReceivedAssertion" - }, - { - "$ref": "#/components/schemas/IcmpPacketLossAssertion" - }, - { - "$ref": "#/components/schemas/IcmpReachableAssertion" - }, - { - "$ref": "#/components/schemas/IcmpResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/IcmpResponseTimeWarnAssertion" - }, - { - "$ref": "#/components/schemas/JsonPathAssertion" - }, - { - "$ref": "#/components/schemas/McpConnectsAssertion" - }, - { - "$ref": "#/components/schemas/McpHasCapabilityAssertion" - }, - { - "$ref": "#/components/schemas/McpMinToolsAssertion" - }, - { - "$ref": "#/components/schemas/McpProtocolVersionAssertion" - }, - { - "$ref": "#/components/schemas/McpResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/McpResponseTimeWarnAssertion" - }, - { - "$ref": "#/components/schemas/McpToolAvailableAssertion" - }, - { - "$ref": "#/components/schemas/McpToolCountChangedAssertion" - }, - { - "$ref": "#/components/schemas/RedirectCountAssertion" - }, - { - "$ref": "#/components/schemas/RedirectTargetAssertion" - }, - { - "$ref": "#/components/schemas/RegexBodyAssertion" - }, - { - "$ref": "#/components/schemas/ResponseSizeAssertion" - }, - { - "$ref": "#/components/schemas/ResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/ResponseTimeWarnAssertion" - }, - { - "$ref": "#/components/schemas/SslExpiryAssertion" - }, - { - "$ref": "#/components/schemas/StatusCodeAssertion" - }, - { - "$ref": "#/components/schemas/TcpConnectsAssertion" - }, - { - "$ref": "#/components/schemas/TcpResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/TcpResponseTimeWarnAssertion" - } - ] + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/RunDto" + } }, - "severity": { + "nextCursor": { "type": "string", - "description": "Outcome severity: FAIL (fails the check) or WARN (warns without failing, default: FAIL)", - "nullable": true, - "enum": [ - "fail", - "warn" - ] + "description": "Opaque cursor for the next page; null when there are no more results", + "nullable": true + }, + "hasMore": { + "type": "boolean", + "description": "Whether more results exist beyond this page" } }, - "description": "Replace all assertions; null preserves current" + "description": "Cursor-paginated response for time-series and append-only data" }, - "CreateEnvironmentRequest": { + "CursorPageServiceCatalogDto": { "required": [ - "name", - "slug" + "data", + "hasMore" ], "type": "object", "properties": { - "name": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "Human-readable environment name" + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/ServiceCatalogDto" + } }, - "slug": { - "maxLength": 100, - "minLength": 0, - "pattern": "^[a-z0-9][a-z0-9_-]*$", + "nextCursor": { "type": "string", - "description": "URL-safe identifier (lowercase alphanumeric, hyphens, underscores)" - }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "Initial key-value variable pairs for this environment", - "nullable": true - }, - "description": "Initial key-value variable pairs for this environment", + "description": "Opaque cursor for the next page; null when there are no more results", "nullable": true }, - "isDefault": { - "type": "boolean", - "description": "Whether this is the default environment for new monitors (default: false)", - "nullable": true + "hasMore": { + "type": "boolean", + "description": "Whether more results exist beyond this page" } - } + }, + "description": "Cursor-paginated response for time-series and append-only data" }, - "CreateInviteRequest": { + "CursorPageServicePollResultDto": { "required": [ - "email", - "roleOffered" + "data", + "hasMore" ], "type": "object", "properties": { - "email": { - "minLength": 1, - "type": "string", - "description": "Email address to invite", - "format": "email" + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/ServicePollResultDto" + } }, - "roleOffered": { + "nextCursor": { "type": "string", - "description": "Role to assign on acceptance", - "enum": [ - "OWNER", - "ADMIN", - "MEMBER" - ] + "description": "Opaque cursor for the next page; null when there are no more results", + "nullable": true + }, + "hasMore": { + "type": "boolean", + "description": "Whether more results exist beyond this page" } }, - "description": "Invite a new member to the organization by email" + "description": "Cursor-paginated response for time-series and append-only data" }, - "CreateMaintenanceWindowRequest": { + "CursorPageStatusEventDto": { "required": [ - "endsAt", - "startsAt" + "data", + "hasMore" ], "type": "object", "properties": { - "monitorId": { - "type": "string", - "description": "Monitor to attach this maintenance window to; null for org-wide", - "format": "uuid", - "nullable": true - }, - "startsAt": { - "type": "string", - "description": "Scheduled start of the maintenance window (ISO 8601)", - "format": "date-time" - }, - "endsAt": { - "type": "string", - "description": "Scheduled end of the maintenance window (ISO 8601)", - "format": "date-time" - }, - "repeatRule": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "Reserved: iCal RRULE for recurring windows (stored but not yet honored)", - "nullable": true + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/StatusEventDto" + } }, - "reason": { - "maxLength": 500, - "minLength": 0, + "nextCursor": { "type": "string", - "description": "Human-readable reason for the maintenance (max 500 chars)", + "description": "Opaque cursor for the next page; null when there are no more results", "nullable": true }, - "suppressAlerts": { + "hasMore": { "type": "boolean", - "description": "Whether to suppress alerts during this window (default: true)", - "nullable": true + "description": "Whether more results exist beyond this page" } - } + }, + "description": "Cursor-paginated response for time-series and append-only data" }, - "CreateManualIncidentRequest": { + "DashboardOverviewDto": { "required": [ - "severity", - "title" + "incidents", + "monitors" ], "type": "object", "properties": { - "title": { - "minLength": 1, - "type": "string", - "description": "Short summary of the incident" + "monitors": { + "$ref": "#/components/schemas/MonitorsSummaryDto" }, - "severity": { + "incidents": { + "$ref": "#/components/schemas/IncidentsSummaryDto" + } + }, + "description": "Combined dashboard overview for monitors and incidents" + }, + "DatadogChannelConfig": { + "required": [ + "channelType", + "apiKey" + ], + "type": "object", + "properties": { + "channelType": { "type": "string", - "description": "Incident severity: DOWN, DEGRADED, or MAINTENANCE", "enum": [ - "DOWN", - "DEGRADED", - "MAINTENANCE" + "datadog" ] }, - "monitorId": { - "type": "string", - "description": "Monitor to associate with this incident", - "format": "uuid", - "nullable": true - }, - "body": { + "apiKey": { + "minLength": 1, "type": "string", - "description": "Detailed description or context for the incident", - "nullable": true + "description": "Datadog API key" }, - "serviceId": { + "site": { "type": "string", - "description": "Vendor service to link; optional for Dependencies create CTA", - "format": "uuid", + "description": "Datadog site region (e.g. datadoghq.com, datadoghq.eu, us3.datadoghq.com)", "nullable": true }, - "serviceIncidentId": { + "tags": { "type": "string", - "description": "Vendor incident to link; idempotent if an active org incident already links it", - "format": "uuid", + "description": "Comma-separated tags to attach to events", "nullable": true } } }, - "CreateMonitorRequest": { + "DayIncident": { "required": [ - "config", - "name", - "type" + "affectedComponentIds", + "affectedComponentNames", + "id", + "impact", + "status", + "title", + "scheduled" ], "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, + "id": { "type": "string", - "description": "Human-readable name for this monitor" + "description": "Status page incident UUID", + "format": "uuid" }, - "type": { + "title": { "type": "string", - "description": "Monitor protocol type", + "description": "Incident title" + }, + "status": { + "type": "string", + "description": "Lifecycle status (investigating, identified, monitoring, resolved, …)", "enum": [ - "HTTP", - "DNS", - "MCP_SERVER", - "TCP", - "ICMP", - "HEARTBEAT", - "BROWSER", - "MULTI_STEP_API" + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" ] }, - "config": { - "oneOf": [ - { - "$ref": "#/components/schemas/DnsMonitorConfig" - }, - { - "$ref": "#/components/schemas/HeartbeatMonitorConfig" - }, - { - "$ref": "#/components/schemas/HttpMonitorConfig" - }, - { - "$ref": "#/components/schemas/IcmpMonitorConfig" - }, - { - "$ref": "#/components/schemas/McpServerMonitorConfig" - }, - { - "$ref": "#/components/schemas/ScriptMonitorConfig" - }, - { - "$ref": "#/components/schemas/TcpMonitorConfig" - } + "impact": { + "type": "string", + "description": "Severity bucket (none, minor, major, critical)", + "enum": [ + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" ] }, - "frequencySeconds": { - "maximum": 86400, - "minimum": 10, - "type": "integer", - "description": "Check frequency in seconds (10–86400); null defaults to plan minimum (60s on most paid plans)", - "format": "int32", - "nullable": true - }, - "enabled": { + "scheduled": { "type": "boolean", - "description": "Whether the monitor is active (default: true)", - "nullable": true - }, - "regions": { - "type": "array", - "description": "Probe regions to run checks from. Allowed values are deployment-dependent; production: us-east, us-west, eu-west, ap-south.", - "nullable": true, - "items": { - "type": "string", - "description": "Probe regions to run checks from. Allowed values are deployment-dependent; production: us-east, us-west, eu-west, ap-south." - } + "description": "True for a maintenance window; false for an incident" }, - "managedBy": { + "startedAt": { "type": "string", - "description": "Source that created/owns this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API when omitted; set to your surface so audit logs, drift detection, and analytics attribute correctly.", - "nullable": true, - "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" - ] + "description": "Incident start timestamp", + "format": "date-time", + "nullable": true }, - "environmentId": { + "resolvedAt": { "type": "string", - "description": "Environment to associate with this monitor", - "format": "uuid", + "description": "Incident resolved timestamp; null while still active", + "format": "date-time", "nullable": true }, - "assertions": { + "affectedComponentNames": { "type": "array", - "description": "Assertions to evaluate against each check result", - "nullable": true, + "description": "Display names of components affected by this incident (deduplicated)", "items": { - "$ref": "#/components/schemas/CreateAssertionRequest" + "type": "string", + "description": "Display names of components affected by this incident (deduplicated)" } }, - "auth": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/MonitorAuthConfig" - } - ] - }, - "incidentPolicy": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/UpdateIncidentPolicyRequest" - } - ] - }, - "alertChannelIds": { + "affectedComponentIds": { "type": "array", - "description": "Alert channels to notify when this monitor triggers", - "nullable": true, + "description": "UUIDs of components this incident affected", "items": { "type": "string", - "description": "Alert channels to notify when this monitor triggers", + "description": "UUIDs of components this incident affected", "format": "uuid" } - }, - "tags": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/AddMonitorTagsRequest" - } - ] } - } + }, + "description": "Incident that overlapped the day" }, - "CreateNotificationPolicyRequest": { + "DefinitionDetailDto": { "required": [ - "escalation", - "name" + "definition", + "heads" ], "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "description": "Human-readable name for this policy" - }, - "description": { - "maxLength": 500, - "minLength": 0, - "type": "string", - "description": "Optional note; omit or null when unused", - "nullable": true + "definition": { + "$ref": "#/components/schemas/DefinitionDto" }, - "matchRules": { + "heads": { "type": "array", - "description": "Match rules to evaluate (all must pass; omit or empty for catch-all)", - "nullable": true, + "description": "Active Heads per environment", "items": { - "$ref": "#/components/schemas/MatchRule" + "$ref": "#/components/schemas/DefinitionHeadDto" } + } + }, + "description": "Definition with Heads for each environment" + }, + "DefinitionDto": { + "required": [ + "createdAt", + "id", + "name", + "slug", + "updatedAt", + "organizationId" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Definition identifier", + "format": "uuid" }, - "escalation": { - "$ref": "#/components/schemas/EscalationChain" + "organizationId": { + "type": "integer", + "description": "Organization this definition belongs to", + "format": "int32" }, - "enabled": { - "type": "boolean", - "description": "Whether this policy is enabled (default true)", - "nullable": true, - "default": true + "name": { + "minLength": 1, + "type": "string", + "description": "Human-readable name" }, - "priority": { - "type": "integer", - "description": "Evaluation priority; higher value = evaluated first (default 0)", - "format": "int32", - "nullable": true, - "default": 0 + "slug": { + "minLength": 1, + "type": "string", + "description": "URL-safe slug unique within the organization" + }, + "createdAt": { + "type": "string", + "description": "When the definition was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "When the definition was last updated", + "format": "date-time" } }, - "description": "Request body for creating a notification policy" + "description": "Code-monitor definition" }, - "CreateResourceGroupRequest": { + "DefinitionHeadDto": { "required": [ - "name" + "activatedAt", + "definitionId", + "environment", + "revision" ], "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, + "definitionId": { "type": "string", - "description": "Human-readable name for this group" + "description": "Definition this Head belongs to", + "format": "uuid" }, - "description": { - "maxLength": 500, - "minLength": 0, + "environment": { + "$ref": "#/components/schemas/EnvironmentDto" + }, + "revision": { + "$ref": "#/components/schemas/RevisionDto" + }, + "activatedAt": { "type": "string", - "description": "Optional description (max 500)", + "description": "When this Head last activated", + "format": "date-time" + }, + "activatedBy": { + "type": "string", + "description": "Who last activated this Head", "nullable": true }, - "alertPolicyId": { + "reason": { "type": "string", - "description": "Optional notification policy to apply for this group", - "format": "uuid", + "description": "Rollback reason when this Head was restored", "nullable": true + } + }, + "description": "Active Head for a definition in one environment" + }, + "DekRotationResultDto": { + "required": [ + "rotatedAt", + "previousDekVersion", + "newDekVersion", + "secretsReEncrypted", + "channelsReEncrypted" + ], + "type": "object", + "properties": { + "previousDekVersion": { + "type": "integer", + "description": "DEK version before rotation", + "format": "int32" }, - "defaultFrequency": { - "maximum": 86400, - "minimum": 30, + "newDekVersion": { "type": "integer", - "description": "Default check frequency in seconds applied to members (30–86400)", - "format": "int32", - "nullable": true + "description": "DEK version after rotation", + "format": "int32" }, - "defaultRegions": { - "type": "array", - "description": "Default regions applied to member monitors", - "nullable": true, - "items": { - "type": "string", - "description": "Default regions applied to member monitors" - } + "secretsReEncrypted": { + "type": "integer", + "description": "Number of secrets re-encrypted with the new DEK", + "format": "int32" }, - "defaultRetryStrategy": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/RetryStrategy" - } - ] + "channelsReEncrypted": { + "type": "integer", + "description": "Number of alert channels re-encrypted with the new DEK", + "format": "int32" }, - "defaultAlertChannels": { - "type": "array", - "description": "Default alert channel IDs applied to member monitors", - "nullable": true, - "items": { - "type": "string", - "description": "Default alert channel IDs applied to member monitors", - "format": "uuid" - } + "rotatedAt": { + "type": "string", + "description": "Timestamp when the rotation was performed", + "format": "date-time" + } + }, + "description": "Result of a data encryption key rotation operation" + }, + "DeleteChannelResult": { + "type": "object", + "properties": { + "affectedPolicies": { + "type": "integer", + "description": "Number of notification policies whose escalation steps were modified", + "format": "int32" }, - "defaultEnvironmentId": { + "disabledPolicies": { + "type": "integer", + "description": "Number of notification policies disabled because they had no remaining channels", + "format": "int32" + } + }, + "description": "Summary of policies affected by channel deletion", + "required": [ + "affectedPolicies", + "disabledPolicies" + ] + }, + "DeliveryAttemptDto": { + "required": [ + "attemptedAt", + "deliveryId", + "id", + "status", + "attemptNumber" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "Default environment ID applied to member monitors", - "format": "uuid", - "nullable": true + "format": "uuid" }, - "healthThresholdType": { + "deliveryId": { "type": "string", - "description": "Health threshold type: COUNT or PERCENTAGE", - "nullable": true, - "enum": [ - "COUNT", - "PERCENTAGE" - ] + "format": "uuid" }, - "healthThresholdValue": { - "maximum": 100, - "exclusiveMaximum": false, - "minimum": 0, - "exclusiveMinimum": false, - "type": "number", - "description": "Health threshold value: count (0+) or percentage (0–100)", + "attemptNumber": { + "type": "integer", + "description": "1-based attempt number", + "format": "int32" + }, + "status": { + "type": "string", + "description": "Outcome: SUCCESS, FAILED, TIMEOUT, ERROR" + }, + "responseStatusCode": { + "type": "integer", + "description": "HTTP response status code from the external service", + "format": "int32", + "nullable": true + }, + "requestPayload": { + "type": "string", + "description": "JSON payload sent to the external service", "nullable": true }, - "suppressMemberAlerts": { - "type": "boolean", - "description": "Suppress member-level alert notifications when group manages alerting", + "responseBody": { + "type": "string", + "description": "Response body from the external service (truncated)", "nullable": true }, - "confirmationDelaySeconds": { - "maximum": 600, - "minimum": 0, - "type": "integer", - "description": "Confirmation delay in seconds before group incident creation (0–600)", - "format": "int32", + "errorMessage": { + "type": "string", + "description": "Error message if the attempt failed", "nullable": true }, - "recoveryCooldownMinutes": { - "maximum": 60, - "minimum": 0, + "responseTimeMs": { "type": "integer", - "description": "Recovery cooldown in minutes after group incident resolves (0–60)", + "description": "Round-trip time in milliseconds", "format": "int32", "nullable": true }, - "managedBy": { + "externalId": { "type": "string", - "description": "Source creating this group: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API when omitted.", - "nullable": true, - "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" - ] + "description": "External identifier (e.g. PagerDuty dedup_key, SES MessageId, webhook delivery UUID)", + "nullable": true + }, + "requestHeaders": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "HTTP request headers sent to the external service", + "nullable": true + }, + "description": "HTTP request headers sent to the external service", + "nullable": true + }, + "attemptedAt": { + "type": "string", + "format": "date-time" } }, - "description": "Request body for creating a resource group" + "description": "Single delivery attempt with request/response audit data" }, - "CreateSecretRequest": { + "DeployLockDto": { "required": [ - "key", - "value" + "expiresAt", + "id", + "lockedAt", + "lockedBy" ], "type": "object", "properties": { - "key": { - "maxLength": 255, - "minLength": 0, + "id": { "type": "string", - "description": "Unique secret key within the workspace (max 255 chars)" + "description": "Unique lock identifier", + "format": "uuid" }, - "value": { - "maxLength": 32768, - "minLength": 0, + "lockedBy": { + "minLength": 1, "type": "string", - "description": "Secret value, stored encrypted (max 32KB)" + "description": "Identity of the lock holder (e.g. CLI session ID, username)" + }, + "lockedAt": { + "type": "string", + "description": "Timestamp when the lock was acquired", + "format": "date-time" + }, + "expiresAt": { + "type": "string", + "description": "Timestamp when the lock automatically expires", + "format": "date-time" } - } + }, + "description": "Represents an active deploy lock for a workspace" }, - "CreateStatusPageComponentGroupRequest": { + "DiscordChannelConfig": { "required": [ - "name" + "channelType", + "webhookUrl" ], "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, + "channelType": { "type": "string", - "description": "Group display name" + "enum": [ + "discord" + ] }, - "description": { - "maxLength": 500, - "minLength": 0, + "webhookUrl": { + "minLength": 1, "type": "string", - "description": "Optional group description", - "nullable": true - }, - "displayOrder": { - "type": "integer", - "description": "Position in the group list", - "format": "int32", - "nullable": true + "description": "Discord webhook URL" }, - "defaultOpen": { - "type": "boolean", - "description": "Initial expand/collapse state when a visitor first loads the page; renderer may auto-expand on active incidents (default: true)", + "mentionRoleId": { + "type": "string", + "description": "Optional Discord role ID to mention in notifications", "nullable": true } } }, - "CreateStatusPageComponentRequest": { - "required": [ - "name", - "type" - ], + "Dns": { "type": "object", + "description": "DNS check-type-specific details", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "description": "Component display name" - }, - "description": { - "maxLength": 500, - "minLength": 0, - "type": "string", - "description": "Optional description shown on expand", - "nullable": true - }, - "type": { + "check_type": { "type": "string", - "description": "Component type: MONITOR, GROUP, STATIC, or DEPENDENCY", "enum": [ - "MONITOR", - "GROUP", - "STATIC", - "DEPENDENCY" + "dns" ] }, - "monitorId": { - "type": "string", - "description": "Monitor ID (required when type=MONITOR)", - "format": "uuid", - "nullable": true - }, - "resourceGroupId": { + "hostname": { "type": "string", - "description": "Resource group ID (required when type=GROUP)", - "format": "uuid", + "description": "Target hostname", "nullable": true }, - "serviceSubscriptionId": { - "type": "string", - "description": "Service subscription (Dependency) ID — required when type=DEPENDENCY. Bind an existing org subscription; catalog picks must create the subscription first, then pass its id", - "format": "uuid", - "nullable": true + "requestedTypes": { + "type": "array", + "description": "Requested DNS record types", + "nullable": true, + "items": { + "type": "string", + "description": "Requested DNS record types", + "nullable": true + } }, - "groupId": { + "usedResolver": { "type": "string", - "description": "Component group ID for visual grouping", - "format": "uuid", - "nullable": true - }, - "showUptime": { - "type": "boolean", - "description": "Whether to show the uptime bar (default: true; false for DEPENDENCY)", + "description": "Resolver used for lookup", "nullable": true }, - "displayOrder": { - "type": "integer", - "description": "Position in the component list", - "format": "int32", + "records": { + "type": "object", + "additionalProperties": { + "type": "array", + "description": "Resolved DNS records keyed by record type", + "nullable": true, + "items": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Resolved DNS records keyed by record type", + "nullable": true + }, + "description": "Resolved DNS records keyed by record type", + "nullable": true + } + }, + "description": "Resolved DNS records keyed by record type", "nullable": true }, - "excludeFromOverall": { - "type": "boolean", - "description": "Exclude from overall status calculation (default: false; true for DEPENDENCY)", - "nullable": true + "attempts": { + "type": "array", + "description": "DNS resolution attempts", + "nullable": true, + "items": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "DNS resolution attempts", + "nullable": true + }, + "description": "DNS resolution attempts", + "nullable": true + } }, - "startDate": { + "failureKind": { "type": "string", - "description": "Date from which to start showing uptime; defaults to component creation. Set earlier to backdate (e.g. launch day); clamped at the monitor's createdAt for MONITOR-type components", - "format": "date", + "description": "Kind of DNS failure, if any", "nullable": true } - } + }, + "required": [ + "check_type" + ] }, - "CreateStatusPageIncidentRequest": { + "DnsExpectedCnameAssertion": { "required": [ - "body", - "impact", - "title" + "type", + "value" ], "type": "object", "properties": { - "title": { - "maxLength": 500, - "minLength": 0, - "type": "string", - "description": "Customer-facing incident title" - }, - "status": { + "type": { "type": "string", - "description": "Initial status (default: INVESTIGATING)", - "nullable": true, "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" + "dns_expected_cname" ] }, - "impact": { + "value": { + "minLength": 1, + "type": "string", + "description": "Expected CNAME target the resolution must include" + } + } + }, + "DnsExpectedIpsAssertion": { + "required": [ + "type", + "ips" + ], + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Impact level: NONE, MINOR, MAJOR, or CRITICAL", "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" + "dns_expected_ips" ] }, - "body": { - "minLength": 1, - "type": "string", - "description": "Initial update body in markdown" - }, - "affectedComponents": { + "ips": { + "minItems": 1, "type": "array", - "description": "Component IDs affected by this incident", - "nullable": true, + "description": "Allowed IP addresses; at least one resolved address must match", "items": { - "$ref": "#/components/schemas/AffectedComponent" + "type": "string", + "description": "Allowed IP addresses; at least one resolved address must match" } - }, - "notifySubscribers": { - "type": "boolean", - "description": "Whether to email confirmed subscribers about this incident (default: true)", - "nullable": true - }, - "monitoringIncidentId": { - "type": "string", - "description": "Monitoring incident ID to link this status page incident to; null for standalone", - "format": "uuid", - "nullable": true } } }, - "CreateStatusPageIncidentUpdateRequest": { + "DnsMaxAnswersAssertion": { "required": [ - "body", - "status" + "type", + "recordType", + "max" ], "type": "object", "properties": { - "status": { + "type": { "type": "string", - "description": "Incident status at this point in the timeline", "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" + "dns_max_answers" ] }, - "body": { + "recordType": { "minLength": 1, "type": "string", - "description": "Update body in markdown" - }, - "notifySubscribers": { - "type": "boolean", - "description": "Whether to email confirmed subscribers about this update (default: true)", - "nullable": true + "description": "DNS record type whose answer count is checked" }, - "affectedComponents": { - "type": "array", - "description": "Updated affected components; null preserves current", - "nullable": true, - "items": { - "$ref": "#/components/schemas/AffectedComponent" - } + "max": { + "type": "integer", + "description": "Maximum number of answers allowed for that record type", + "format": "int32" } } }, - "CreateStatusPageMaintenanceRequest": { + "DnsMinAnswersAssertion": { "required": [ - "body", - "impact", - "scheduledFor", - "title" + "type", + "recordType", + "min" ], "type": "object", "properties": { - "title": { - "maxLength": 500, - "minLength": 0, - "type": "string", - "description": "Customer-facing maintenance title" - }, - "status": { - "type": "string", - "description": "Initial status (default: INVESTIGATING)", - "nullable": true, - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" - ] - }, - "impact": { + "type": { "type": "string", - "description": "Impact level: NONE, MINOR, MAJOR, or CRITICAL", "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" + "dns_min_answers" ] }, - "body": { + "recordType": { "minLength": 1, "type": "string", - "description": "Initial update body in markdown" - }, - "affectedComponents": { - "type": "array", - "description": "Component IDs affected by this window", - "nullable": true, - "items": { - "$ref": "#/components/schemas/AffectedComponent" - } - }, - "scheduledFor": { - "type": "string", - "description": "Maintenance start time", - "format": "date-time" - }, - "scheduledUntil": { - "type": "string", - "description": "Maintenance end time", - "format": "date-time", - "nullable": true - }, - "autoResolve": { - "type": "boolean", - "description": "Auto-resolve at scheduledUntil (default: false)", - "nullable": true + "description": "DNS record type whose answer count is checked" }, - "notifySubscribers": { - "type": "boolean", - "description": "Whether to email confirmed subscribers about this window (default: true)", - "nullable": true + "min": { + "type": "integer", + "description": "Minimum number of answers required for that record type", + "format": "int32" } } }, - "CreateStatusPageRequest": { + "DnsMonitorConfig": { "required": [ - "name", - "slug" + "hostname" ], "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "description": "Human-readable name for this status page" - }, - "slug": { - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$", - "type": "string", - "description": "URL slug (lowercase, hyphens, globally unique)" - }, - "description": { - "maxLength": 500, - "minLength": 0, + "hostname": { + "minLength": 1, "type": "string", - "description": "Optional description shown below the page header", - "nullable": true + "description": "Domain name to resolve" }, - "branding": { + "recordTypes": { + "type": "array", + "description": "DNS record types to query: A, AAAA, CNAME, MX, NS, TXT, SRV, SOA, CAA, PTR", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/StatusPageBranding" - } - ] + "items": { + "type": "string", + "description": "DNS record types to query: A, AAAA, CNAME, MX, NS, TXT, SRV, SOA, CAA, PTR", + "nullable": true, + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "NS", + "TXT", + "SRV", + "SOA", + "CAA", + "PTR" + ] + } }, - "visibility": { - "type": "string", - "description": "Page visibility: PUBLIC, PASSWORD, or IP_RESTRICTED (default: PUBLIC)", + "nameservers": { + "type": "array", + "description": "Custom nameservers to query (uses system defaults if omitted)", "nullable": true, - "enum": [ - "PUBLIC", - "PASSWORD", - "IP_RESTRICTED" - ] + "items": { + "type": "string", + "description": "Custom nameservers to query (uses system defaults if omitted)", + "nullable": true + } }, - "enabled": { - "type": "boolean", - "description": "Whether the page is enabled (default: true)", + "timeoutMs": { + "type": "integer", + "description": "Per-query timeout in milliseconds", + "format": "int32", "nullable": true }, - "incidentMode": { - "type": "string", - "description": "Incident mode: MANUAL, REVIEW, or AUTOMATIC (default: AUTOMATIC)", - "nullable": true, - "enum": [ - "MANUAL", - "REVIEW", - "AUTOMATIC" - ] - }, - "managedBy": { - "type": "string", - "description": "Source creating this page: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API when omitted.", - "nullable": true, - "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" - ] + "totalTimeoutMs": { + "type": "integer", + "description": "Total timeout for all queries in milliseconds", + "format": "int32", + "nullable": true } } }, - "CreateTagRequest": { + "DnsRecordContainsAssertion": { "required": [ - "name" + "type", + "recordType", + "substring" ], "type": "object", "properties": { - "name": { - "maxLength": 100, - "minLength": 0, + "type": { "type": "string", - "description": "Tag name, unique within the org" + "enum": [ + "dns_record_contains" + ] }, - "color": { - "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", + "recordType": { + "minLength": 1, "type": "string", - "description": "Hex color code (defaults to #6B7280 if omitted)", - "nullable": true + "description": "DNS record type to assert on (A, AAAA, CNAME, MX, TXT)" + }, + "substring": { + "minLength": 1, + "type": "string", + "description": "Substring that must appear in a matching record value" } - }, - "description": "Request body for creating a tag" + } }, - "CreateWebhookEndpointRequest": { + "DnsRecordEqualsAssertion": { "required": [ - "subscribedEvents", - "url" + "type", + "recordType", + "value" ], "type": "object", "properties": { - "url": { - "maxLength": 2048, - "minLength": 0, + "type": { "type": "string", - "description": "HTTPS endpoint that receives webhook event payloads" + "enum": [ + "dns_record_equals" + ] }, - "description": { - "maxLength": 255, - "minLength": 0, + "recordType": { + "minLength": 1, "type": "string", - "description": "Optional human-readable description", - "nullable": true + "description": "DNS record type to assert on (A, AAAA, CNAME, MX, TXT)" }, - "subscribedEvents": { - "minItems": 1, - "type": "array", - "description": "Event types to deliver", - "items": { - "minLength": 1, - "type": "string", - "enum": [ - "monitor.created", - "monitor.updated", - "monitor.deleted", - "incident.created", - "incident.resolved", - "incident.reopened", - "service.status_changed", - "service.component_changed", - "service.incident_created", - "service.incident_updated", - "service.incident_resolved" - ] - } + "value": { + "minLength": 1, + "type": "string", + "description": "Expected DNS record value for an exact match" } } }, - "CreateWorkspaceRequest": { - "required": [ - "name" - ], + "DnsResolvesAssertion": { "type": "object", "properties": { - "name": { - "minLength": 1, + "type": { "type": "string", - "description": "Workspace name" + "enum": [ + "dns_resolves" + ] } }, - "description": "Create a new workspace within the organization" + "required": [ + "type" + ] }, - "CreditPolicy": { + "DnsResponseTimeAssertion": { "type": "object", "properties": { - "summary": { + "type": { "type": "string", - "description": "Brief summary of credit policy", - "nullable": true - }, - "maxCreditPercent": { - "type": "integer", - "description": "Max credit as percent of monthly fee", - "format": "int32", - "nullable": true - }, - "claimWindowDays": { - "type": "integer", - "description": "Days to submit a credit claim after eligibility", - "format": "int32", - "nullable": true + "enum": [ + "dns_response_time" + ] }, - "creditApplicationDays": { + "maxMs": { "type": "integer", - "description": "Days for credit to be applied after approval", - "format": "int32", - "nullable": true - }, - "tiers": { - "type": "array", - "description": "Credit tiers by uptime threshold", - "nullable": true, - "items": { - "$ref": "#/components/schemas/CreditTier" - } + "description": "Maximum allowed DNS resolution time in milliseconds", + "format": "int32" } }, - "description": "Service credit policy for SLA violations" - }, - "CreditTier": { "required": [ - "uptimeRange" - ], + "type", + "maxMs" + ] + }, + "DnsResponseTimeWarnAssertion": { "type": "object", "properties": { - "uptimeRange": { + "type": { "type": "string", - "description": "Uptime range, e.g. '99.1% – 99.98%'" + "enum": [ + "dns_response_time_warn" + ] }, - "creditPercent": { + "warnMs": { "type": "integer", - "description": "Credit percent of monthly fee", - "format": "int32", - "nullable": true - }, - "formula": { - "type": "string", - "description": "Credit formula when percent is not a fixed number", - "nullable": true - }, - "notes": { - "type": "string", - "description": "Additional notes on this credit tier", - "nullable": true + "description": "DNS resolution time in milliseconds that triggers a warning only", + "format": "int32" } }, - "description": "Credit tiers by uptime threshold" - }, - "CursorPageCheckResultDto": { "required": [ - "data", - "hasMore" - ], + "type", + "warnMs" + ] + }, + "DnsTtlHighAssertion": { "type": "object", "properties": { - "data": { - "type": "array", - "description": "Items on this page", - "items": { - "$ref": "#/components/schemas/CheckResultDto" - } - }, - "nextCursor": { + "type": { "type": "string", - "description": "Opaque cursor for the next page; null when there are no more results", - "nullable": true + "enum": [ + "dns_ttl_high" + ] }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" + "maxTtl": { + "type": "integer", + "description": "Maximum TTL in seconds before a high-TTL warning is raised", + "format": "int32" } }, - "description": "Cursor-paginated response for time-series and append-only data" + "required": [ + "type", + "maxTtl" + ] }, - "CursorPageIncidentActivityEventDto": { + "DnsTtlLowAssertion": { "required": [ - "data", - "hasMore" + "type", + "minTtl" ], "type": "object", "properties": { - "data": { - "type": "array", - "description": "Items on this page", - "items": { - "$ref": "#/components/schemas/IncidentActivityEventDto" - } - }, - "nextCursor": { + "type": { "type": "string", - "description": "Opaque cursor for the next page; null when there are no more results", - "nullable": true + "enum": [ + "dns_ttl_low" + ] }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" + "minTtl": { + "type": "integer", + "description": "Minimum acceptable TTL in seconds before a warning is raised", + "format": "int32" } - }, - "description": "Cursor-paginated response for time-series and append-only data" + } }, - "CursorPageServiceCatalogDto": { + "DnsTxtContainsAssertion": { "required": [ - "data", - "hasMore" + "type", + "substring" ], "type": "object", "properties": { - "data": { - "type": "array", - "description": "Items on this page", - "items": { - "$ref": "#/components/schemas/ServiceCatalogDto" - } - }, - "nextCursor": { + "type": { "type": "string", - "description": "Opaque cursor for the next page; null when there are no more results", - "nullable": true + "enum": [ + "dns_txt_contains" + ] }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" + "substring": { + "minLength": 1, + "type": "string", + "description": "Substring that must appear in at least one TXT record" } - }, - "description": "Cursor-paginated response for time-series and append-only data" + } }, - "CursorPageServicePollResultDto": { + "EmailChannelConfig": { "required": [ - "data", - "hasMore" + "channelType", + "recipients" ], "type": "object", "properties": { - "data": { + "channelType": { + "type": "string", + "enum": [ + "email" + ] + }, + "recipients": { + "minItems": 1, "type": "array", - "description": "Items on this page", + "description": "Email addresses to send notifications to", "items": { - "$ref": "#/components/schemas/ServicePollResultDto" + "type": "string", + "description": "Email addresses to send notifications to", + "format": "email" } - }, - "nextCursor": { - "type": "string", - "description": "Opaque cursor for the next page; null when there are no more results", - "nullable": true - }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" } - }, - "description": "Cursor-paginated response for time-series and append-only data" + } }, - "CursorPageStatusEventDto": { + "EntitlementDto": { "required": [ - "data", - "hasMore" + "key", + "value", + "defaultValue", + "overridden" ], "type": "object", "properties": { - "data": { - "type": "array", - "description": "Items on this page", - "items": { - "$ref": "#/components/schemas/StatusEventDto" - } - }, - "nextCursor": { + "key": { "type": "string", - "description": "Opaque cursor for the next page; null when there are no more results", - "nullable": true + "description": "Entitlement key" }, - "hasMore": { + "value": { + "type": "integer", + "description": "Effective limit value (overrides applied)", + "format": "int64" + }, + "defaultValue": { + "type": "integer", + "description": "Plan-tier default value before overrides", + "format": "int64" + }, + "overridden": { "type": "boolean", - "description": "Whether more results exist beyond this page" + "description": "Whether this entitlement has an org-level override" } }, - "description": "Cursor-paginated response for time-series and append-only data" + "description": "A single resolved entitlement for the organization" }, - "DashboardOverviewDto": { + "EnvironmentDto": { "required": [ - "incidents", - "monitors" + "createdAt", + "id", + "name", + "slug", + "updatedAt", + "variables", + "orgId", + "monitorCount", + "isDefault" ], "type": "object", "properties": { - "monitors": { - "$ref": "#/components/schemas/MonitorsSummaryDto" + "id": { + "type": "string", + "description": "Unique environment identifier", + "format": "uuid" }, - "incidents": { - "$ref": "#/components/schemas/IncidentsSummaryDto" + "orgId": { + "type": "integer", + "description": "Organization this environment belongs to", + "format": "int32" + }, + "name": { + "minLength": 1, + "type": "string", + "description": "Human-readable environment name" + }, + "slug": { + "minLength": 1, + "type": "string", + "description": "URL-safe identifier" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Key-value variable pairs available for interpolation" + }, + "description": "Key-value variable pairs available for interpolation" + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the environment was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "Timestamp when the environment was last updated", + "format": "date-time" + }, + "monitorCount": { + "type": "integer", + "description": "Number of monitors using this environment", + "format": "int32" + }, + "isDefault": { + "type": "boolean", + "description": "Whether this is the default environment for new monitors" } }, - "description": "Combined dashboard overview for monitors and incidents" + "description": "Environment with variable substitutions for monitor configs" }, - "DatadogChannelConfig": { + "ErrorEntry": { "required": [ - "channelType", - "apiKey" + "code", + "message" ], "type": "object", "properties": { - "channelType": { - "type": "string", - "enum": [ - "datadog" - ] - }, - "apiKey": { + "code": { "minLength": 1, "type": "string", - "description": "Datadog API key" + "description": "Stable machine-readable code; see ValidationErrorCode for the registry", + "example": "MONITOR_HEARTBEAT_GRACE_EXCEEDS_INTERVAL" }, - "site": { + "field": { "type": "string", - "description": "Datadog site region (e.g. datadoghq.com, datadoghq.eu, us3.datadoghq.com)", - "nullable": true + "description": "JSON-pointer-like path to the offending field, or null for request-wide errors", + "nullable": true, + "example": "config.gracePeriod" }, - "tags": { + "message": { + "minLength": 1, "type": "string", - "description": "Comma-separated tags to attach to events", - "nullable": true + "description": "Human-readable message; safe to surface to end users" } - } + }, + "description": "One structured validation rejection" }, - "DayIncident": { + "ErrorResponse": { "required": [ - "affectedComponentIds", - "affectedComponentNames", - "id", - "impact", + "code", + "message", "status", - "title", - "scheduled" + "timestamp" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "Status page incident UUID", - "format": "uuid" + "status": { + "type": "integer", + "description": "HTTP status code (mirrors the response status line)", + "format": "int32", + "example": 404 }, - "title": { + "code": { "type": "string", - "description": "Incident title" + "description": "Coarse machine-readable error category (e.g. NOT_FOUND, RATE_LIMITED); stable per status", + "example": "NOT_FOUND" }, - "status": { + "message": { "type": "string", - "description": "Lifecycle status (investigating, identified, monitoring, resolved, …)", - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" - ] + "description": "Human-readable error message; safe to surface to end users", + "example": "Monitor not found" }, - "impact": { + "timestamp": { + "type": "integer", + "description": "Server time when the error was produced (epoch milliseconds)", + "format": "int64", + "example": 1737302400000 + }, + "requestId": { "type": "string", - "description": "Severity bucket (none, minor, major, critical)", - "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" - ] + "description": "Opaque per-request id; same value as the X-Request-Id response header. Use in support tickets.", + "nullable": true, + "example": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a" }, - "scheduled": { - "type": "boolean", - "description": "True for a maintenance window; false for an incident" + "errors": { + "type": "array", + "description": "Structured per-field rejections; populated for validation errors, null otherwise", + "nullable": true, + "items": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/ErrorEntry" + } + ] + } + } + }, + "description": "Uniform error envelope returned for every non-2xx response", + "example": { + "status": 404, + "code": "NOT_FOUND", + "message": "Monitor not found", + "timestamp": 1737302400000, + "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a" + } + }, + "EscalationChain": { + "required": [ + "steps" + ], + "type": "object", + "properties": { + "steps": { + "minItems": 1, + "type": "array", + "description": "Ordered escalation steps, evaluated in sequence", + "items": { + "$ref": "#/components/schemas/EscalationStep" + } }, - "startedAt": { + "onResolve": { "type": "string", - "description": "Incident start timestamp", - "format": "date-time", + "description": "Action when the incident resolves", "nullable": true }, - "resolvedAt": { + "onReopen": { "type": "string", - "description": "Incident resolved timestamp; null while still active", - "format": "date-time", + "description": "Action when a resolved incident reopens", "nullable": true - }, - "affectedComponentNames": { - "type": "array", - "description": "Display names of components affected by this incident (deduplicated)", - "items": { - "type": "string", - "description": "Display names of components affected by this incident (deduplicated)" - } - }, - "affectedComponentIds": { - "type": "array", - "description": "UUIDs of components this incident affected", - "items": { - "type": "string", - "description": "UUIDs of components this incident affected", - "format": "uuid" - } } }, - "description": "Incident that overlapped the day" + "description": "Escalation chain defining which channels to notify; null preserves current" }, - "DekRotationResultDto": { + "EscalationStep": { "required": [ - "rotatedAt", - "previousDekVersion", - "newDekVersion", - "secretsReEncrypted", - "channelsReEncrypted" + "channelIds", + "delayMinutes" ], "type": "object", "properties": { - "previousDekVersion": { + "delayMinutes": { + "minimum": 0, "type": "integer", - "description": "DEK version before rotation", + "description": "Minutes to wait before executing this step (0 = immediate)", "format": "int32" }, - "newDekVersion": { - "type": "integer", - "description": "DEK version after rotation", - "format": "int32" + "channelIds": { + "minItems": 1, + "type": "array", + "description": "Alert channel IDs to notify in this step", + "items": { + "type": "string", + "description": "Alert channel IDs to notify in this step", + "format": "uuid" + } }, - "secretsReEncrypted": { - "type": "integer", - "description": "Number of secrets re-encrypted with the new DEK", - "format": "int32" + "requireAck": { + "type": "boolean", + "description": "Whether an acknowledgment is required before escalating", + "nullable": true }, - "channelsReEncrypted": { + "repeatIntervalSeconds": { + "minimum": 1, "type": "integer", - "description": "Number of alert channels re-encrypted with the new DEK", - "format": "int32" - }, - "rotatedAt": { - "type": "string", - "description": "Timestamp when the rotation was performed", - "format": "date-time" + "description": "Repeat notification interval in seconds until acknowledged", + "format": "int32", + "nullable": true } }, - "description": "Result of a data encryption key rotation operation" + "description": "Ordered escalation steps, evaluated in sequence" }, - "DeleteChannelResult": { + "FailureDetail": { + "required": [ + "monitorId", + "reason" + ], "type": "object", "properties": { - "affectedPolicies": { - "type": "integer", - "description": "Number of notification policies whose escalation steps were modified", - "format": "int32" + "monitorId": { + "type": "string", + "description": "Monitor ID that failed", + "format": "uuid" }, - "disabledPolicies": { - "type": "integer", - "description": "Number of notification policies disabled because they had no remaining channels", - "format": "int32" + "reason": { + "type": "string", + "description": "Human-readable reason for the failure" } }, - "description": "Summary of policies affected by channel deletion", - "required": [ - "affectedPolicies", - "disabledPolicies" - ] + "description": "Details about a single monitor that failed the bulk action" }, - "DeliveryAttemptDto": { + "GitLabChannelConfig": { "required": [ - "attemptedAt", - "deliveryId", - "id", - "status", - "attemptNumber" + "channelType", + "endpointUrl", + "authorizationKey" ], "type": "object", "properties": { - "id": { + "channelType": { "type": "string", - "format": "uuid" + "enum": [ + "gitlab" + ] }, - "deliveryId": { + "endpointUrl": { + "minLength": 1, "type": "string", - "format": "uuid" + "description": "GitLab alert integration endpoint URL" }, - "attemptNumber": { + "authorizationKey": { + "minLength": 1, + "type": "string", + "description": "Authorization key from GitLab alert integration settings" + } + } + }, + "GlobalStatusSummaryDto": { + "required": [ + "servicesWithIssues", + "totalServices", + "operationalCount", + "degradedCount", + "partialOutageCount", + "majorOutageCount", + "maintenanceCount", + "unknownCount", + "activeIncidentCount" + ], + "type": "object", + "properties": { + "totalServices": { "type": "integer", - "description": "1-based attempt number", + "description": "Total number of services in the catalog", "format": "int32" }, - "status": { - "type": "string", - "description": "Outcome: SUCCESS, FAILED, TIMEOUT, ERROR" - }, - "responseStatusCode": { + "operationalCount": { "type": "integer", - "description": "HTTP response status code from the external service", - "format": "int32", - "nullable": true + "description": "Number of services currently fully operational", + "format": "int32" }, - "requestPayload": { - "type": "string", - "description": "JSON payload sent to the external service", - "nullable": true + "degradedCount": { + "type": "integer", + "description": "Number of services with degraded status", + "format": "int32" }, - "responseBody": { - "type": "string", - "description": "Response body from the external service (truncated)", - "nullable": true + "partialOutageCount": { + "type": "integer", + "description": "Number of services with partial outage", + "format": "int32" }, - "errorMessage": { - "type": "string", - "description": "Error message if the attempt failed", - "nullable": true + "majorOutageCount": { + "type": "integer", + "description": "Number of services with major outage", + "format": "int32" }, - "responseTimeMs": { + "maintenanceCount": { "type": "integer", - "description": "Round-trip time in milliseconds", - "format": "int32", - "nullable": true + "description": "Number of services currently under maintenance", + "format": "int32" }, - "externalId": { - "type": "string", - "description": "External identifier (e.g. PagerDuty dedup_key, SES MessageId, webhook delivery UUID)", - "nullable": true + "unknownCount": { + "type": "integer", + "description": "Number of services with unknown or null status", + "format": "int32" }, - "requestHeaders": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "HTTP request headers sent to the external service", - "nullable": true - }, - "description": "HTTP request headers sent to the external service", - "nullable": true + "activeIncidentCount": { + "type": "integer", + "description": "Total number of active incidents across all services", + "format": "int64" }, - "attemptedAt": { - "type": "string", - "format": "date-time" + "servicesWithIssues": { + "type": "array", + "description": "Services that are not fully operational", + "items": { + "$ref": "#/components/schemas/ServiceCatalogDto" + } } }, - "description": "Single delivery attempt with request/response audit data" + "description": "Global status summary across all subscribed vendor services" }, - "DeployLockDto": { + "GoogleChatChannelConfig": { "required": [ - "expiresAt", - "id", - "lockedAt", - "lockedBy" + "channelType", + "webhookUrl" ], "type": "object", "properties": { - "id": { + "channelType": { "type": "string", - "description": "Unique lock identifier", - "format": "uuid" + "enum": [ + "google_chat" + ] }, - "lockedBy": { + "webhookUrl": { "minLength": 1, "type": "string", - "description": "Identity of the lock holder (e.g. CLI session ID, username)" - }, - "lockedAt": { + "description": "Google Chat space webhook URL" + } + } + }, + "GroupComponentOrder": { + "required": [ + "groupId", + "positions" + ], + "type": "object", + "properties": { + "groupId": { "type": "string", - "description": "Timestamp when the lock was acquired", - "format": "date-time" + "description": "Group these components belong to", + "format": "uuid" }, - "expiresAt": { - "type": "string", - "description": "Timestamp when the lock automatically expires", - "format": "date-time" + "positions": { + "minItems": 1, + "type": "array", + "description": "Ordered component IDs with their within-group display order", + "items": { + "$ref": "#/components/schemas/ComponentPosition" + } } }, - "description": "Represents an active deploy lock for a workspace" + "description": "Component ordering within a single group" }, - "DiscordChannelConfig": { + "HeaderAuthConfig": { "required": [ - "channelType", - "webhookUrl" + "type", + "headerName" ], "type": "object", "properties": { - "channelType": { + "type": { "type": "string", "enum": [ - "discord" + "header" ] }, - "webhookUrl": { + "headerName": { "minLength": 1, + "pattern": "^[A-Za-z0-9\\-_]+$", "type": "string", - "description": "Discord webhook URL" + "description": "Custom HTTP header name for the secret value" }, - "mentionRoleId": { + "vaultSecretId": { "type": "string", - "description": "Optional Discord role ID to mention in notifications", + "description": "Vault secret ID for the header value", + "format": "uuid", "nullable": true } } }, - "Dns": { + "HeaderValueAssertion": { + "required": [ + "type", + "headerName", + "expected", + "operator" + ], "type": "object", - "description": "DNS check-type-specific details", "properties": { - "check_type": { + "type": { "type": "string", "enum": [ - "dns" + "header_value" ] }, - "hostname": { + "headerName": { + "minLength": 1, "type": "string", - "description": "Target hostname", - "nullable": true - }, - "requestedTypes": { - "type": "array", - "description": "Requested DNS record types", - "nullable": true, - "items": { - "type": "string", - "description": "Requested DNS record types", - "nullable": true - } + "description": "HTTP header name to assert on" }, - "usedResolver": { + "expected": { + "minLength": 1, "type": "string", - "description": "Resolver used for lookup", - "nullable": true - }, - "records": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "Resolved DNS records keyed by record type", - "nullable": true, - "items": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Resolved DNS records keyed by record type", - "nullable": true - }, - "description": "Resolved DNS records keyed by record type", - "nullable": true - } - }, - "description": "Resolved DNS records keyed by record type", - "nullable": true - }, - "attempts": { - "type": "array", - "description": "DNS resolution attempts", - "nullable": true, - "items": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "DNS resolution attempts", - "nullable": true - }, - "description": "DNS resolution attempts", - "nullable": true - } + "description": "Expected value to compare against" }, - "failureKind": { + "operator": { "type": "string", - "description": "Kind of DNS failure, if any", - "nullable": true + "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", + "enum": [ + "equals", + "contains", + "less_than", + "greater_than", + "matches", + "range" + ] } - }, - "required": [ - "check_type" - ] + } }, - "DnsExpectedCnameAssertion": { + "HeartbeatIntervalDriftAssertion": { "required": [ "type", - "value" + "maxDeviationPercent" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ - "dns_expected_cname" + "heartbeat_interval_drift" ] }, - "value": { - "minLength": 1, - "type": "string", - "description": "Expected CNAME target the resolution must include" + "maxDeviationPercent": { + "maximum": 100, + "minimum": 1, + "type": "integer", + "description": "Max percent drift from expected ping interval before warning (non-fatal)", + "format": "int32" } } }, - "DnsExpectedIpsAssertion": { + "HeartbeatMaxIntervalAssertion": { "required": [ "type", - "ips" + "maxSeconds" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ - "dns_expected_ips" + "heartbeat_max_interval" ] }, - "ips": { - "minItems": 1, - "type": "array", - "description": "Allowed IP addresses; at least one resolved address must match", - "items": { - "type": "string", - "description": "Allowed IP addresses; at least one resolved address must match" - } + "maxSeconds": { + "minimum": 1, + "type": "integer", + "description": "Maximum allowed gap in seconds between consecutive heartbeat pings", + "format": "int32" } } }, - "DnsMaxAnswersAssertion": { + "HeartbeatMonitorConfig": { + "required": [ + "expectedInterval", + "gracePeriod" + ], + "type": "object", + "properties": { + "expectedInterval": { + "maximum": 86400, + "minimum": 1, + "type": "integer", + "description": "Expected heartbeat interval in seconds", + "format": "int32" + }, + "gracePeriod": { + "minimum": 1, + "type": "integer", + "description": "Grace period in seconds before marking as down", + "format": "int32" + } + } + }, + "HeartbeatPayloadContainsAssertion": { "required": [ "type", - "recordType", - "max" + "path", + "value" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ - "dns_max_answers" + "heartbeat_payload_contains" ] }, - "recordType": { + "path": { "minLength": 1, "type": "string", - "description": "DNS record type whose answer count is checked" + "description": "JSONPath expression into the heartbeat ping JSON payload" }, - "max": { - "type": "integer", - "description": "Maximum number of answers allowed for that record type", - "format": "int32" + "value": { + "type": "string", + "description": "Expected value to compare against at that path" } } }, - "DnsMinAnswersAssertion": { + "HeartbeatPingResponse": { + "required": [ + "ok" + ], + "type": "object", + "properties": { + "ok": { + "type": "boolean", + "description": "Always true on a 2xx response", + "example": true + } + }, + "description": "Acknowledgement that a heartbeat ping was accepted" + }, + "HeartbeatReceivedAssertion": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "heartbeat_received" + ] + } + }, + "required": [ + "type" + ] + }, + "Http": { + "type": "object", + "description": "HTTP check-type-specific details", + "properties": { + "check_type": { + "type": "string", + "enum": [ + "http" + ] + }, + "timing": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/TimingPhasesDto" + } + ] + }, + "bodyTruncated": { + "type": "boolean", + "description": "Whether the response body was truncated before storage", + "nullable": true + } + }, + "required": [ + "check_type" + ] + }, + "HttpMonitorConfig": { "required": [ - "type", - "recordType", - "min" + "method", + "url" ], "type": "object", "properties": { - "type": { + "url": { + "minLength": 1, + "type": "string", + "description": "Target URL to send requests to" + }, + "method": { "type": "string", + "description": "HTTP method: GET, POST, PUT, PATCH, DELETE, or HEAD", "enum": [ - "dns_min_answers" + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "HEAD" ] }, - "recordType": { - "minLength": 1, + "customHeaders": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Additional HTTP headers to include in requests", + "nullable": true + }, + "description": "Additional HTTP headers to include in requests", + "nullable": true + }, + "requestBody": { "type": "string", - "description": "DNS record type whose answer count is checked" + "description": "Request body content for POST/PUT/PATCH methods", + "nullable": true }, - "min": { - "type": "integer", - "description": "Minimum number of answers required for that record type", - "format": "int32" + "contentType": { + "type": "string", + "description": "Content-Type header value for the request body", + "nullable": true + }, + "verifyTls": { + "type": "boolean", + "description": "Whether to verify TLS certificates (default: true)", + "nullable": true } } }, - "DnsMonitorConfig": { + "Icmp": { "required": [ - "hostname" + "check_type", + "host" ], "type": "object", + "description": "ICMP (ping) check-type-specific details", "properties": { - "hostname": { - "minLength": 1, + "check_type": { "type": "string", - "description": "Domain name to resolve" - }, - "recordTypes": { - "type": "array", - "description": "DNS record types to query: A, AAAA, CNAME, MX, NS, TXT, SRV, SOA, CAA, PTR", - "nullable": true, - "items": { - "type": "string", - "description": "DNS record types to query: A, AAAA, CNAME, MX, NS, TXT, SRV, SOA, CAA, PTR", - "nullable": true, - "enum": [ - "A", - "AAAA", - "CNAME", - "MX", - "NS", - "TXT", - "SRV", - "SOA", - "CAA", - "PTR" - ] - } + "enum": [ + "icmp" + ] }, - "nameservers": { - "type": "array", - "description": "Custom nameservers to query (uses system defaults if omitted)", - "nullable": true, - "items": { - "type": "string", - "description": "Custom nameservers to query (uses system defaults if omitted)", - "nullable": true - } + "host": { + "type": "string", + "description": "Target host", + "example": "1.1.1.1" }, - "timeoutMs": { + "packetsSent": { "type": "integer", - "description": "Per-query timeout in milliseconds", + "description": "Number of ICMP packets sent", "format": "int32", "nullable": true }, - "totalTimeoutMs": { + "packetsReceived": { "type": "integer", - "description": "Total timeout for all queries in milliseconds", + "description": "Number of ICMP packets received", "format": "int32", "nullable": true + }, + "packetLoss": { + "type": "number", + "description": "Packet loss percentage", + "format": "double", + "nullable": true, + "example": 0 + }, + "avgRttMs": { + "type": "number", + "description": "Average round-trip time in ms", + "format": "double", + "nullable": true + }, + "minRttMs": { + "type": "number", + "description": "Minimum round-trip time in ms", + "format": "double", + "nullable": true + }, + "maxRttMs": { + "type": "number", + "description": "Maximum round-trip time in ms", + "format": "double", + "nullable": true + }, + "jitterMs": { + "type": "number", + "description": "Jitter in ms", + "format": "double", + "nullable": true } } }, - "DnsRecordContainsAssertion": { + "IcmpMonitorConfig": { "required": [ - "type", - "recordType", - "substring" + "host" ], "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "dns_record_contains" - ] - }, - "recordType": { + "host": { "minLength": 1, "type": "string", - "description": "DNS record type to assert on (A, AAAA, CNAME, MX, TXT)" + "description": "Target hostname or IP address to ping" }, - "substring": { - "minLength": 1, - "type": "string", - "description": "Substring that must appear in a matching record value" + "packetCount": { + "maximum": 20, + "minimum": 1, + "type": "integer", + "description": "Number of ICMP packets to send", + "format": "int32", + "nullable": true + }, + "timeoutMs": { + "type": "integer", + "description": "Ping timeout in milliseconds", + "format": "int32", + "nullable": true } } }, - "DnsRecordEqualsAssertion": { + "IcmpPacketLossAssertion": { "required": [ "type", - "recordType", - "value" + "maxPercent" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ - "dns_record_equals" + "icmp_packet_loss" ] }, - "recordType": { - "minLength": 1, - "type": "string", - "description": "DNS record type to assert on (A, AAAA, CNAME, MX, TXT)" - }, - "value": { - "minLength": 1, - "type": "string", - "description": "Expected DNS record value for an exact match" + "maxPercent": { + "maximum": 100, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false, + "type": "number", + "description": "Maximum allowed packet loss percentage before the check fails (0–100)", + "format": "double" } } }, - "DnsResolvesAssertion": { + "IcmpReachableAssertion": { "type": "object", "properties": { "type": { "type": "string", "enum": [ - "dns_resolves" + "icmp_reachable" ] } }, @@ -28905,18 +34892,18 @@ "type" ] }, - "DnsResponseTimeAssertion": { + "IcmpResponseTimeAssertion": { "type": "object", "properties": { "type": { "type": "string", "enum": [ - "dns_response_time" + "icmp_response_time" ] }, "maxMs": { "type": "integer", - "description": "Maximum allowed DNS resolution time in milliseconds", + "description": "Maximum average ICMP round-trip time in milliseconds", "format": "int32" } }, @@ -28925,18 +34912,18 @@ "maxMs" ] }, - "DnsResponseTimeWarnAssertion": { + "IcmpResponseTimeWarnAssertion": { "type": "object", "properties": { "type": { "type": "string", "enum": [ - "dns_response_time_warn" + "icmp_response_time_warn" ] }, "warnMs": { "type": "integer", - "description": "DNS resolution time in milliseconds that triggers a warning only", + "description": "ICMP round-trip time in milliseconds that triggers a warning only", "format": "int32" } }, @@ -28945,5622 +34932,6533 @@ "warnMs" ] }, - "DnsTtlHighAssertion": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "dns_ttl_high" - ] - }, - "maxTtl": { - "type": "integer", - "description": "Maximum TTL in seconds before a high-TTL warning is raised", - "format": "int32" - } - }, - "required": [ - "type", - "maxTtl" - ] - }, - "DnsTtlLowAssertion": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "dns_ttl_low" - ] - }, - "minTtl": { - "type": "integer", - "description": "Minimum acceptable TTL in seconds before a warning is raised", - "format": "int32" - } - }, - "required": [ - "type", - "minTtl" - ] - }, - "DnsTxtContainsAssertion": { + "IncidentActivityEventDto": { "required": [ - "type", - "substring" + "at", + "id", + "kind", + "summary" ], "type": "object", "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "dns_txt_contains" - ] + "description": "Stable event ID (source row ID)", + "format": "uuid" }, - "substring": { - "minLength": 1, + "at": { "type": "string", - "description": "Substring that must appear in at least one TXT record" - } - } - }, - "EmailChannelConfig": { - "required": [ - "channelType", - "recipients" - ], - "type": "object", - "properties": { - "channelType": { + "description": "When the event occurred (ISO 8601)", + "format": "date-time" + }, + "kind": { "type": "string", + "description": "Activity event kind in the merged incident activity stream", "enum": [ - "email" + "update", + "dispatch", + "delivery", + "forensic_transition", + "status_page_update" ] }, - "recipients": { - "minItems": 1, - "type": "array", - "description": "Email addresses to send notifications to", - "items": { - "type": "string", - "description": "Email addresses to send notifications to", - "format": "email" - } - } - } - }, - "EntitlementDto": { - "required": [ - "key", - "value", - "defaultValue", - "overridden" - ], - "type": "object", - "properties": { - "key": { + "actor": { "type": "string", - "description": "Entitlement key" - }, - "value": { - "type": "integer", - "description": "Effective limit value (overrides applied)", - "format": "int64" + "description": "Actor label when known (user email, system, etc.)", + "nullable": true }, - "defaultValue": { - "type": "integer", - "description": "Plan-tier default value before overrides", - "format": "int64" + "summary": { + "type": "string", + "description": "Human-readable summary of the event" }, - "overridden": { - "type": "boolean", - "description": "Whether this entitlement has an org-level override" + "payload": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/IncidentActivityPayloadDto" + } + ] } }, - "description": "A single resolved entitlement for the organization" + "description": "Merged incident activity event (updates, dispatches, deliveries, forensics, SP updates)" }, - "EnvironmentDto": { - "required": [ - "createdAt", - "id", - "name", - "slug", - "updatedAt", - "variables", - "orgId", - "monitorCount", - "isDefault" - ], + "IncidentActivityPayloadDto": { "type": "object", "properties": { - "id": { + "oldStatus": { "type": "string", - "description": "Unique environment identifier", - "format": "uuid" + "description": "Previous incident status on an update", + "nullable": true }, - "orgId": { - "type": "integer", - "description": "Organization this environment belongs to", - "format": "int32" + "newStatus": { + "type": "string", + "description": "New incident status on an update", + "nullable": true }, - "name": { - "minLength": 1, + "body": { "type": "string", - "description": "Human-readable environment name" + "description": "Update or status-page note body", + "nullable": true }, - "slug": { - "minLength": 1, + "createdBy": { "type": "string", - "description": "URL-safe identifier" + "description": "Who created the update (SYSTEM, USER, …)", + "nullable": true }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "Key-value variable pairs available for interpolation" - }, - "description": "Key-value variable pairs available for interpolation" + "phase": { + "type": "string", + "description": "Dispatch lifecycle phase (fired, acked)", + "nullable": true }, - "createdAt": { + "status": { "type": "string", - "description": "Timestamp when the environment was created", - "format": "date-time" + "description": "Dispatch, delivery, or status-page status", + "nullable": true }, - "updatedAt": { + "policyId": { "type": "string", - "description": "Timestamp when the environment was last updated", - "format": "date-time" + "description": "Notification policy id for a dispatch row", + "nullable": true }, - "monitorCount": { + "policyName": { + "type": "string", + "description": "Notification policy name when resolved", + "nullable": true + }, + "currentStep": { "type": "integer", - "description": "Number of monitors using this environment", - "format": "int32" + "description": "Current escalation step (1-based)", + "format": "int32", + "nullable": true }, - "isDefault": { - "type": "boolean", - "description": "Whether this is the default environment for new monitors" - } - }, - "description": "Environment with variable substitutions for monitor configs" - }, - "ErrorEntry": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "minLength": 1, + "dispatchId": { "type": "string", - "description": "Stable machine-readable code; see ValidationErrorCode for the registry", - "example": "MONITOR_HEARTBEAT_GRACE_EXCEEDS_INTERVAL" + "description": "Notification dispatch id", + "nullable": true }, - "field": { + "acknowledgedBy": { "type": "string", - "description": "JSON-pointer-like path to the offending field, or null for request-wide errors", - "nullable": true, - "example": "config.gracePeriod" + "description": "Who acknowledged the dispatch", + "nullable": true }, - "message": { - "minLength": 1, + "acknowledgedVia": { "type": "string", - "description": "Human-readable message; safe to surface to end users" - } - }, - "description": "One structured validation rejection" - }, - "ErrorResponse": { - "required": [ - "code", - "message", - "status", - "timestamp" - ], - "type": "object", - "properties": { - "status": { + "description": "Ack channel (UI, Slack, …)", + "nullable": true + }, + "eventType": { + "type": "string", + "description": "Alert delivery event type", + "nullable": true + }, + "stepNumber": { "type": "integer", - "description": "HTTP status code (mirrors the response status line)", + "description": "Escalation step that sent this delivery", "format": "int32", - "example": 404 + "nullable": true }, - "code": { + "fireCount": { + "type": "integer", + "description": "How many times this delivery has fired", + "format": "int32", + "nullable": true + }, + "channelId": { "type": "string", - "description": "Coarse machine-readable error category (e.g. NOT_FOUND, RATE_LIMITED); stable per status", - "example": "NOT_FOUND" + "description": "Alert channel id", + "nullable": true }, - "message": { + "channelName": { "type": "string", - "description": "Human-readable error message; safe to surface to end users", - "example": "Monitor not found" + "description": "Alert channel name", + "nullable": true }, - "timestamp": { - "type": "integer", - "description": "Server time when the error was produced (epoch milliseconds)", - "format": "int64", - "example": 1737302400000 + "channelType": { + "type": "string", + "description": "Alert channel type", + "nullable": true + }, + "errorMessage": { + "type": "string", + "description": "Delivery error message when the send failed", + "nullable": true + }, + "fromStatus": { + "type": "string", + "description": "Forensic from-status", + "nullable": true }, - "requestId": { + "toStatus": { "type": "string", - "description": "Opaque per-request id; same value as the X-Request-Id response header. Use in support tickets.", - "nullable": true, - "example": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a" + "description": "Forensic to-status", + "nullable": true }, - "errors": { + "reason": { + "type": "string", + "description": "Forensic transition reason", + "nullable": true + }, + "affectedRegions": { "type": "array", - "description": "Structured per-field rejections; populated for validation errors, null otherwise", + "description": "Regions named on the forensic transition", "nullable": true, "items": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/ErrorEntry" - } - ] - } - } - }, - "description": "Uniform error envelope returned for every non-2xx response", - "example": { - "status": 404, - "code": "NOT_FOUND", - "message": "Monitor not found", - "timestamp": 1737302400000, - "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a" - } - }, - "EscalationChain": { - "required": [ - "steps" - ], - "type": "object", - "properties": { - "steps": { - "minItems": 1, - "type": "array", - "description": "Ordered escalation steps, evaluated in sequence", - "items": { - "$ref": "#/components/schemas/EscalationStep" + "type": "string", + "description": "Regions named on the forensic transition" } }, - "onResolve": { - "type": "string", - "description": "Action when the incident resolves", - "nullable": true - }, - "onReopen": { + "statusPageIncidentId": { "type": "string", - "description": "Action when a resolved incident reopens", + "description": "Linked status-page incident id", "nullable": true } }, - "description": "Escalation chain defining which channels to notify; null preserves current" + "description": "Kind-specific activity fields; omitted keys are absent, not null" }, - "EscalationStep": { + "IncidentDetailDto": { "required": [ - "channelIds", - "delayMinutes" + "incident", + "updates" ], "type": "object", "properties": { - "delayMinutes": { - "minimum": 0, - "type": "integer", - "description": "Minutes to wait before executing this step (0 = immediate)", - "format": "int32" + "incident": { + "$ref": "#/components/schemas/IncidentDto" }, - "channelIds": { - "minItems": 1, + "updates": { "type": "array", - "description": "Alert channel IDs to notify in this step", "items": { - "type": "string", - "description": "Alert channel IDs to notify in this step", - "format": "uuid" + "$ref": "#/components/schemas/IncidentUpdateDto" } }, - "requireAck": { - "type": "boolean", - "description": "Whether an acknowledgment is required before escalating", - "nullable": true + "statusPageIncidents": { + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/LinkedStatusPageIncidentDto" + } }, - "repeatIntervalSeconds": { - "minimum": 1, - "type": "integer", - "description": "Repeat notification interval in seconds until acknowledged", - "format": "int32", - "nullable": true + "trigger": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/IncidentTriggerDto" + } + ] } - }, - "description": "Ordered escalation steps, evaluated in sequence" + } }, - "FailureDetail": { + "IncidentDto": { "required": [ - "monitorId", - "reason" + "affectedRegions", + "createdAt", + "id", + "severity", + "source", + "status", + "updatedAt", + "organizationId", + "reopenCount", + "statusPageVisible", + "suppressDispatch" ], "type": "object", "properties": { - "monitorId": { + "id": { "type": "string", - "description": "Monitor ID that failed", + "description": "Unique incident identifier", "format": "uuid" }, - "reason": { + "monitorId": { "type": "string", - "description": "Human-readable reason for the failure" - } - }, - "description": "Details about a single monitor that failed the bulk action" - }, - "GitLabChannelConfig": { - "required": [ - "channelType", - "endpointUrl", - "authorizationKey" - ], - "type": "object", - "properties": { - "channelType": { + "description": "Monitor that triggered the incident; null for service or manual incidents", + "format": "uuid", + "nullable": true + }, + "organizationId": { + "type": "integer", + "description": "Organization this incident belongs to", + "format": "int32" + }, + "source": { "type": "string", + "description": "Incident origin: MONITOR, SERVICE, or MANUAL", "enum": [ - "gitlab" + "AUTOMATIC", + "MANUAL", + "MONITORS", + "STATUS_DATA", + "RESOURCE_GROUP" ] }, - "endpointUrl": { - "minLength": 1, + "status": { "type": "string", - "description": "GitLab alert integration endpoint URL" + "description": "Current lifecycle status (OPEN, RESOLVED, etc.)", + "enum": [ + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" + ] }, - "authorizationKey": { - "minLength": 1, + "severity": { "type": "string", - "description": "Authorization key from GitLab alert integration settings" - } - } - }, - "GlobalStatusSummaryDto": { - "required": [ - "servicesWithIssues", - "totalServices", - "operationalCount", - "degradedCount", - "partialOutageCount", - "majorOutageCount", - "maintenanceCount", - "unknownCount", - "activeIncidentCount" - ], - "type": "object", - "properties": { - "totalServices": { - "type": "integer", - "description": "Total number of services in the catalog", - "format": "int32" + "description": "Severity level: DOWN, DEGRADED, or MAINTENANCE", + "enum": [ + "DOWN", + "DEGRADED", + "MAINTENANCE" + ] }, - "operationalCount": { - "type": "integer", - "description": "Number of services currently fully operational", - "format": "int32" + "title": { + "type": "string", + "description": "Short summary of the incident; null for auto-generated incidents", + "nullable": true }, - "degradedCount": { - "type": "integer", - "description": "Number of services with degraded status", - "format": "int32" + "triggeredByRule": { + "type": "string", + "description": "Human-readable description of the trigger rule that fired", + "nullable": true }, - "partialOutageCount": { - "type": "integer", - "description": "Number of services with partial outage", - "format": "int32" + "affectedRegions": { + "type": "array", + "description": "Probe regions that observed the failure", + "items": { + "type": "string", + "description": "Probe regions that observed the failure" + } }, - "majorOutageCount": { + "reopenCount": { "type": "integer", - "description": "Number of services with major outage", + "description": "Number of times this incident has been reopened", "format": "int32" }, - "maintenanceCount": { + "createdByUserId": { "type": "integer", - "description": "Number of services currently under maintenance", - "format": "int32" + "description": "User who created the incident (manual incidents only)", + "format": "int32", + "nullable": true }, - "unknownCount": { - "type": "integer", - "description": "Number of services with unknown or null status", - "format": "int32" + "statusPageVisible": { + "type": "boolean", + "description": "Whether this incident is visible on the status page" }, - "activeIncidentCount": { - "type": "integer", - "description": "Total number of active incidents across all services", - "format": "int64" + "suppressDispatch": { + "type": "boolean", + "description": "When true, alert channels are suppressed (AWARENESS silent tracking); false means Alerted" }, - "servicesWithIssues": { - "type": "array", - "description": "Services that are not fully operational", - "items": { - "$ref": "#/components/schemas/ServiceCatalogDto" - } - } - }, - "description": "Global status summary across all subscribed vendor services" - }, - "GoogleChatChannelConfig": { - "required": [ - "channelType", - "webhookUrl" - ], - "type": "object", - "properties": { - "channelType": { + "serviceIncidentId": { "type": "string", - "enum": [ - "google_chat" - ] + "description": "Linked vendor service incident ID; null for monitor incidents", + "format": "uuid", + "nullable": true }, - "webhookUrl": { - "minLength": 1, + "serviceId": { "type": "string", - "description": "Google Chat space webhook URL" - } - } - }, - "GroupComponentOrder": { - "required": [ - "groupId", - "positions" - ], - "type": "object", - "properties": { - "groupId": { + "description": "Linked service catalog ID; null for monitor incidents", + "format": "uuid", + "nullable": true + }, + "externalRef": { "type": "string", - "description": "Group these components belong to", - "format": "uuid" + "description": "External reference ID (e.g. PagerDuty incident ID)", + "nullable": true }, - "positions": { - "minItems": 1, + "affectedComponents": { "type": "array", - "description": "Ordered component IDs with their within-group display order", + "description": "Service components affected by this incident", + "nullable": true, "items": { - "$ref": "#/components/schemas/ComponentPosition" + "type": "string", + "description": "Service components affected by this incident" } - } - }, - "description": "Component ordering within a single group" - }, - "HeaderAuthConfig": { - "required": [ - "type", - "headerName" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "header" - ] - }, - "headerName": { - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-_]+$", - "type": "string", - "description": "Custom HTTP header name for the secret value" }, - "vaultSecretId": { + "shortlink": { "type": "string", - "description": "Vault secret ID for the header value", - "format": "uuid", + "description": "Short URL linking to the incident details", "nullable": true - } - } - }, - "HeaderValueAssertion": { - "required": [ - "type", - "headerName", - "expected", - "operator" - ], - "type": "object", - "properties": { - "type": { + }, + "resolutionReason": { "type": "string", + "description": "How the incident was resolved (AUTO_RECOVERED, MANUAL, etc.)", + "nullable": true, "enum": [ - "header_value" + "MANUAL", + "AUTO_RECOVERED", + "AUTO_RESOLVED" ] }, - "headerName": { - "minLength": 1, + "resolutionNote": { "type": "string", - "description": "HTTP header name to assert on" + "description": "Body from the most recent resolve update; null when not currently resolved, auto-resolved without a note, or no resolve update body was provided", + "nullable": true }, - "expected": { - "minLength": 1, + "startedAt": { "type": "string", - "description": "Expected value to compare against" + "description": "Timestamp when the incident was detected or created", + "format": "date-time", + "nullable": true }, - "operator": { + "confirmedAt": { "type": "string", - "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", - "enum": [ - "equals", - "contains", - "less_than", - "greater_than", - "matches", - "range" - ] - } - } - }, - "HeartbeatIntervalDriftAssertion": { - "required": [ - "type", - "maxDeviationPercent" - ], - "type": "object", - "properties": { - "type": { + "description": "Timestamp when the incident was confirmed (multi-region confirmation)", + "format": "date-time", + "nullable": true + }, + "resolvedAt": { "type": "string", - "enum": [ - "heartbeat_interval_drift" - ] + "description": "Timestamp when the incident was resolved", + "format": "date-time", + "nullable": true }, - "maxDeviationPercent": { - "maximum": 100, - "minimum": 1, - "type": "integer", - "description": "Max percent drift from expected ping interval before warning (non-fatal)", - "format": "int32" - } - } - }, - "HeartbeatMaxIntervalAssertion": { - "required": [ - "type", - "maxSeconds" - ], - "type": "object", - "properties": { - "type": { + "cooldownUntil": { "type": "string", - "enum": [ - "heartbeat_max_interval" - ] + "description": "Cooldown window end; new incidents suppressed until this time", + "format": "date-time", + "nullable": true }, - "maxSeconds": { - "minimum": 1, - "type": "integer", - "description": "Maximum allowed gap in seconds between consecutive heartbeat pings", - "format": "int32" - } - } - }, - "HeartbeatMonitorConfig": { - "required": [ - "expectedInterval", - "gracePeriod" - ], - "type": "object", - "properties": { - "expectedInterval": { - "maximum": 86400, - "minimum": 1, - "type": "integer", - "description": "Expected heartbeat interval in seconds", - "format": "int32" + "createdAt": { + "type": "string", + "description": "Timestamp when the incident record was created", + "format": "date-time" }, - "gracePeriod": { - "minimum": 1, - "type": "integer", - "description": "Grace period in seconds before marking as down", - "format": "int32" - } - } - }, - "HeartbeatPayloadContainsAssertion": { - "required": [ - "type", - "path", - "value" - ], - "type": "object", - "properties": { - "type": { + "updatedAt": { "type": "string", - "enum": [ - "heartbeat_payload_contains" - ] + "description": "Timestamp when the incident was last updated", + "format": "date-time" }, - "path": { - "minLength": 1, + "monitorName": { "type": "string", - "description": "JSONPath expression into the heartbeat ping JSON payload" + "description": "Name of the associated monitor; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", + "nullable": true }, - "value": { + "serviceName": { "type": "string", - "description": "Expected value to compare against at that path" - } - } - }, - "HeartbeatPingResponse": { - "required": [ - "ok" - ], - "type": "object", - "properties": { - "ok": { - "type": "boolean", - "description": "Always true on a 2xx response", - "example": true - } - }, - "description": "Acknowledgement that a heartbeat ping was accepted" - }, - "HeartbeatReceivedAssertion": { - "type": "object", - "properties": { - "type": { + "description": "Name of the associated service; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", + "nullable": true + }, + "serviceSlug": { "type": "string", - "enum": [ - "heartbeat_received" - ] - } - }, - "required": [ - "type" - ] - }, - "Http": { - "type": "object", - "description": "HTTP check-type-specific details", - "properties": { - "check_type": { + "description": "Slug of the associated service; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", + "nullable": true + }, + "monitorType": { "type": "string", - "enum": [ - "http" - ] + "description": "Type of the associated monitor; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", + "nullable": true }, - "timing": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/TimingPhasesDto" - } - ] + "resourceGroupId": { + "type": "string", + "description": "Resource group that owns this incident; null when not group-managed", + "format": "uuid", + "nullable": true }, - "bodyTruncated": { - "type": "boolean", - "description": "Whether the response body was truncated before storage", + "resourceGroupName": { + "type": "string", + "description": "Name of the resource group; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", "nullable": true - } - }, - "required": [ - "check_type" - ] - }, - "HttpMonitorConfig": { - "required": [ - "method", - "url" - ], - "type": "object", - "properties": { - "url": { - "minLength": 1, + }, + "triggeringCheckId": { "type": "string", - "description": "Target URL to send requests to" + "description": "Scheduler-minted check execution ID whose result confirmed this incident; joins to check_results, rule_evaluations, and incident_state_transitions. Omitted from JSON (undefined to SDKs) when null, treat missing as null.", + "format": "uuid", + "nullable": true }, - "method": { + "triggeredByRuleSnapshotHashHex": { "type": "string", - "description": "HTTP method: GET, POST, PUT, PATCH, DELETE, or HEAD", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "HEAD" - ] + "description": "Hex SHA-256 of the canonical policy snapshot that fired; combined with triggeredByRuleIndex points to the exact TriggerRule. Omitted from JSON when null, treat missing as null.", + "nullable": true }, - "customHeaders": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "Additional HTTP headers to include in requests", - "nullable": true - }, - "description": "Additional HTTP headers to include in requests", + "triggeredByRuleIndex": { + "type": "integer", + "description": "Index of the fired rule inside the policy's trigger_rules array. Omitted from JSON when null, treat missing as null.", + "format": "int32", "nullable": true }, - "requestBody": { + "engineVersion": { "type": "string", - "description": "Request body content for POST/PUT/PATCH methods", + "description": "Detection engine semver that evaluated the rule. Omitted from JSON when null, treat missing as null.", "nullable": true }, - "contentType": { + "displayKey": { "type": "string", - "description": "Content-Type header value for the request body", + "description": "Org-scoped human-readable incident code, e.g. \"ABC-42\". Null on incidents created by pre-INC-keys API pods before the sweep; treat missing as unknown and fall back to the id", "nullable": true }, - "verifyTls": { - "type": "boolean", - "description": "Whether to verify TLS certificates (default: true)", + "alertCollapsedByResourceGroupIds": { + "type": "array", + "description": "Sticky union of resource-group IDs that suppressed a paging dispatch for this member incident; null when never written / legacy", + "nullable": true, + "items": { + "type": "string", + "description": "Sticky union of resource-group IDs that suppressed a paging dispatch for this member incident; null when never written / legacy", + "format": "uuid" + } + }, + "peakFailingMemberCount": { + "type": "integer", + "description": "Peak non-operational member count while this RESOURCE_GROUP incident was open; null otherwise", + "format": "int32", "nullable": true + }, + "failingMembersAtPeak": { + "type": "array", + "description": "Frozen failing members at peakFailingMemberCount; null when not a group incident or never snapshotted", + "nullable": true, + "items": { + "$ref": "#/components/schemas/IncidentFailingMemberSnapshotDto" + } } - } + }, + "description": "Incident triggered by a monitor check failure or manual creation" }, - "Icmp": { + "IncidentEventDto": { "required": [ - "check_type", - "host" + "incidentId", + "title" ], "type": "object", - "description": "ICMP (ping) check-type-specific details", "properties": { - "check_type": { + "incidentId": { "type": "string", - "enum": [ - "icmp" - ] + "description": "Vendor catalog incident ID", + "format": "uuid" }, - "host": { + "externalId": { "type": "string", - "description": "Target host", - "example": "1.1.1.1" + "description": "Vendor-supplied external incident ID", + "nullable": true }, - "packetsSent": { - "type": "integer", - "description": "Number of ICMP packets sent", - "format": "int32", + "title": { + "type": "string", + "description": "Incident title from the vendor status page" + }, + "impact": { + "type": "string", + "description": "Vendor impact level (major, minor, none)", "nullable": true }, - "packetsReceived": { - "type": "integer", - "description": "Number of ICMP packets received", - "format": "int32", + "status": { + "type": "string", + "description": "Vendor lifecycle status (only set on incident.update rows)", "nullable": true }, - "packetLoss": { - "type": "number", - "description": "Packet loss percentage", - "format": "double", - "nullable": true, - "example": 0 + "body": { + "type": "string", + "description": "Update body text (only set on incident.update rows)", + "nullable": true }, - "avgRttMs": { - "type": "number", - "description": "Average round-trip time in ms", - "format": "double", + "shortlink": { + "type": "string", + "description": "Short public URL for the vendor incident", "nullable": true }, - "minRttMs": { - "type": "number", - "description": "Minimum round-trip time in ms", - "format": "double", + "startedAt": { + "type": "string", + "description": "When the vendor incident started", + "format": "date-time", "nullable": true }, - "maxRttMs": { - "type": "number", - "description": "Maximum round-trip time in ms", - "format": "double", + "resolvedAt": { + "type": "string", + "description": "When the vendor incident resolved", + "format": "date-time", "nullable": true }, - "jitterMs": { - "type": "number", - "description": "Jitter in ms", - "format": "double", + "detectedAt": { + "type": "string", + "description": "When DevHelm first detected the incident", + "format": "date-time", + "nullable": true + }, + "vendorCreatedAt": { + "type": "string", + "description": "Vendor-reported creation timestamp", + "format": "date-time", + "nullable": true + }, + "durationSeconds": { + "type": "integer", + "description": "Total duration in seconds (set on incident.resolved)", + "format": "int64", "nullable": true + }, + "affectedComponentIds": { + "type": "array", + "description": "Affected component IDs from the vendor incident join", + "nullable": true, + "items": { + "type": "string", + "description": "Affected component IDs from the vendor incident join", + "format": "uuid" + } } - } + }, + "description": "Vendor incident fields for a status-events rail row" }, - "IcmpMonitorConfig": { + "IncidentFailingMemberSnapshotDto": { "required": [ - "host" + "memberType", + "name" ], "type": "object", "properties": { - "host": { - "minLength": 1, + "memberType": { "type": "string", - "description": "Target hostname or IP address to ping" + "description": "Member type: monitor or service" }, - "packetCount": { - "maximum": 20, - "minimum": 1, - "type": "integer", - "description": "Number of ICMP packets to send", - "format": "int32", + "monitorId": { + "type": "string", + "description": "Monitor ID when memberType is monitor", + "format": "uuid", "nullable": true }, - "timeoutMs": { - "type": "integer", - "description": "Ping timeout in milliseconds", - "format": "int32", + "serviceId": { + "type": "string", + "description": "Service ID when memberType is service", + "format": "uuid", "nullable": true - } - } - }, - "IcmpPacketLossAssertion": { - "type": "object", - "properties": { - "type": { + }, + "name": { + "minLength": 1, "type": "string", - "enum": [ - "icmp_packet_loss" - ] + "description": "Frozen display name at snapshot time" }, - "maxPercent": { - "maximum": 100, - "exclusiveMaximum": false, - "minimum": 0, - "exclusiveMinimum": false, - "type": "number", - "description": "Maximum allowed packet loss percentage before the check fails (0–100)", - "format": "double" + "membershipId": { + "type": "string", + "description": "Membership row ID when available", + "format": "uuid", + "nullable": true } }, - "required": [ - "type", - "maxPercent" - ] + "description": "Frozen failing member identity at peak failing count for a resource-group incident" }, - "IcmpReachableAssertion": { + "IncidentFilterParams": { "type": "object", "properties": { - "type": { + "status": { "type": "string", + "description": "Filter by incident lifecycle status; null returns every status", + "nullable": true, "enum": [ - "icmp_reachable" + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" ] - } - }, - "required": [ - "type" - ] - }, - "IcmpResponseTimeAssertion": { - "type": "object", - "properties": { - "type": { + }, + "severity": { "type": "string", + "description": "Filter by severity; null returns every severity", + "nullable": true, "enum": [ - "icmp_response_time" + "DOWN", + "DEGRADED", + "MAINTENANCE" ] }, - "maxMs": { - "type": "integer", - "description": "Maximum average ICMP round-trip time in milliseconds", - "format": "int32" - } - }, - "required": [ - "type", - "maxMs" - ] - }, - "IcmpResponseTimeWarnAssertion": { - "type": "object", - "properties": { - "type": { + "source": { "type": "string", + "description": "Filter by where the incident originated (auto, manual, third-party)", + "nullable": true, "enum": [ - "icmp_response_time_warn" + "AUTOMATIC", + "MANUAL", + "MONITORS", + "STATUS_DATA", + "RESOURCE_GROUP" ] }, - "warnMs": { - "type": "integer", - "description": "ICMP round-trip time in milliseconds that triggers a warning only", - "format": "int32" - } - }, - "required": [ - "type", - "warnMs" - ] - }, - "IncidentActivityEventDto": { - "required": [ - "at", - "id", - "kind", - "summary" - ], - "type": "object", - "properties": { - "id": { + "monitorId": { "type": "string", - "description": "Stable event ID (source row ID)", - "format": "uuid" + "description": "Only return incidents tied to this monitor ID", + "format": "uuid", + "nullable": true }, - "at": { + "serviceId": { "type": "string", - "description": "When the event occurred (ISO 8601)", - "format": "date-time" + "description": "Only return incidents tied to this service ID (third-party services)", + "format": "uuid", + "nullable": true }, - "kind": { + "resourceGroupId": { "type": "string", - "description": "Activity event kind in the merged incident activity stream", - "enum": [ - "update", - "dispatch", - "delivery", - "forensic_transition", - "status_page_update" - ] + "description": "Only return incidents owned by this resource group (incidents.resource_group_id)", + "format": "uuid", + "nullable": true }, - "actor": { + "tagId": { "type": "string", - "description": "Actor label when known (user email, system, etc.)", + "description": "Only return incidents whose monitor carries this tag", + "format": "uuid", "nullable": true }, - "summary": { + "environmentId": { "type": "string", - "description": "Human-readable summary of the event" + "description": "Only return incidents whose monitor lives in this environment", + "format": "uuid", + "nullable": true }, - "payload": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/IncidentActivityPayloadDto" - } - ] + "excludeId": { + "type": "string", + "description": "Exclude this incident ID from results (related-incident lists)", + "format": "uuid", + "nullable": true + }, + "startedFrom": { + "type": "string", + "description": "Earliest startedAt to include (inclusive, ISO 8601)", + "format": "date-time", + "nullable": true + }, + "startedTo": { + "type": "string", + "description": "Latest startedAt to include (inclusive, ISO 8601)", + "format": "date-time", + "nullable": true + }, + "page": { + "minimum": 0, + "type": "integer", + "description": "Zero-based page index (default: 0)", + "format": "int32", + "example": 0 + }, + "size": { + "maximum": 200, + "minimum": 1, + "type": "integer", + "description": "Number of incidents per page (1–200, default: 10)", + "format": "int32", + "example": 10 } }, - "description": "Merged incident activity event (updates, dispatches, deliveries, forensics, SP updates)" + "required": [ + "page", + "size" + ] }, - "IncidentActivityPayloadDto": { + "IncidentIoChannelConfig": { + "required": [ + "channelType", + "apiKey" + ], "type": "object", "properties": { - "oldStatus": { + "channelType": { "type": "string", - "description": "Previous incident status on an update", - "nullable": true + "enum": [ + "incident_io" + ] }, - "newStatus": { + "apiKey": { + "minLength": 1, "type": "string", - "description": "New incident status on an update", - "nullable": true + "description": "incident.io API key with 'Create incidents' permission" }, - "body": { + "severityId": { "type": "string", - "description": "Update or status-page note body", + "description": "Severity ID for created incidents (from List Severities API)", "nullable": true }, - "createdBy": { + "visibility": { "type": "string", - "description": "Who created the update (SYSTEM, USER, …)", + "description": "Incident visibility: public or private (default: public)", "nullable": true - }, - "phase": { + } + } + }, + "IncidentPolicyDto": { + "required": [ + "confirmation", + "createdAt", + "id", + "monitorId", + "recovery", + "triggerRules", + "updatedAt" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "Dispatch lifecycle phase (fired, acked)", - "nullable": true + "description": "Unique incident policy identifier", + "format": "uuid" }, - "status": { + "monitorId": { "type": "string", - "description": "Dispatch, delivery, or status-page status", - "nullable": true + "description": "Monitor this policy is attached to", + "format": "uuid" }, - "policyId": { + "triggerRules": { + "type": "array", + "description": "Array of trigger rules defining when an incident should be raised", + "items": { + "$ref": "#/components/schemas/TriggerRule" + } + }, + "confirmation": { + "$ref": "#/components/schemas/ConfirmationPolicy" + }, + "recovery": { + "$ref": "#/components/schemas/RecoveryPolicy" + }, + "createdAt": { "type": "string", - "description": "Notification policy id for a dispatch row", - "nullable": true + "description": "Timestamp when the policy was created", + "format": "date-time" }, - "policyName": { + "updatedAt": { "type": "string", - "description": "Notification policy name when resolved", - "nullable": true + "description": "Timestamp when the policy was last updated", + "format": "date-time" }, - "currentStep": { + "monitorRegionCount": { "type": "integer", - "description": "Current escalation step (1-based)", + "description": "Number of regions configured on the monitor (only set in internal API responses)", "format": "int32", "nullable": true }, - "dispatchId": { - "type": "string", - "description": "Notification dispatch id", + "checkFrequencySeconds": { + "type": "integer", + "description": "Monitor check frequency in seconds (only set in internal API responses)", + "format": "int32", "nullable": true - }, - "acknowledgedBy": { + } + }, + "description": "Incident detection, confirmation, and recovery policy for a monitor" + }, + "IncidentRef": { + "required": [ + "id", + "impact", + "title" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "Who acknowledged the dispatch", - "nullable": true + "description": "Internal incident ID — UUID for status-page incidents, service incident UUID for catalog", + "format": "uuid" }, - "acknowledgedVia": { + "title": { "type": "string", - "description": "Ack channel (UI, Slack, …)", - "nullable": true + "description": "Incident title at the time of the overlap" }, - "eventType": { + "impact": { "type": "string", - "description": "Alert delivery event type", - "nullable": true - }, - "stepNumber": { + "description": "Incident impact level (e.g. minor, major, critical for catalog; NONE/MINOR/MAJOR/CRITICAL for status pages)" + } + }, + "description": "Lightweight reference to an incident overlapping a given uptime day" + }, + "IncidentsSummaryDto": { + "type": "object", + "properties": { + "active": { "type": "integer", - "description": "Escalation step that sent this delivery", - "format": "int32", - "nullable": true + "format": "int64" }, - "fireCount": { + "resolvedToday": { "type": "integer", - "description": "How many times this delivery has fired", - "format": "int32", - "nullable": true + "format": "int64" }, - "channelId": { - "type": "string", - "description": "Alert channel id", + "mttr30d": { + "type": "number", + "format": "double", "nullable": true + } + }, + "description": "Incident summary counters", + "required": [ + "active", + "resolvedToday" + ] + }, + "IncidentStateTransitionDto": { + "required": [ + "affectedRegions", + "checkId", + "details", + "engineVersion", + "fromStatus", + "id", + "monitorId", + "occurredAt", + "policySnapshotHashHex", + "reason", + "toStatus", + "triggeringEvaluationIds" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Forensic row UUID", + "format": "uuid" }, - "channelName": { + "occurredAt": { "type": "string", - "description": "Alert channel name", - "nullable": true + "description": "When the state transition occurred", + "format": "date-time" }, - "channelType": { + "monitorId": { "type": "string", - "description": "Alert channel type", - "nullable": true + "description": "Monitor this transition pertains to", + "format": "uuid" }, - "errorMessage": { + "incidentId": { "type": "string", - "description": "Delivery error message when the send failed", + "description": "Incident this transition belongs to; null for pre-incident (auto-cleared) transitions", + "format": "uuid", "nullable": true }, "fromStatus": { + "minLength": 1, "type": "string", - "description": "Forensic from-status", - "nullable": true + "description": "Previous status (WATCHING | TRIGGERED | CONFIRMED | RESOLVED)" }, "toStatus": { + "minLength": 1, "type": "string", - "description": "Forensic to-status", - "nullable": true + "description": "New status (WATCHING | TRIGGERED | CONFIRMED | RESOLVED)" }, "reason": { + "minLength": 1, "type": "string", - "description": "Forensic transition reason", - "nullable": true + "description": "Why the transition fired (trigger | confirm | resolve | auto_clear | reopen)" + }, + "triggeringEvaluationIds": { + "type": "array", + "description": "rule_evaluation ids that caused this transition (may be empty for timeout-driven edges)", + "items": { + "type": "string", + "description": "rule_evaluation ids that caused this transition (may be empty for timeout-driven edges)", + "format": "uuid" + } }, "affectedRegions": { "type": "array", - "description": "Regions named on the forensic transition", - "nullable": true, + "description": "Regions whose evaluations contributed to this transition", "items": { "type": "string", - "description": "Regions named on the forensic transition" + "description": "Regions whose evaluations contributed to this transition" } }, - "statusPageIncidentId": { + "policySnapshotHashHex": { + "minLength": 1, "type": "string", - "description": "Linked status-page incident id", - "nullable": true + "description": "Hex-encoded hash of the policy snapshot that governed this transition" + }, + "engineVersion": { + "minLength": 1, + "type": "string", + "description": "Detection engine version that emitted this transition" + }, + "checkId": { + "type": "string", + "description": "Scheduler-minted check execution ID (V92) of the triggering result", + "format": "uuid" + }, + "details": { + "$ref": "#/components/schemas/StateTransitionDetails" } }, - "description": "Kind-specific activity fields; omitted keys are absent, not null" + "description": "State-machine transitions this check caused (may be empty if nothing fired)" }, - "IncidentDetailDto": { + "IncidentTimelineDto": { "required": [ - "incident", - "updates" + "transitions", + "triggeringEvaluations" ], "type": "object", "properties": { - "incident": { - "$ref": "#/components/schemas/IncidentDto" - }, - "updates": { + "transitions": { "type": "array", + "description": "State-machine transitions in chronological order", "items": { - "$ref": "#/components/schemas/IncidentUpdateDto" + "$ref": "#/components/schemas/IncidentStateTransitionDto" } }, - "statusPageIncidents": { + "triggeringEvaluations": { "type": "array", - "nullable": true, + "description": "Rule evaluations that caused any of the transitions above. Correlate via evaluation.triggeringTransitionId == transition.id", "items": { - "$ref": "#/components/schemas/LinkedStatusPageIncidentDto" + "$ref": "#/components/schemas/RuleEvaluationDto" } }, - "trigger": { + "policySnapshot": { "nullable": true, "allOf": [ { - "$ref": "#/components/schemas/IncidentTriggerDto" + "$ref": "#/components/schemas/PolicySnapshotDto" } ] } } }, - "IncidentDto": { + "IncidentTriggerDto": { "required": [ - "affectedRegions", - "createdAt", - "id", - "severity", - "source", - "status", - "updatedAt", - "organizationId", - "reopenCount", - "statusPageVisible", - "suppressDispatch" + "source" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "Unique incident identifier", - "format": "uuid" - }, - "monitorId": { + "ruleType": { "type": "string", - "description": "Monitor that triggered the incident; null for service or manual incidents", - "format": "uuid", + "description": "Trigger rule type (consecutive_failures, failures_in_window, response_time); null when unknown", "nullable": true }, - "organizationId": { + "ruleIndex": { "type": "integer", - "description": "Organization this incident belongs to", - "format": "int32" - }, - "source": { - "type": "string", - "description": "Incident origin: MONITOR, SERVICE, or MANUAL", - "enum": [ - "AUTOMATIC", - "MANUAL", - "MONITORS", - "STATUS_DATA", - "RESOURCE_GROUP" - ] - }, - "status": { - "type": "string", - "description": "Current lifecycle status (OPEN, RESOLVED, etc.)", - "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" - ] - }, - "severity": { - "type": "string", - "description": "Severity level: DOWN, DEGRADED, or MAINTENANCE", - "enum": [ - "DOWN", - "DEGRADED", - "MAINTENANCE" - ] - }, - "title": { - "type": "string", - "description": "Short summary of the incident; null for auto-generated incidents", - "nullable": true - }, - "triggeredByRule": { - "type": "string", - "description": "Human-readable description of the trigger rule that fired", + "description": "0-based index into the policy trigger_rules array; null when unknown", + "format": "int32", "nullable": true }, - "affectedRegions": { - "type": "array", - "description": "Probe regions that observed the failure", - "items": { - "type": "string", - "description": "Probe regions that observed the failure" - } - }, - "reopenCount": { + "count": { "type": "integer", - "description": "Number of times this incident has been reopened", - "format": "int32" + "description": "Observed failing_streak or failures_in_window from forensics; null when unavailable", + "format": "int32", + "nullable": true }, - "createdByUserId": { + "threshold": { "type": "integer", - "description": "User who created the incident (manual incidents only)", + "description": "Rule required count or threshold_ms from forensics; null when unavailable", "format": "int32", "nullable": true }, - "statusPageVisible": { - "type": "boolean", - "description": "Whether this incident is visible on the status page" - }, - "suppressDispatch": { - "type": "boolean", - "description": "When true, alert channels are suppressed (AWARENESS silent tracking); false means Alerted" - }, - "serviceIncidentId": { + "lastError": { "type": "string", - "description": "Linked vendor service incident ID; null for monitor incidents", - "format": "uuid", + "description": "failure_reason from the triggering check result; null when unavailable", "nullable": true }, - "serviceId": { + "firstFailedCheckAt": { "type": "string", - "description": "Linked service catalog ID; null for monitor incidents", - "format": "uuid", + "description": "Earliest failing check timestamp in the confirm window when computable; null otherwise", + "format": "date-time", "nullable": true }, - "externalRef": { + "source": { + "minLength": 1, "type": "string", - "description": "External reference ID (e.g. PagerDuty incident ID)", - "nullable": true - }, - "affectedComponents": { - "type": "array", - "description": "Service components affected by this incident", - "nullable": true, - "items": { - "type": "string", - "description": "Service components affected by this incident" - } + "description": "Where the enrichment came from: forensics, checks, or none (STATUS_DATA/manual/no data)", + "enum": [ + "forensics", + "checks", + "none" + ] + } + }, + "description": "Honest trigger metadata for the incident origin tooltip / TTD strip" + }, + "IncidentUpdateDto": { + "required": [ + "createdAt", + "id", + "incidentId", + "notifySubscribers" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" }, - "shortlink": { + "incidentId": { "type": "string", - "description": "Short URL linking to the incident details", - "nullable": true + "format": "uuid" }, - "resolutionReason": { + "oldStatus": { "type": "string", - "description": "How the incident was resolved (AUTO_RECOVERED, MANUAL, etc.)", "nullable": true, "enum": [ - "MANUAL", - "AUTO_RECOVERED", - "AUTO_RESOLVED" + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" ] }, - "resolutionNote": { - "type": "string", - "description": "Body from the most recent resolve update; null when not currently resolved, auto-resolved without a note, or no resolve update body was provided", - "nullable": true - }, - "startedAt": { + "newStatus": { "type": "string", - "description": "Timestamp when the incident was detected or created", - "format": "date-time", - "nullable": true + "nullable": true, + "enum": [ + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" + ] }, - "confirmedAt": { + "body": { "type": "string", - "description": "Timestamp when the incident was confirmed (multi-region confirmation)", - "format": "date-time", "nullable": true }, - "resolvedAt": { + "createdBy": { "type": "string", - "description": "Timestamp when the incident was resolved", - "format": "date-time", - "nullable": true + "nullable": true, + "enum": [ + "SYSTEM", + "USER" + ] }, - "cooldownUntil": { - "type": "string", - "description": "Cooldown window end; new incidents suppressed until this time", - "format": "date-time", - "nullable": true + "notifySubscribers": { + "type": "boolean" }, "createdAt": { "type": "string", - "description": "Timestamp when the incident record was created", "format": "date-time" + } + } + }, + "IntegrationConfigSchemaDto": { + "required": [ + "channelFields", + "connectionFields" + ], + "type": "object", + "properties": { + "connectionFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IntegrationFieldDto" + } }, - "updatedAt": { - "type": "string", - "description": "Timestamp when the incident was last updated", - "format": "date-time" + "channelFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IntegrationFieldDto" + } + } + } + }, + "IntegrationDto": { + "required": [ + "authType", + "configSchema", + "description", + "lifecycle", + "logoUrl", + "name", + "setupGuideUrl", + "tierAvailability", + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" }, - "monitorName": { - "type": "string", - "description": "Name of the associated monitor; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", - "nullable": true + "name": { + "type": "string" }, - "serviceName": { - "type": "string", - "description": "Name of the associated service; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", - "nullable": true + "description": { + "type": "string" }, - "serviceSlug": { - "type": "string", - "description": "Slug of the associated service; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", - "nullable": true + "logoUrl": { + "type": "string" }, - "monitorType": { - "type": "string", - "description": "Type of the associated monitor; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", - "nullable": true + "authType": { + "type": "string" }, - "resourceGroupId": { + "tierAvailability": { "type": "string", - "description": "Resource group that owns this incident; null when not group-managed", - "format": "uuid", - "nullable": true + "enum": [ + "FREE", + "STARTER", + "PRO", + "TEAM", + "BUSINESS", + "ENTERPRISE" + ] }, - "resourceGroupName": { - "type": "string", - "description": "Name of the resource group; populated on list responses. Omitted from JSON (undefined to SDKs) on detail responses, treat missing as null.", - "nullable": true + "lifecycle": { + "type": "string" }, - "triggeringCheckId": { - "type": "string", - "description": "Scheduler-minted check execution ID whose result confirmed this incident; joins to check_results, rule_evaluations, and incident_state_transitions. Omitted from JSON (undefined to SDKs) when null, treat missing as null.", - "format": "uuid", - "nullable": true + "setupGuideUrl": { + "type": "string" }, - "triggeredByRuleSnapshotHashHex": { - "type": "string", - "description": "Hex SHA-256 of the canonical policy snapshot that fired; combined with triggeredByRuleIndex points to the exact TriggerRule. Omitted from JSON when null, treat missing as null.", - "nullable": true + "configSchema": { + "$ref": "#/components/schemas/IntegrationConfigSchemaDto" + } + } + }, + "IntegrationFieldDto": { + "required": [ + "key", + "label", + "required", + "sensitive", + "type" + ], + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "label": { + "type": "string" + }, + "type": { + "type": "string" + }, + "required": { + "type": "boolean" }, - "triggeredByRuleIndex": { - "type": "integer", - "description": "Index of the fired rule inside the policy's trigger_rules array. Omitted from JSON when null, treat missing as null.", - "format": "int32", - "nullable": true + "sensitive": { + "type": "boolean" }, - "engineVersion": { + "placeholder": { "type": "string", - "description": "Detection engine semver that evaluated the rule. Omitted from JSON when null, treat missing as null.", "nullable": true }, - "displayKey": { + "helpText": { "type": "string", - "description": "Org-scoped human-readable incident code, e.g. \"ABC-42\". Null on incidents created by pre-INC-keys API pods before the sweep; treat missing as unknown and fall back to the id", "nullable": true }, - "alertCollapsedByResourceGroupIds": { + "options": { "type": "array", - "description": "Sticky union of resource-group IDs that suppressed a paging dispatch for this member incident; null when never written / legacy", "nullable": true, "items": { - "type": "string", - "description": "Sticky union of resource-group IDs that suppressed a paging dispatch for this member incident; null when never written / legacy", - "format": "uuid" + "type": "string" } }, - "peakFailingMemberCount": { - "type": "integer", - "description": "Peak non-operational member count while this RESOURCE_GROUP incident was open; null otherwise", - "format": "int32", + "default": { + "type": "string", "nullable": true - }, - "failingMembersAtPeak": { - "type": "array", - "description": "Frozen failing members at peakFailingMemberCount; null when not a group incident or never snapshotted", - "nullable": true, - "items": { - "$ref": "#/components/schemas/IncidentFailingMemberSnapshotDto" - } } - }, - "description": "Incident triggered by a monitor check failure or manual creation" + } }, - "IncidentEventDto": { + "InviteDto": { "required": [ - "incidentId", - "title" + "createdAt", + "email", + "expiresAt", + "roleOffered", + "inviteId" ], "type": "object", "properties": { - "incidentId": { - "type": "string", - "description": "Vendor catalog incident ID", - "format": "uuid" - }, - "externalId": { - "type": "string", - "description": "Vendor-supplied external incident ID", - "nullable": true - }, - "title": { - "type": "string", - "description": "Incident title from the vendor status page" - }, - "impact": { - "type": "string", - "description": "Vendor impact level (major, minor, none)", - "nullable": true - }, - "status": { - "type": "string", - "description": "Vendor lifecycle status (only set on incident.update rows)", - "nullable": true + "inviteId": { + "type": "integer", + "description": "Unique invite identifier", + "format": "int32" }, - "body": { + "email": { "type": "string", - "description": "Update body text (only set on incident.update rows)", - "nullable": true + "description": "Email address the invite was sent to" }, - "shortlink": { + "roleOffered": { "type": "string", - "description": "Short public URL for the vendor incident", - "nullable": true + "description": "Role that will be assigned to the invitee on acceptance", + "enum": [ + "OWNER", + "ADMIN", + "MEMBER" + ] }, - "startedAt": { + "createdAt": { "type": "string", - "description": "When the vendor incident started", - "format": "date-time", - "nullable": true + "description": "Timestamp when the invite was created", + "format": "date-time" }, - "resolvedAt": { + "expiresAt": { "type": "string", - "description": "When the vendor incident resolved", - "format": "date-time", - "nullable": true + "description": "Timestamp when the invite expires", + "format": "date-time" }, - "detectedAt": { + "consumedAt": { "type": "string", - "description": "When DevHelm first detected the incident", + "description": "Timestamp when the invite was accepted; null if not yet used", "format": "date-time", "nullable": true }, - "vendorCreatedAt": { + "revokedAt": { "type": "string", - "description": "Vendor-reported creation timestamp", + "description": "Timestamp when the invite was revoked; null if active", "format": "date-time", "nullable": true - }, - "durationSeconds": { - "type": "integer", - "description": "Total duration in seconds (set on incident.resolved)", - "format": "int64", - "nullable": true - }, - "affectedComponentIds": { - "type": "array", - "description": "Affected component IDs from the vendor incident join", - "nullable": true, - "items": { - "type": "string", - "description": "Affected component IDs from the vendor incident join", - "format": "uuid" - } } }, - "description": "Vendor incident fields for a status-events rail row" + "description": "Organization invite sent to an email address" }, - "IncidentFailingMemberSnapshotDto": { + "JiraChannelConfig": { "required": [ - "memberType", - "name" + "channelType", + "domain", + "email", + "apiToken", + "projectKey" ], "type": "object", "properties": { - "memberType": { + "channelType": { "type": "string", - "description": "Member type: monitor or service" + "enum": [ + "jira" + ] }, - "monitorId": { + "domain": { + "minLength": 1, "type": "string", - "description": "Monitor ID when memberType is monitor", - "format": "uuid", - "nullable": true + "description": "Atlassian instance domain (e.g. yourteam.atlassian.net)" }, - "serviceId": { + "email": { + "minLength": 1, "type": "string", - "description": "Service ID when memberType is service", - "format": "uuid", - "nullable": true + "description": "Atlassian account email for API authentication" }, - "name": { + "apiToken": { "minLength": 1, "type": "string", - "description": "Frozen display name at snapshot time" + "description": "Atlassian API token" }, - "membershipId": { + "projectKey": { + "minLength": 1, "type": "string", - "description": "Membership row ID when available", - "format": "uuid", + "description": "Jira project key where issues are created (e.g. OPS)" + }, + "issueType": { + "type": "string", + "description": "Issue type name (e.g. Bug, Task, Incident)", "nullable": true } - }, - "description": "Frozen failing member identity at peak failing count for a resource-group incident" + } }, - "IncidentFilterParams": { + "JsonPathAssertion": { + "required": [ + "type", + "path", + "expected", + "operator" + ], "type": "object", "properties": { - "status": { - "type": "string", - "description": "Filter by incident lifecycle status; null returns every status", - "nullable": true, - "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" - ] - }, - "severity": { - "type": "string", - "description": "Filter by severity; null returns every severity", - "nullable": true, - "enum": [ - "DOWN", - "DEGRADED", - "MAINTENANCE" - ] - }, - "source": { + "type": { "type": "string", - "description": "Filter by where the incident originated (auto, manual, third-party)", - "nullable": true, "enum": [ - "AUTOMATIC", - "MANUAL", - "MONITORS", - "STATUS_DATA", - "RESOURCE_GROUP" + "json_path" ] }, - "monitorId": { - "type": "string", - "description": "Only return incidents tied to this monitor ID", - "format": "uuid", - "nullable": true - }, - "serviceId": { + "path": { + "minLength": 1, "type": "string", - "description": "Only return incidents tied to this service ID (third-party services)", - "format": "uuid", - "nullable": true + "description": "JSONPath expression to extract a value from the response body" }, - "resourceGroupId": { + "expected": { + "minLength": 1, "type": "string", - "description": "Only return incidents owned by this resource group (incidents.resource_group_id)", - "format": "uuid", - "nullable": true + "description": "Expected value to compare against" }, - "tagId": { + "operator": { "type": "string", - "description": "Only return incidents whose monitor carries this tag", - "format": "uuid", - "nullable": true + "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", + "enum": [ + "equals", + "contains", + "less_than", + "greater_than", + "matches", + "range" + ] + } + } + }, + "KeyInfo": { + "required": [ + "createdAt", + "name", + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Key ID", + "format": "int32" }, - "environmentId": { + "name": { "type": "string", - "description": "Only return incidents whose monitor lives in this environment", - "format": "uuid", - "nullable": true + "description": "Human-readable key name" }, - "excludeId": { + "createdAt": { "type": "string", - "description": "Exclude this incident ID from results (related-incident lists)", - "format": "uuid", - "nullable": true + "description": "When the key was created", + "format": "date-time" }, - "startedFrom": { + "expiresAt": { "type": "string", - "description": "Earliest startedAt to include (inclusive, ISO 8601)", + "description": "When the key expires (null = never)", "format": "date-time", "nullable": true }, - "startedTo": { + "lastUsedAt": { "type": "string", - "description": "Latest startedAt to include (inclusive, ISO 8601)", + "description": "Last time the key was used", "format": "date-time", "nullable": true - }, - "page": { - "minimum": 0, - "type": "integer", - "description": "Zero-based page index (default: 0)", - "format": "int32", - "example": 0 - }, - "size": { - "maximum": 200, - "minimum": 1, - "type": "integer", - "description": "Number of incidents per page (1–200, default: 10)", - "format": "int32", - "example": 10 } }, - "required": [ - "page", - "size" - ] + "description": "API key metadata" }, - "IncidentIoChannelConfig": { + "LinearChannelConfig": { "required": [ "channelType", - "apiKey" + "apiKey", + "teamId" ], "type": "object", "properties": { "channelType": { "type": "string", "enum": [ - "incident_io" + "linear" ] }, "apiKey": { "minLength": 1, "type": "string", - "description": "incident.io API key with 'Create incidents' permission" + "description": "Linear API key" }, - "severityId": { + "teamId": { + "minLength": 1, "type": "string", - "description": "Severity ID for created incidents (from List Severities API)", + "description": "Team ID to create issues in" + }, + "labelId": { + "type": "string", + "description": "Label ID to attach to created issues", "nullable": true + } + } + }, + "LinkedStatusPageIncidentDto": { + "required": [ + "connectionMode", + "id", + "impact", + "pageIncidentMode", + "spIncidentId", + "status", + "statusPageId", + "statusPageName", + "statusPageSlug", + "title", + "scheduled" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Status page incident ID (same value as spIncidentId; kept for backwards compatibility)", + "format": "uuid" }, - "visibility": { + "spIncidentId": { "type": "string", - "description": "Incident visibility: public or private (default: public)", + "description": "Status page incident ID (alias for id) — use this when the outer context is a monitoring incident", + "format": "uuid" + }, + "statusPageId": { + "type": "string", + "description": "Parent status page ID", + "format": "uuid" + }, + "statusPageName": { + "type": "string", + "description": "Parent status page display name" + }, + "statusPageSlug": { + "type": "string", + "description": "Parent status page URL slug" + }, + "title": { + "type": "string", + "description": "Customer-facing incident title" + }, + "status": { + "type": "string", + "description": "Current lifecycle status (INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED)", + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] + }, + "impact": { + "type": "string", + "description": "Impact level (NONE, MINOR, MAJOR, CRITICAL)", + "enum": [ + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" + ] + }, + "scheduled": { + "type": "boolean", + "description": "Scheduled maintenance flag" + }, + "publishedAt": { + "type": "string", + "description": "Publish time; null while draft", + "format": "date-time", "nullable": true + }, + "connectionMode": { + "type": "string", + "description": "Whether the linked SPI was created by automation (AUTO) or by a human/API caller (MANUAL)", + "enum": [ + "AUTO", + "MANUAL" + ] + }, + "pageIncidentMode": { + "type": "string", + "description": "Incident mode of the parent status page at read time (MANUAL, REVIEW, AUTOMATIC)", + "enum": [ + "MANUAL", + "REVIEW", + "AUTOMATIC" + ] } } }, - "IncidentPolicyDto": { + "MaintenanceComponentRef": { "required": [ - "confirmation", - "createdAt", "id", - "monitorId", - "recovery", - "triggerRules", - "updatedAt" + "name", + "status" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Unique incident policy identifier", + "description": "Component identifier", "format": "uuid" }, - "monitorId": { + "name": { "type": "string", - "description": "Monitor this policy is attached to", + "description": "Component name" + }, + "status": { + "type": "string", + "description": "Component status at the time of the maintenance update" + } + }, + "description": "A component affected by a scheduled maintenance window" + }, + "MaintenanceEventDto": { + "required": [ + "externalId", + "maintenanceId", + "status", + "title" + ], + "type": "object", + "properties": { + "maintenanceId": { + "type": "string", + "description": "Vendor catalog maintenance ID", "format": "uuid" }, - "triggerRules": { - "type": "array", - "description": "Array of trigger rules defining when an incident should be raised", - "items": { - "$ref": "#/components/schemas/TriggerRule" - } + "externalId": { + "type": "string", + "description": "Vendor-supplied external maintenance ID" }, - "confirmation": { - "$ref": "#/components/schemas/ConfirmationPolicy" + "title": { + "type": "string", + "description": "Maintenance title from the vendor status page" }, - "recovery": { - "$ref": "#/components/schemas/RecoveryPolicy" + "status": { + "type": "string", + "description": "Lifecycle status: scheduled, in_progress, verifying, completed" }, - "createdAt": { + "impact": { "type": "string", - "description": "Timestamp when the policy was created", - "format": "date-time" + "description": "Vendor impact level", + "nullable": true }, - "updatedAt": { + "shortlink": { "type": "string", - "description": "Timestamp when the policy was last updated", - "format": "date-time" + "description": "Short public URL for the vendor maintenance", + "nullable": true }, - "monitorRegionCount": { - "type": "integer", - "description": "Number of regions configured on the monitor (only set in internal API responses)", - "format": "int32", + "scheduledFor": { + "type": "string", + "description": "Scheduled start; null for undated maintenance", + "format": "date-time", "nullable": true }, - "checkFrequencySeconds": { - "type": "integer", - "description": "Monitor check frequency in seconds (only set in internal API responses)", - "format": "int32", + "scheduledUntil": { + "type": "string", + "description": "Scheduled end", + "format": "date-time", + "nullable": true + }, + "startedAt": { + "type": "string", + "description": "When maintenance actually started", + "format": "date-time", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "When maintenance completed", + "format": "date-time", "nullable": true + }, + "affectedComponentIds": { + "type": "array", + "description": "Affected component IDs", + "nullable": true, + "items": { + "type": "string", + "description": "Affected component IDs", + "format": "uuid" + } } }, - "description": "Incident detection, confirmation, and recovery policy for a monitor" + "description": "Vendor maintenance fields for a status-events rail row" }, - "IncidentRef": { + "MaintenanceUpdateDto": { "required": [ "id", - "impact", - "title" + "status" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Internal incident ID — UUID for status-page incidents, service incident UUID for catalog", + "description": "Unique update identifier", "format": "uuid" }, - "title": { + "status": { "type": "string", - "description": "Incident title at the time of the overlap" + "description": "Status at the time of this update" }, - "impact": { + "body": { "type": "string", - "description": "Incident impact level (e.g. minor, major, critical for catalog; NONE/MINOR/MAJOR/CRITICAL for status pages)" - } - }, - "description": "Lightweight reference to an incident overlapping a given uptime day" - }, - "IncidentsSummaryDto": { - "type": "object", - "properties": { - "active": { - "type": "integer", - "format": "int64" - }, - "resolvedToday": { - "type": "integer", - "format": "int64" + "description": "Update message from the vendor", + "nullable": true }, - "mttr30d": { - "type": "number", - "format": "double", + "displayAt": { + "type": "string", + "description": "Timestamp when this update was posted", + "format": "date-time", "nullable": true } }, - "description": "Incident summary counters", - "required": [ - "active", - "resolvedToday" - ] + "description": "A status update within a scheduled maintenance lifecycle" }, - "IncidentStateTransitionDto": { + "MaintenanceWindowDto": { "required": [ - "affectedRegions", - "checkId", - "details", - "engineVersion", - "fromStatus", + "createdAt", + "endsAt", "id", - "monitorId", - "occurredAt", - "policySnapshotHashHex", - "reason", - "toStatus", - "triggeringEvaluationIds" + "startsAt", + "organizationId", + "suppressAlerts" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Forensic row UUID", + "description": "Unique maintenance window identifier", "format": "uuid" }, - "occurredAt": { - "type": "string", - "description": "When the state transition occurred", - "format": "date-time" - }, "monitorId": { "type": "string", - "description": "Monitor this transition pertains to", - "format": "uuid" - }, - "incidentId": { - "type": "string", - "description": "Incident this transition belongs to; null for pre-incident (auto-cleared) transitions", + "description": "Monitor this window applies to; null for org-wide windows", "format": "uuid", "nullable": true }, - "fromStatus": { - "minLength": 1, - "type": "string", - "description": "Previous status (WATCHING | TRIGGERED | CONFIRMED | RESOLVED)" + "organizationId": { + "type": "integer", + "description": "Organization this maintenance window belongs to", + "format": "int32" }, - "toStatus": { - "minLength": 1, + "startsAt": { "type": "string", - "description": "New status (WATCHING | TRIGGERED | CONFIRMED | RESOLVED)" + "description": "Scheduled start of the maintenance window", + "format": "date-time" }, - "reason": { - "minLength": 1, + "endsAt": { "type": "string", - "description": "Why the transition fired (trigger | confirm | resolve | auto_clear | reopen)" - }, - "triggeringEvaluationIds": { - "type": "array", - "description": "rule_evaluation ids that caused this transition (may be empty for timeout-driven edges)", - "items": { - "type": "string", - "description": "rule_evaluation ids that caused this transition (may be empty for timeout-driven edges)", - "format": "uuid" - } - }, - "affectedRegions": { - "type": "array", - "description": "Regions whose evaluations contributed to this transition", - "items": { - "type": "string", - "description": "Regions whose evaluations contributed to this transition" - } + "description": "Scheduled end of the maintenance window", + "format": "date-time" }, - "policySnapshotHashHex": { - "minLength": 1, + "repeatRule": { "type": "string", - "description": "Hex-encoded hash of the policy snapshot that governed this transition" + "description": "Reserved: iCal RRULE for recurring windows (stored but not yet honored)", + "nullable": true }, - "engineVersion": { - "minLength": 1, + "reason": { "type": "string", - "description": "Detection engine version that emitted this transition" + "description": "Human-readable reason for the maintenance", + "nullable": true }, - "checkId": { - "type": "string", - "description": "Scheduler-minted check execution ID (V92) of the triggering result", - "format": "uuid" + "suppressAlerts": { + "type": "boolean", + "description": "Whether alerts are suppressed during this window" }, - "details": { - "$ref": "#/components/schemas/StateTransitionDetails" + "createdAt": { + "type": "string", + "description": "Timestamp when the window was created", + "format": "date-time" } }, - "description": "State-machine transitions this check caused (may be empty if nothing fired)" + "description": "Scheduled maintenance window for a monitor" }, - "IncidentTimelineDto": { + "MatchRule": { "required": [ - "transitions", - "triggeringEvaluations" + "type" ], "type": "object", "properties": { - "transitions": { + "type": { + "type": "string", + "description": "Rule type used to evaluate incidents and status events", + "enum": [ + "severity_gte", + "monitor_id_in", + "region_in", + "incident_status", + "monitor_type_in", + "service_id_in", + "resource_group_id_in", + "component_name_in", + "monitor_tag_in" + ] + }, + "value": { + "type": "string", + "description": "Comparison value for single-value rules like severity_gte", + "nullable": true + }, + "monitorIds": { "type": "array", - "description": "State-machine transitions in chronological order", + "description": "Monitor UUIDs to match for monitor_id_in rules", + "nullable": true, "items": { - "$ref": "#/components/schemas/IncidentStateTransitionDto" + "type": "string", + "description": "Monitor UUIDs to match for monitor_id_in rules", + "format": "uuid" } }, - "triggeringEvaluations": { + "regions": { "type": "array", - "description": "Rule evaluations that caused any of the transitions above. Correlate via evaluation.triggeringTransitionId == transition.id", + "description": "Region codes to match for region_in rules", + "nullable": true, "items": { - "$ref": "#/components/schemas/RuleEvaluationDto" + "type": "string", + "description": "Region codes to match for region_in rules" } }, - "policySnapshot": { + "values": { + "type": "array", + "description": "Values list for multi-value rules like monitor_type_in", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/PolicySnapshotDto" - } - ] + "items": { + "type": "string", + "description": "Values list for multi-value rules like monitor_type_in" + } } - } + }, + "description": "Match rules to evaluate (all must pass; omit or empty for catch-all)" }, - "IncidentTriggerDto": { + "MattermostChannelConfig": { "required": [ - "source" + "channelType", + "webhookUrl" ], "type": "object", "properties": { - "ruleType": { + "channelType": { "type": "string", - "description": "Trigger rule type (consecutive_failures, failures_in_window, response_time); null when unknown", - "nullable": true - }, - "ruleIndex": { - "type": "integer", - "description": "0-based index into the policy trigger_rules array; null when unknown", - "format": "int32", - "nullable": true - }, - "count": { - "type": "integer", - "description": "Observed failing_streak or failures_in_window from forensics; null when unavailable", - "format": "int32", - "nullable": true + "enum": [ + "mattermost" + ] }, - "threshold": { - "type": "integer", - "description": "Rule required count or threshold_ms from forensics; null when unavailable", - "format": "int32", - "nullable": true + "webhookUrl": { + "minLength": 1, + "type": "string", + "description": "Mattermost incoming webhook URL" }, - "lastError": { + "channel": { "type": "string", - "description": "failure_reason from the triggering check result; null when unavailable", + "description": "Override channel (if webhook allows)", "nullable": true }, - "firstFailedCheckAt": { + "iconUrl": { "type": "string", - "description": "Earliest failing check timestamp in the confirm window when computable; null otherwise", - "format": "date-time", + "description": "Custom bot icon URL", "nullable": true - }, - "source": { - "minLength": 1, + } + } + }, + "McpConnectsAssertion": { + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Where the enrichment came from: forensics, checks, or none (STATUS_DATA/manual/no data)", "enum": [ - "forensics", - "checks", - "none" + "mcp_connects" ] } }, - "description": "Honest trigger metadata for the incident origin tooltip / TTD strip" + "required": [ + "type" + ] }, - "IncidentUpdateDto": { + "McpHasCapabilityAssertion": { "required": [ - "createdAt", - "id", - "incidentId", - "notifySubscribers" + "type", + "capability" ], "type": "object", "properties": { - "id": { + "type": { "type": "string", - "format": "uuid" + "enum": [ + "mcp_has_capability" + ] }, - "incidentId": { + "capability": { + "minLength": 1, "type": "string", - "format": "uuid" + "description": "Capability name the server must advertise, e.g. tools or resources" + } + } + }, + "McpMinToolsAssertion": { + "required": [ + "type", + "min" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp_min_tools" + ] }, - "oldStatus": { + "min": { + "type": "integer", + "description": "Minimum number of tools the server must expose", + "format": "int32" + } + } + }, + "McpProtocolVersionAssertion": { + "required": [ + "type", + "version" + ], + "type": "object", + "properties": { + "type": { "type": "string", - "nullable": true, "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" + "mcp_protocol_version" ] }, - "newStatus": { + "version": { + "minLength": 1, + "type": "string", + "description": "Expected MCP protocol version string from the server handshake" + } + } + }, + "McpResponseTimeAssertion": { + "type": "object", + "properties": { + "type": { "type": "string", - "nullable": true, "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" + "mcp_response_time" ] }, - "body": { + "maxMs": { + "type": "integer", + "description": "Maximum allowed MCP check duration in milliseconds", + "format": "int32" + } + }, + "required": [ + "type", + "maxMs" + ] + }, + "McpResponseTimeWarnAssertion": { + "type": "object", + "properties": { + "type": { "type": "string", - "nullable": true + "enum": [ + "mcp_response_time_warn" + ] }, - "createdBy": { + "warnMs": { + "type": "integer", + "description": "MCP check duration in milliseconds that triggers a warning only", + "format": "int32" + } + }, + "required": [ + "type", + "warnMs" + ] + }, + "McpServer": { + "type": "object", + "description": "MCP server check-type-specific details", + "properties": { + "check_type": { "type": "string", - "nullable": true, "enum": [ - "SYSTEM", - "USER" + "mcp_server" ] }, - "notifySubscribers": { - "type": "boolean" + "url": { + "type": "string", + "description": "MCP server URL", + "nullable": true }, - "createdAt": { + "protocolVersion": { "type": "string", - "format": "date-time" + "description": "MCP protocol version", + "nullable": true + }, + "serverInfo": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "MCP server info (name, version, etc.)", + "nullable": true + }, + "description": "MCP server info (name, version, etc.)", + "nullable": true + }, + "toolCount": { + "type": "integer", + "description": "Number of tools exposed", + "format": "int32", + "nullable": true + }, + "resourceCount": { + "type": "integer", + "description": "Number of resources exposed", + "format": "int32", + "nullable": true + }, + "promptCount": { + "type": "integer", + "description": "Number of prompts exposed", + "format": "int32", + "nullable": true } - } + }, + "required": [ + "check_type" + ] }, - "IntegrationConfigSchemaDto": { + "McpServerMonitorConfig": { "required": [ - "channelFields", - "connectionFields" + "command" ], "type": "object", "properties": { - "connectionFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IntegrationFieldDto" - } + "command": { + "minLength": 1, + "type": "string", + "description": "Command to execute to start the MCP server" }, - "channelFields": { + "args": { "type": "array", + "description": "Command-line arguments for the MCP server process", + "nullable": true, "items": { - "$ref": "#/components/schemas/IntegrationFieldDto" + "type": "string", + "description": "Command-line arguments for the MCP server process", + "nullable": true } + }, + "env": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Environment variables to pass to the MCP server process", + "nullable": true + }, + "description": "Environment variables to pass to the MCP server process", + "nullable": true } } }, - "IntegrationDto": { + "McpToolAvailableAssertion": { "required": [ - "authType", - "configSchema", - "description", - "lifecycle", - "logoUrl", - "name", - "setupGuideUrl", - "tierAvailability", - "type" + "type", + "toolName" ], "type": "object", "properties": { "type": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "authType": { - "type": "string" - }, - "tierAvailability": { "type": "string", "enum": [ - "FREE", - "STARTER", - "PRO", - "TEAM", - "BUSINESS", - "ENTERPRISE" + "mcp_tool_available" ] }, - "lifecycle": { - "type": "string" - }, - "setupGuideUrl": { - "type": "string" - }, - "configSchema": { - "$ref": "#/components/schemas/IntegrationConfigSchemaDto" + "toolName": { + "minLength": 1, + "type": "string", + "description": "MCP tool name that must appear in the server's tool list" } } }, - "IntegrationFieldDto": { + "McpToolCountChangedAssertion": { "required": [ - "key", - "label", - "required", - "sensitive", - "type" + "type", + "expectedCount" ], "type": "object", "properties": { - "key": { - "type": "string" - }, - "label": { - "type": "string" - }, "type": { - "type": "string" - }, - "required": { - "type": "boolean" - }, - "sensitive": { - "type": "boolean" - }, - "placeholder": { - "type": "string", - "nullable": true - }, - "helpText": { "type": "string", - "nullable": true - }, - "options": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } + "enum": [ + "mcp_tool_count_changed" + ] }, - "default": { - "type": "string", - "nullable": true + "expectedCount": { + "type": "integer", + "description": "Expected tool count; warns when the live count differs", + "format": "int32" } } }, - "InviteDto": { + "MemberDto": { "required": [ "createdAt", "email", - "expiresAt", - "roleOffered", - "inviteId" + "orgRole", + "status", + "userId" ], "type": "object", "properties": { - "inviteId": { + "userId": { "type": "integer", - "description": "Unique invite identifier", + "description": "User identifier of the member", "format": "int32" }, "email": { "type": "string", - "description": "Email address the invite was sent to" + "description": "Member email address" }, - "roleOffered": { + "name": { "type": "string", - "description": "Role that will be assigned to the invitee on acceptance", + "description": "Member display name; null if not set", + "nullable": true + }, + "orgRole": { + "type": "string", + "description": "Member role within this organization (OWNER, ADMIN, MEMBER)", "enum": [ "OWNER", "ADMIN", "MEMBER" ] }, - "createdAt": { + "status": { "type": "string", - "description": "Timestamp when the invite was created", - "format": "date-time" + "description": "Membership status (ACTIVE, PENDING, SUSPENDED)", + "enum": [ + "INVITED", + "ACTIVE", + "SUSPENDED", + "LEFT", + "REMOVED", + "DECLINED" + ] }, - "expiresAt": { + "createdAt": { "type": "string", - "description": "Timestamp when the invite expires", + "description": "Timestamp when the member was added to the organization", "format": "date-time" - }, - "consumedAt": { - "type": "string", - "description": "Timestamp when the invite was accepted; null if not yet used", - "format": "date-time", - "nullable": true - }, - "revokedAt": { - "type": "string", - "description": "Timestamp when the invite was revoked; null if active", - "format": "date-time", - "nullable": true } }, - "description": "Organization invite sent to an email address" + "description": "Organization member with role and status" }, - "JiraChannelConfig": { + "MemberRoleChangedMetadata": { "required": [ - "channelType", - "domain", - "email", - "apiToken", - "projectKey" + "kind", + "oldRole", + "newRole" ], "type": "object", + "description": "Role transition recorded when an organization member's role changes.", "properties": { - "channelType": { + "kind": { "type": "string", "enum": [ - "jira" + "member_role_changed" ] }, - "domain": { - "minLength": 1, - "type": "string", - "description": "Atlassian instance domain (e.g. yourteam.atlassian.net)" - }, - "email": { - "minLength": 1, - "type": "string", - "description": "Atlassian account email for API authentication" - }, - "apiToken": { - "minLength": 1, - "type": "string", - "description": "Atlassian API token" - }, - "projectKey": { - "minLength": 1, + "oldRole": { "type": "string", - "description": "Jira project key where issues are created (e.g. OPS)" + "description": "Role the member held before the change", + "enum": [ + "OWNER", + "ADMIN", + "MEMBER" + ] }, - "issueType": { + "newRole": { "type": "string", - "description": "Issue type name (e.g. Bug, Task, Incident)", - "nullable": true + "description": "Role the member holds after the change", + "enum": [ + "OWNER", + "ADMIN", + "MEMBER" + ] } } }, - "JsonPathAssertion": { + "MonitorAssertionDto": { "required": [ - "type", - "path", - "expected", - "operator" + "assertionType", + "config", + "id", + "monitorId", + "severity" ], "type": "object", "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "json_path" - ] + "format": "uuid" }, - "path": { - "minLength": 1, + "monitorId": { "type": "string", - "description": "JSONPath expression to extract a value from the response body" + "format": "uuid" }, - "expected": { - "minLength": 1, + "assertionType": { "type": "string", - "description": "Expected value to compare against" + "enum": [ + "status_code", + "response_time", + "body_contains", + "json_path", + "header_value", + "regex_body", + "dns_resolves", + "dns_response_time", + "dns_expected_ips", + "dns_expected_cname", + "dns_record_contains", + "dns_record_equals", + "dns_txt_contains", + "dns_min_answers", + "dns_max_answers", + "dns_response_time_warn", + "dns_ttl_low", + "dns_ttl_high", + "mcp_connects", + "mcp_response_time", + "mcp_has_capability", + "mcp_tool_available", + "mcp_min_tools", + "mcp_protocol_version", + "mcp_response_time_warn", + "mcp_tool_count_changed", + "ssl_expiry", + "response_size", + "redirect_count", + "redirect_target", + "response_time_warn", + "tcp_connects", + "tcp_response_time", + "tcp_response_time_warn", + "icmp_reachable", + "icmp_response_time", + "icmp_response_time_warn", + "icmp_packet_loss", + "heartbeat_received", + "heartbeat_max_interval", + "heartbeat_interval_drift", + "heartbeat_payload_contains" + ] }, - "operator": { + "config": { + "oneOf": [ + { + "$ref": "#/components/schemas/BodyContainsAssertion" + }, + { + "$ref": "#/components/schemas/DnsExpectedCnameAssertion" + }, + { + "$ref": "#/components/schemas/DnsExpectedIpsAssertion" + }, + { + "$ref": "#/components/schemas/DnsMaxAnswersAssertion" + }, + { + "$ref": "#/components/schemas/DnsMinAnswersAssertion" + }, + { + "$ref": "#/components/schemas/DnsRecordContainsAssertion" + }, + { + "$ref": "#/components/schemas/DnsRecordEqualsAssertion" + }, + { + "$ref": "#/components/schemas/DnsResolvesAssertion" + }, + { + "$ref": "#/components/schemas/DnsResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/DnsResponseTimeWarnAssertion" + }, + { + "$ref": "#/components/schemas/DnsTtlHighAssertion" + }, + { + "$ref": "#/components/schemas/DnsTtlLowAssertion" + }, + { + "$ref": "#/components/schemas/DnsTxtContainsAssertion" + }, + { + "$ref": "#/components/schemas/HeaderValueAssertion" + }, + { + "$ref": "#/components/schemas/HeartbeatIntervalDriftAssertion" + }, + { + "$ref": "#/components/schemas/HeartbeatMaxIntervalAssertion" + }, + { + "$ref": "#/components/schemas/HeartbeatPayloadContainsAssertion" + }, + { + "$ref": "#/components/schemas/HeartbeatReceivedAssertion" + }, + { + "$ref": "#/components/schemas/IcmpPacketLossAssertion" + }, + { + "$ref": "#/components/schemas/IcmpReachableAssertion" + }, + { + "$ref": "#/components/schemas/IcmpResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/IcmpResponseTimeWarnAssertion" + }, + { + "$ref": "#/components/schemas/JsonPathAssertion" + }, + { + "$ref": "#/components/schemas/McpConnectsAssertion" + }, + { + "$ref": "#/components/schemas/McpHasCapabilityAssertion" + }, + { + "$ref": "#/components/schemas/McpMinToolsAssertion" + }, + { + "$ref": "#/components/schemas/McpProtocolVersionAssertion" + }, + { + "$ref": "#/components/schemas/McpResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/McpResponseTimeWarnAssertion" + }, + { + "$ref": "#/components/schemas/McpToolAvailableAssertion" + }, + { + "$ref": "#/components/schemas/McpToolCountChangedAssertion" + }, + { + "$ref": "#/components/schemas/RedirectCountAssertion" + }, + { + "$ref": "#/components/schemas/RedirectTargetAssertion" + }, + { + "$ref": "#/components/schemas/RegexBodyAssertion" + }, + { + "$ref": "#/components/schemas/ResponseSizeAssertion" + }, + { + "$ref": "#/components/schemas/ResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/ResponseTimeWarnAssertion" + }, + { + "$ref": "#/components/schemas/SslExpiryAssertion" + }, + { + "$ref": "#/components/schemas/StatusCodeAssertion" + }, + { + "$ref": "#/components/schemas/TcpConnectsAssertion" + }, + { + "$ref": "#/components/schemas/TcpResponseTimeAssertion" + }, + { + "$ref": "#/components/schemas/TcpResponseTimeWarnAssertion" + } + ] + }, + "severity": { "type": "string", - "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", "enum": [ - "equals", - "contains", - "less_than", - "greater_than", - "matches", - "range" + "fail", + "warn" ] } } }, - "KeyInfo": { + "MonitorAuthConfig": { + "description": "New authentication configuration (full replacement)", + "discriminator": { + "propertyName": "type", + "mapping": { + "bearer": "#/components/schemas/BearerAuthConfig", + "basic": "#/components/schemas/BasicAuthConfig", + "header": "#/components/schemas/HeaderAuthConfig", + "api_key": "#/components/schemas/ApiKeyAuthConfig" + } + }, + "oneOf": [ + { + "$ref": "#/components/schemas/BearerAuthConfig" + }, + { + "$ref": "#/components/schemas/BasicAuthConfig" + }, + { + "$ref": "#/components/schemas/HeaderAuthConfig" + }, + { + "$ref": "#/components/schemas/ApiKeyAuthConfig" + } + ] + }, + "MonitorAuthDto": { "required": [ - "createdAt", - "name", - "id" + "authType", + "config", + "id", + "monitorId" ], "type": "object", "properties": { "id": { - "type": "integer", - "description": "Key ID", - "format": "int32" - }, - "name": { "type": "string", - "description": "Human-readable key name" + "format": "uuid" }, - "createdAt": { + "monitorId": { "type": "string", - "description": "When the key was created", - "format": "date-time" + "format": "uuid" }, - "expiresAt": { + "authType": { "type": "string", - "description": "When the key expires (null = never)", - "format": "date-time", - "nullable": true + "enum": [ + "bearer", + "basic", + "header", + "api_key" + ] }, - "lastUsedAt": { - "type": "string", - "description": "Last time the key was used", - "format": "date-time", - "nullable": true + "config": { + "oneOf": [ + { + "$ref": "#/components/schemas/ApiKeyAuthConfig" + }, + { + "$ref": "#/components/schemas/BasicAuthConfig" + }, + { + "$ref": "#/components/schemas/BearerAuthConfig" + }, + { + "$ref": "#/components/schemas/HeaderAuthConfig" + } + ] } - }, - "description": "API key metadata" + } }, - "LinearChannelConfig": { + "MonitorDto": { "required": [ - "channelType", - "apiKey", - "teamId" + "config", + "createdAt", + "id", + "managedBy", + "name", + "regions", + "type", + "updatedAt", + "organizationId", + "frequencySeconds", + "enabled", + "muted" ], "type": "object", "properties": { - "channelType": { + "id": { "type": "string", - "enum": [ - "linear" - ] + "description": "Unique monitor identifier", + "format": "uuid" }, - "apiKey": { + "organizationId": { + "type": "integer", + "description": "Organization this monitor belongs to", + "format": "int32" + }, + "name": { "minLength": 1, "type": "string", - "description": "Linear API key" + "description": "Human-readable name for this monitor" + }, + "type": { + "type": "string", + "enum": [ + "HTTP", + "DNS", + "MCP_SERVER", + "TCP", + "ICMP", + "HEARTBEAT", + "BROWSER", + "MULTI_STEP_API" + ] + }, + "config": { + "oneOf": [ + { + "$ref": "#/components/schemas/DnsMonitorConfig" + }, + { + "$ref": "#/components/schemas/HeartbeatMonitorConfig" + }, + { + "$ref": "#/components/schemas/HttpMonitorConfig" + }, + { + "$ref": "#/components/schemas/IcmpMonitorConfig" + }, + { + "$ref": "#/components/schemas/McpServerMonitorConfig" + }, + { + "$ref": "#/components/schemas/ScriptMonitorConfig" + }, + { + "$ref": "#/components/schemas/TcpMonitorConfig" + } + ] + }, + "frequencySeconds": { + "type": "integer", + "description": "Check frequency in seconds (30–86400)", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "Whether the monitor is active" }, - "teamId": { - "minLength": 1, - "type": "string", - "description": "Team ID to create issues in" + "regions": { + "type": "array", + "description": "Probe regions where checks are executed", + "items": { + "type": "string", + "description": "Probe regions where checks are executed" + } }, - "labelId": { - "type": "string", - "description": "Label ID to attach to created issues", - "nullable": true - } - } - }, - "LinkedStatusPageIncidentDto": { - "required": [ - "connectionMode", - "id", - "impact", - "pageIncidentMode", - "spIncidentId", - "status", - "statusPageId", - "statusPageName", - "statusPageSlug", - "title", - "scheduled" - ], - "type": "object", - "properties": { - "id": { + "managedBy": { "type": "string", - "description": "Status page incident ID (same value as spIncidentId; kept for backwards compatibility)", - "format": "uuid" + "description": "Source that created/owns this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API", + "enum": [ + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" + ] }, - "spIncidentId": { + "createdAt": { "type": "string", - "description": "Status page incident ID (alias for id) — use this when the outer context is a monitoring incident", - "format": "uuid" + "description": "Timestamp when the monitor was created", + "format": "date-time" }, - "statusPageId": { + "updatedAt": { "type": "string", - "description": "Parent status page ID", - "format": "uuid" + "description": "Timestamp when the monitor was last updated", + "format": "date-time" }, - "statusPageName": { - "type": "string", - "description": "Parent status page display name" + "assertions": { + "type": "array", + "description": "Assertions evaluated against each check result; null on list responses", + "nullable": true, + "items": { + "$ref": "#/components/schemas/MonitorAssertionDto" + } }, - "statusPageSlug": { - "type": "string", - "description": "Parent status page URL slug" + "tags": { + "type": "array", + "description": "Tags applied to this monitor", + "nullable": true, + "items": { + "$ref": "#/components/schemas/TagDto" + } }, - "title": { + "pingUrl": { "type": "string", - "description": "Customer-facing incident title" + "description": "Heartbeat ping URL; populated for HEARTBEAT monitors only", + "nullable": true }, - "status": { - "type": "string", - "description": "Current lifecycle status (INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED)", - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" + "environment": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/Summary" + } ] }, - "impact": { - "type": "string", - "description": "Impact level (NONE, MINOR, MAJOR, CRITICAL)", - "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" + "auth": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/MonitorAuthConfig" + } ] }, - "scheduled": { - "type": "boolean", - "description": "Scheduled maintenance flag" + "incidentPolicy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/IncidentPolicyDto" + } + ] }, - "publishedAt": { - "type": "string", - "description": "Publish time; null while draft", - "format": "date-time", - "nullable": true + "alertChannelIds": { + "type": "array", + "description": "Alert channel IDs linked to this monitor; populated on single-monitor responses", + "nullable": true, + "items": { + "type": "string", + "description": "Alert channel IDs linked to this monitor; populated on single-monitor responses", + "format": "uuid" + } }, - "connectionMode": { + "currentStatus": { "type": "string", - "description": "Whether the linked SPI was created by automation (AUTO) or by a human/API caller (MANUAL)", + "description": "Current operational state. One of UP, DOWN, DEGRADED, PAUSED, or UNKNOWN", + "nullable": true, "enum": [ - "AUTO", - "MANUAL" + "up", + "degraded", + "down", + "paused", + "unknown" ] }, - "pageIncidentMode": { - "type": "string", - "description": "Incident mode of the parent status page at read time (MANUAL, REVIEW, AUTOMATIC)", - "enum": [ - "MANUAL", - "REVIEW", - "AUTOMATIC" - ] - } - } - }, - "MaintenanceComponentRef": { - "required": [ - "id", - "name", - "status" - ], - "type": "object", - "properties": { - "id": { + "definitionId": { "type": "string", - "description": "Component identifier", - "format": "uuid" + "description": "Definition id for a browser or multi-step monitor. Null on probe monitors", + "format": "uuid", + "nullable": true }, - "name": { - "type": "string", - "description": "Component name" + "capturePolicy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/CapturePolicy" + } + ] }, - "status": { - "type": "string", - "description": "Component status at the time of the maintenance update" - } - }, - "description": "A component affected by a scheduled maintenance window" - }, - "MaintenanceEventDto": { - "required": [ - "externalId", - "maintenanceId", - "status", - "title" - ], - "type": "object", - "properties": { - "maintenanceId": { - "type": "string", - "description": "Vendor catalog maintenance ID", - "format": "uuid" + "fastRetryMaxAttempts": { + "type": "integer", + "description": "Fast-retry max attempts; null/0 = off", + "format": "int32", + "nullable": true }, - "externalId": { - "type": "string", - "description": "Vendor-supplied external maintenance ID" + "muted": { + "type": "boolean", + "description": "Whether alert delivery is muted" }, - "title": { + "mutedUntil": { "type": "string", - "description": "Maintenance title from the vendor status page" + "description": "Mute expiry; null means indefinite while muted", + "format": "date-time", + "nullable": true }, - "status": { + "muteReason": { "type": "string", - "description": "Lifecycle status: scheduled, in_progress, verifying, completed" + "description": "Optional mute reason", + "nullable": true }, - "impact": { + "pausedAt": { "type": "string", - "description": "Vendor impact level", + "description": "When the monitor was paused", + "format": "date-time", "nullable": true }, - "shortlink": { + "pauseReason": { "type": "string", - "description": "Short public URL for the vendor maintenance", + "description": "Optional pause reason", "nullable": true }, - "scheduledFor": { + "pauseExpiresAt": { "type": "string", - "description": "Scheduled start; null for undated maintenance", + "description": "Pause expiry", "format": "date-time", "nullable": true }, - "scheduledUntil": { + "quarantineOwnerId": { "type": "string", - "description": "Scheduled end", - "format": "date-time", + "description": "Quarantine person owner id", "nullable": true }, - "startedAt": { + "quarantineUntil": { "type": "string", - "description": "When maintenance actually started", + "description": "Quarantine expiry; non-null means quarantined", "format": "date-time", "nullable": true }, - "completedAt": { + "quarantineReason": { "type": "string", - "description": "When maintenance completed", - "format": "date-time", + "description": "Quarantine reason", "nullable": true }, - "affectedComponentIds": { - "type": "array", - "description": "Affected component IDs", + "upload": { "nullable": true, - "items": { - "type": "string", - "description": "Affected component IDs", - "format": "uuid" - } + "allOf": [ + { + "$ref": "#/components/schemas/PackageUploadDto" + } + ] } }, - "description": "Vendor maintenance fields for a status-events rail row" + "description": "Full monitor representation" }, - "MaintenanceUpdateDto": { - "required": [ - "id", - "status" - ], + "MonitorOverlayRequest": { "type": "object", "properties": { - "id": { - "type": "string", - "description": "Unique update identifier", - "format": "uuid" - }, - "status": { - "type": "string", - "description": "Status at the time of this update" - }, - "body": { + "reason": { + "maxLength": 280, + "minLength": 0, "type": "string", - "description": "Update message from the vendor", + "description": "Optional human-readable reason (max 280)", "nullable": true }, - "displayAt": { + "expiresAt": { "type": "string", - "description": "Timestamp when this update was posted", + "description": "When this overlay expires", "format": "date-time", "nullable": true } - }, - "description": "A status update within a scheduled maintenance lifecycle" + } }, - "MaintenanceWindowDto": { + "MonitorPackageSpec": { "required": [ - "createdAt", - "endsAt", - "id", - "startsAt", - "organizationId", - "suppressAlerts" + "digest", + "entrypoint", + "files" ], "type": "object", "properties": { - "id": { + "digest": { + "maxLength": 64, + "minLength": 64, "type": "string", - "description": "Unique maintenance window identifier", - "format": "uuid" + "description": "SHA-256 hex digest of the package zip (64 characters)" }, - "monitorId": { + "entrypoint": { + "maxLength": 512, + "minLength": 0, "type": "string", - "description": "Monitor this window applies to; null for org-wide windows", - "format": "uuid", - "nullable": true + "description": "Entrypoint path inside the zip, e.g. tests/login.spec.ts" }, - "organizationId": { - "type": "integer", - "description": "Organization this maintenance window belongs to", - "format": "int32" + "files": { + "maxItems": 256, + "minItems": 0, + "type": "array", + "description": "Relative file paths included in the zip", + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string", + "description": "Relative file paths included in the zip" + } }, - "startsAt": { - "type": "string", - "description": "Scheduled start of the maintenance window", - "format": "date-time" + "keys": { + "maxItems": 64, + "minItems": 0, + "type": "array", + "description": "Secret names the zip demanded. PUT: null preserves, [] clears", + "nullable": true, + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Secret names the zip demanded. PUT: null preserves, [] clears" + } }, - "endsAt": { + "gitSha": { + "maxLength": 64, + "minLength": 0, "type": "string", - "description": "Scheduled end of the maintenance window", - "format": "date-time" + "description": "Commit SHA from the repo that produced this zip. Client-supplied provenance only", + "nullable": true }, - "repeatRule": { + "gitMessage": { + "maxLength": 1024, + "minLength": 0, "type": "string", - "description": "Reserved: iCal RRULE for recurring windows (stored but not yet honored)", + "description": "Commit message from the repo that produced this zip", "nullable": true }, - "reason": { + "gitFile": { + "maxLength": 512, + "minLength": 0, "type": "string", - "description": "Human-readable reason for the maintenance", + "description": "Path of the declaring file in that repo", "nullable": true }, - "suppressAlerts": { - "type": "boolean", - "description": "Whether alerts are suppressed during this window" - }, - "createdAt": { + "authoredBy": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "Timestamp when the window was created", - "format": "date-time" + "description": "Author attribution supplied with the package", + "nullable": true } }, - "description": "Scheduled maintenance window for a monitor" + "description": "New package zip metadata for this environment" }, - "MatchRule": { + "MonitorReference": { "required": [ - "type" + "id", + "name" ], "type": "object", "properties": { - "type": { + "id": { "type": "string", - "description": "Rule type used to evaluate incidents and status events", - "enum": [ - "severity_gte", - "monitor_id_in", - "region_in", - "incident_status", - "monitor_type_in", - "service_id_in", - "resource_group_id_in", - "component_name_in", - "monitor_tag_in" - ] + "description": "Monitor identifier", + "format": "uuid" }, - "value": { + "name": { "type": "string", - "description": "Comparison value for single-value rules like severity_gte", - "nullable": true - }, - "monitorIds": { - "type": "array", - "description": "Monitor UUIDs to match for monitor_id_in rules", - "nullable": true, - "items": { - "type": "string", - "description": "Monitor UUIDs to match for monitor_id_in rules", - "format": "uuid" - } - }, - "regions": { - "type": "array", - "description": "Region codes to match for region_in rules", - "nullable": true, - "items": { - "type": "string", - "description": "Region codes to match for region_in rules" - } - }, - "values": { - "type": "array", - "description": "Values list for multi-value rules like monitor_type_in", - "nullable": true, - "items": { - "type": "string", - "description": "Values list for multi-value rules like monitor_type_in" - } + "description": "Monitor name" } }, - "description": "Match rules to evaluate (all must pass; omit or empty for catch-all)" + "description": "Monitors that reference this secret for authentication" }, - "MattermostChannelConfig": { - "required": [ - "channelType", - "webhookUrl" - ], + "MonitorRunListParams": { "type": "object", "properties": { - "channelType": { + "phase": { "type": "string", - "enum": [ - "mattermost" - ] + "description": "Filter by run phase; omit to return every phase", + "nullable": true }, - "webhookUrl": { - "minLength": 1, + "outcome": { "type": "string", - "description": "Mattermost incoming webhook URL" + "description": "Filter by persist outcome; omit to return every outcome", + "nullable": true }, - "channel": { + "region": { "type": "string", - "description": "Override channel (if webhook allows)", + "description": "Filter by probe region", "nullable": true }, - "iconUrl": { + "source": { "type": "string", - "description": "Custom bot icon URL", + "description": "Filter by what triggered the run", "nullable": true - } - } - }, - "McpConnectsAssertion": { - "type": "object", - "properties": { - "type": { + }, + "q": { "type": "string", - "enum": [ - "mcp_connects" - ] + "description": "Substring match on headline", + "nullable": true + }, + "cursor": { + "type": "string", + "description": "Opaque cursor from a previous page", + "nullable": true + }, + "limit": { + "maximum": 100, + "minimum": 1, + "type": "integer", + "description": "Page size (1–100, default 25)", + "format": "int32" } }, "required": [ - "type" + "limit" ] }, - "McpHasCapabilityAssertion": { + "MonitorSecretRequestsDto": { "required": [ - "type", - "capability" + "environment", + "requests" ], "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "mcp_has_capability" - ] + "environment": { + "$ref": "#/components/schemas/EnvironmentDto" }, - "capability": { - "minLength": 1, - "type": "string", - "description": "Capability name the server must advertise, e.g. tools or resources" + "requests": { + "type": "array", + "description": "Secret keys this monitor requires and their resolve state", + "items": { + "$ref": "#/components/schemas/SecretRequestDto" + } } - } + }, + "description": "Environment and secret keys this monitor requires" }, - "McpMinToolsAssertion": { + "MonitorSessionDto": { + "required": [ + "cookieNames", + "lifecycle", + "reusePolicy", + "setupFile", + "storageKeys" + ], "type": "object", "properties": { - "type": { + "lifecycle": { "type": "string", + "description": "Current session cache state", "enum": [ - "mcp_min_tools" + "active", + "expired", + "failed", + "revoked" ] }, - "min": { - "type": "integer", - "description": "Minimum number of tools the server must expose", - "format": "int32" - } - }, - "required": [ - "type", - "min" - ] - }, - "McpProtocolVersionAssertion": { - "required": [ - "type", - "version" - ], - "type": "object", - "properties": { - "type": { + "reusePolicy": { "type": "string", + "description": "When the cached session is reused across runs", "enum": [ - "mcp_protocol_version" + "reuse", + "every_run", + "on_failure" ] }, - "version": { - "minLength": 1, + "setupFile": { "type": "string", - "description": "Expected MCP protocol version string from the server handshake" + "description": "Setup file path inside the package zip" + }, + "expiresAt": { + "type": "string", + "description": "When the cached session expires", + "format": "date-time", + "nullable": true + }, + "cookieNames": { + "type": "array", + "description": "Cookie names in the cached session", + "items": { + "type": "string", + "description": "Cookie names in the cached session" + } + }, + "storageKeys": { + "type": "array", + "description": "Storage key names in the cached session", + "items": { + "type": "string", + "description": "Storage key names in the cached session" + } + }, + "sizeBytes": { + "type": "integer", + "description": "Cached session size in bytes", + "format": "int32", + "nullable": true + }, + "lastRejectedRunId": { + "type": "string", + "description": "Run that last rejected this cache", + "format": "uuid", + "nullable": true } - } + }, + "description": "Cached sign-in session for a monitor" }, - "McpResponseTimeAssertion": { + "MonitorsSummaryDto": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "mcp_response_time" - ] + "total": { + "type": "integer", + "description": "Total number of monitors in the organization", + "format": "int64" + }, + "up": { + "type": "integer", + "description": "Number of monitors currently passing", + "format": "int64" + }, + "down": { + "type": "integer", + "description": "Number of monitors currently failing (DOWN severity)", + "format": "int64" }, - "maxMs": { + "degraded": { "type": "integer", - "description": "Maximum allowed MCP check duration in milliseconds", - "format": "int32" + "description": "Number of monitors with degraded status", + "format": "int64" + }, + "paused": { + "type": "integer", + "description": "Number of disabled monitors", + "format": "int64" + }, + "avgUptime24h": { + "type": "number", + "description": "Average uptime percentage across all monitors over last 24h", + "format": "double", + "nullable": true + }, + "avgUptime30d": { + "type": "number", + "description": "Average uptime percentage across all monitors over last 30 days", + "format": "double", + "nullable": true } }, + "description": "Dashboard summary counters for monitors", "required": [ - "type", - "maxMs" + "total", + "up", + "down", + "degraded", + "paused" ] }, - "McpResponseTimeWarnAssertion": { + "MonitorTestRequest": { + "required": [ + "config", + "type" + ], "type": "object", "properties": { "type": { "type": "string", + "description": "Monitor protocol type to test", "enum": [ - "mcp_response_time_warn" + "HTTP", + "DNS", + "MCP_SERVER", + "TCP", + "ICMP", + "HEARTBEAT", + "BROWSER", + "MULTI_STEP_API" ] }, - "warnMs": { - "type": "integer", - "description": "MCP check duration in milliseconds that triggers a warning only", - "format": "int32" + "config": { + "oneOf": [ + { + "$ref": "#/components/schemas/DnsMonitorConfig" + }, + { + "$ref": "#/components/schemas/HeartbeatMonitorConfig" + }, + { + "$ref": "#/components/schemas/HttpMonitorConfig" + }, + { + "$ref": "#/components/schemas/IcmpMonitorConfig" + }, + { + "$ref": "#/components/schemas/McpServerMonitorConfig" + }, + { + "$ref": "#/components/schemas/ScriptMonitorConfig" + }, + { + "$ref": "#/components/schemas/TcpMonitorConfig" + } + ] + }, + "assertions": { + "type": "array", + "description": "Optional assertions to evaluate against the test result", + "nullable": true, + "items": { + "$ref": "#/components/schemas/CreateAssertionRequest" + } } - }, - "required": [ - "type", - "warnMs" - ] + } }, - "McpServer": { + "MonitorTestResultDto": { + "required": [ + "assertionResults", + "passed" + ], "type": "object", - "description": "MCP server check-type-specific details", "properties": { - "check_type": { - "type": "string", - "enum": [ - "mcp_server" - ] + "passed": { + "type": "boolean" }, - "url": { + "error": { "type": "string", - "description": "MCP server URL", "nullable": true }, - "protocolVersion": { - "type": "string", - "description": "MCP protocol version", + "statusCode": { + "type": "integer", + "format": "int32", "nullable": true }, - "serverInfo": { + "responseTimeMs": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "responseHeaders": { "type": "object", "additionalProperties": { - "type": "object", - "description": "MCP server info (name, version, etc.)", - "nullable": true + "type": "array", + "nullable": true, + "items": { + "type": "string", + "nullable": true + } }, - "description": "MCP server info (name, version, etc.)", "nullable": true }, - "toolCount": { - "type": "integer", - "description": "Number of tools exposed", - "format": "int32", + "bodyPreview": { + "type": "string", "nullable": true }, - "resourceCount": { + "responseSizeBytes": { "type": "integer", - "description": "Number of resources exposed", - "format": "int32", + "format": "int64", "nullable": true }, - "promptCount": { + "redirectCount": { "type": "integer", - "description": "Number of prompts exposed", "format": "int32", "nullable": true - } - }, - "required": [ - "check_type" - ] - }, - "McpServerMonitorConfig": { - "required": [ - "command" - ], - "type": "object", - "properties": { - "command": { - "minLength": 1, + }, + "finalUrl": { "type": "string", - "description": "Command to execute to start the MCP server" + "nullable": true }, - "args": { + "assertionResults": { "type": "array", - "description": "Command-line arguments for the MCP server process", - "nullable": true, "items": { - "type": "string", - "description": "Command-line arguments for the MCP server process", - "nullable": true + "$ref": "#/components/schemas/AssertionTestResultDto" } }, - "env": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "Environment variables to pass to the MCP server process", - "nullable": true - }, - "description": "Environment variables to pass to the MCP server process", - "nullable": true + "warnings": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } } } }, - "McpToolAvailableAssertion": { + "MonitorVersionDto": { "required": [ - "type", - "toolName" + "changedVia", + "createdAt", + "id", + "monitorId", + "snapshot", + "version" ], "type": "object", "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "mcp_tool_available" - ] + "description": "Unique version record identifier", + "format": "uuid" }, - "toolName": { - "minLength": 1, - "type": "string", - "description": "MCP tool name that must appear in the server's tool list" - } - } - }, - "McpToolCountChangedAssertion": { - "type": "object", - "properties": { - "type": { + "monitorId": { "type": "string", - "enum": [ - "mcp_tool_count_changed" - ] + "description": "Monitor this version belongs to", + "format": "uuid" }, - "expectedCount": { - "type": "integer", - "description": "Expected tool count; warns when the live count differs", - "format": "int32" - } - }, - "required": [ - "type", - "expectedCount" - ] - }, - "MemberDto": { - "required": [ - "createdAt", - "email", - "orgRole", - "status", - "userId" - ], - "type": "object", - "properties": { - "userId": { + "version": { "type": "integer", - "description": "User identifier of the member", + "description": "Monotonically increasing version number", "format": "int32" }, - "email": { - "type": "string", - "description": "Member email address" + "snapshot": { + "$ref": "#/components/schemas/MonitorDto" }, - "name": { - "type": "string", - "description": "Member display name; null if not set", + "changedById": { + "type": "integer", + "description": "User ID who made the change; null for automated changes", + "format": "int32", "nullable": true }, - "orgRole": { + "changedVia": { "type": "string", - "description": "Member role within this organization (OWNER, ADMIN, MEMBER)", + "description": "Change source (DASHBOARD, CLI, API)", "enum": [ - "OWNER", - "ADMIN", - "MEMBER" + "API", + "DASHBOARD", + "CLI", + "TERRAFORM" ] }, - "status": { + "changeSummary": { "type": "string", - "description": "Membership status (ACTIVE, PENDING, SUSPENDED)", - "enum": [ - "INVITED", - "ACTIVE", - "SUSPENDED", - "LEFT", - "REMOVED", - "DECLINED" - ] + "description": "Human-readable description of what changed", + "nullable": true }, "createdAt": { "type": "string", - "description": "Timestamp when the member was added to the organization", + "description": "Timestamp when this version was recorded", "format": "date-time" } }, - "description": "Organization member with role and status" + "description": "A point-in-time version snapshot of a monitor configuration" }, - "MemberRoleChangedMetadata": { + "NetworkRowDto": { "required": [ - "kind", - "oldRole", - "newRole" + "curl", + "id", + "method", + "requestBody", + "requestHeaders", + "resourceType", + "responseBody", + "responseHeaders", + "source", + "url", + "isNavigation", + "requestBodyTruncated", + "responseBodyTruncated" ], "type": "object", - "description": "Role transition recorded when an organization member's role changes.", "properties": { - "kind": { + "id": { + "minLength": 1, "type": "string", - "enum": [ - "member_role_changed" - ] + "description": "Stable row id from capture" }, - "oldRole": { + "stepId": { "type": "string", - "description": "Role the member held before the change", - "enum": [ - "OWNER", - "ADMIN", - "MEMBER" - ] + "description": "Step this request belonged to", + "nullable": true }, - "newRole": { - "type": "string", - "description": "Role the member holds after the change", - "enum": [ - "OWNER", - "ADMIN", - "MEMBER" - ] - } - } - }, - "MonitorAssertionDto": { - "required": [ - "assertionType", - "config", - "id", - "monitorId", - "severity" - ], - "type": "object", - "properties": { - "id": { + "source": { + "minLength": 1, "type": "string", - "format": "uuid" + "description": "page for browser, request for API_CHECK" }, - "monitorId": { + "method": { + "minLength": 1, "type": "string", - "format": "uuid" + "description": "HTTP method" }, - "assertionType": { + "url": { + "minLength": 1, "type": "string", - "enum": [ - "status_code", - "response_time", - "body_contains", - "json_path", - "header_value", - "regex_body", - "dns_resolves", - "dns_response_time", - "dns_expected_ips", - "dns_expected_cname", - "dns_record_contains", - "dns_record_equals", - "dns_txt_contains", - "dns_min_answers", - "dns_max_answers", - "dns_response_time_warn", - "dns_ttl_low", - "dns_ttl_high", - "mcp_connects", - "mcp_response_time", - "mcp_has_capability", - "mcp_tool_available", - "mcp_min_tools", - "mcp_protocol_version", - "mcp_response_time_warn", - "mcp_tool_count_changed", - "ssl_expiry", - "response_size", - "redirect_count", - "redirect_target", - "response_time_warn", - "tcp_connects", - "tcp_response_time", - "tcp_response_time_warn", - "icmp_reachable", - "icmp_response_time", - "icmp_response_time_warn", - "icmp_packet_loss", - "heartbeat_received", - "heartbeat_max_interval", - "heartbeat_interval_drift", - "heartbeat_payload_contains" - ] + "description": "Request URL" }, - "config": { - "oneOf": [ - { - "$ref": "#/components/schemas/BodyContainsAssertion" - }, - { - "$ref": "#/components/schemas/DnsExpectedCnameAssertion" - }, - { - "$ref": "#/components/schemas/DnsExpectedIpsAssertion" - }, - { - "$ref": "#/components/schemas/DnsMaxAnswersAssertion" - }, - { - "$ref": "#/components/schemas/DnsMinAnswersAssertion" - }, - { - "$ref": "#/components/schemas/DnsRecordContainsAssertion" - }, - { - "$ref": "#/components/schemas/DnsRecordEqualsAssertion" - }, - { - "$ref": "#/components/schemas/DnsResolvesAssertion" - }, - { - "$ref": "#/components/schemas/DnsResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/DnsResponseTimeWarnAssertion" - }, - { - "$ref": "#/components/schemas/DnsTtlHighAssertion" - }, - { - "$ref": "#/components/schemas/DnsTtlLowAssertion" - }, - { - "$ref": "#/components/schemas/DnsTxtContainsAssertion" - }, - { - "$ref": "#/components/schemas/HeaderValueAssertion" - }, - { - "$ref": "#/components/schemas/HeartbeatIntervalDriftAssertion" - }, - { - "$ref": "#/components/schemas/HeartbeatMaxIntervalAssertion" - }, - { - "$ref": "#/components/schemas/HeartbeatPayloadContainsAssertion" - }, - { - "$ref": "#/components/schemas/HeartbeatReceivedAssertion" - }, - { - "$ref": "#/components/schemas/IcmpPacketLossAssertion" - }, - { - "$ref": "#/components/schemas/IcmpReachableAssertion" - }, - { - "$ref": "#/components/schemas/IcmpResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/IcmpResponseTimeWarnAssertion" - }, - { - "$ref": "#/components/schemas/JsonPathAssertion" - }, - { - "$ref": "#/components/schemas/McpConnectsAssertion" - }, - { - "$ref": "#/components/schemas/McpHasCapabilityAssertion" - }, - { - "$ref": "#/components/schemas/McpMinToolsAssertion" - }, - { - "$ref": "#/components/schemas/McpProtocolVersionAssertion" - }, - { - "$ref": "#/components/schemas/McpResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/McpResponseTimeWarnAssertion" - }, - { - "$ref": "#/components/schemas/McpToolAvailableAssertion" - }, - { - "$ref": "#/components/schemas/McpToolCountChangedAssertion" - }, - { - "$ref": "#/components/schemas/RedirectCountAssertion" - }, - { - "$ref": "#/components/schemas/RedirectTargetAssertion" - }, - { - "$ref": "#/components/schemas/RegexBodyAssertion" - }, - { - "$ref": "#/components/schemas/ResponseSizeAssertion" - }, - { - "$ref": "#/components/schemas/ResponseTimeAssertion" - }, - { - "$ref": "#/components/schemas/ResponseTimeWarnAssertion" - }, - { - "$ref": "#/components/schemas/SslExpiryAssertion" - }, - { - "$ref": "#/components/schemas/StatusCodeAssertion" - }, - { - "$ref": "#/components/schemas/TcpConnectsAssertion" - }, - { - "$ref": "#/components/schemas/TcpResponseTimeAssertion" - }, + "resourceType": { + "minLength": 1, + "type": "string", + "description": "Chromium type, or api for the request fixture" + }, + "isNavigation": { + "type": "boolean", + "description": "Whether this request started a navigation" + }, + "status": { + "type": "integer", + "description": "HTTP status; null while pending", + "format": "int32", + "nullable": true + }, + "durationMs": { + "type": "integer", + "description": "Request duration in milliseconds", + "format": "int32", + "nullable": true + }, + "encodedBodySize": { + "type": "integer", + "description": "Encoded response body size in bytes", + "format": "int32", + "nullable": true + }, + "startedOffsetMs": { + "type": "integer", + "description": "Offset from case start for the waterfall bar", + "format": "int32", + "nullable": true + }, + "failure": { + "type": "string", + "description": "Transport or protocol failure", + "nullable": true + }, + "redirectedFromUrl": { + "type": "string", + "description": "URL this request redirected from", + "nullable": true + }, + "timing": { + "nullable": true, + "allOf": [ { - "$ref": "#/components/schemas/TcpResponseTimeWarnAssertion" + "$ref": "#/components/schemas/NetworkTimingDto" } ] }, - "severity": { + "requestHeaders": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Redacted request headers" + }, + "description": "Redacted request headers" + }, + "responseHeaders": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Redacted response headers" + }, + "description": "Redacted response headers" + }, + "requestBody": { "type": "string", - "enum": [ - "fail", - "warn" - ] + "description": "Request body preview, truncated at 256 KiB" + }, + "responseBody": { + "type": "string", + "description": "Response body preview, truncated at 256 KiB" + }, + "requestBodyTruncated": { + "type": "boolean", + "description": "Whether requestBody was truncated" + }, + "responseBodyTruncated": { + "type": "boolean", + "description": "Whether responseBody was truncated" + }, + "curl": { + "minLength": 1, + "type": "string", + "description": "Copy-as-cURL from the redacted record" + }, + "traceActionIndex": { + "type": "integer", + "description": "Playwright trace action index; null on API_CHECK", + "format": "int32", + "nullable": true } - } + }, + "description": "One waterfall request row" }, - "MonitorAuthConfig": { - "description": "New authentication configuration (full replacement)", - "discriminator": { - "propertyName": "type", - "mapping": { - "bearer": "#/components/schemas/BearerAuthConfig", - "basic": "#/components/schemas/BasicAuthConfig", - "header": "#/components/schemas/HeaderAuthConfig", - "api_key": "#/components/schemas/ApiKeyAuthConfig" + "NetworkTimingDto": { + "type": "object", + "properties": { + "dnsMs": { + "type": "integer", + "description": "DNS lookup time in milliseconds", + "format": "int32", + "nullable": true + }, + "connectMs": { + "type": "integer", + "description": "TCP connect time in milliseconds", + "format": "int32", + "nullable": true + }, + "tlsMs": { + "type": "integer", + "description": "TLS handshake time in milliseconds", + "format": "int32", + "nullable": true + }, + "waitingMs": { + "type": "integer", + "description": "Time to first byte in milliseconds", + "format": "int32", + "nullable": true + }, + "transferMs": { + "type": "integer", + "description": "Response transfer time in milliseconds", + "format": "int32", + "nullable": true } }, - "oneOf": [ - { - "$ref": "#/components/schemas/BearerAuthConfig" + "description": "Request timing phases in milliseconds" + }, + "NewTagRequest": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 100, + "minLength": 0, + "type": "string", + "description": "Tag name" }, - { - "$ref": "#/components/schemas/BasicAuthConfig" + "color": { + "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", + "type": "string", + "description": "Hex color code (defaults to #6B7280 if omitted)", + "nullable": true + } + }, + "description": "Inline tag creation — creates the tag if it does not already exist" + }, + "NoSlaContext": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "Reason no SLA is published", + "nullable": true }, - { - "$ref": "#/components/schemas/HeaderAuthConfig" + "historicalClaim": { + "type": "string", + "description": "Non-binding historical uptime claim", + "nullable": true }, - { - "$ref": "#/components/schemas/ApiKeyAuthConfig" + "supportSla": { + "type": "string", + "description": "Support response time SLA if different from uptime SLA", + "nullable": true + }, + "enterpriseNote": { + "type": "string", + "description": "Note about enterprise/custom SLA availability", + "nullable": true } - ] + }, + "description": "Context for vendors with no public SLA" }, - "MonitorAuthDto": { + "NotificationDispatchDto": { "required": [ - "authType", - "config", + "createdAt", + "deliveries", "id", - "monitorId" + "incidentId", + "policyId", + "status", + "updatedAt", + "currentStep" ], "type": "object", "properties": { "id": { "type": "string", + "description": "Unique dispatch record identifier", "format": "uuid" }, - "monitorId": { + "incidentId": { "type": "string", + "description": "Incident this dispatch is for", "format": "uuid" }, - "authType": { + "incidentTitle": { + "type": "string", + "description": "Incident title at read time; null if untitled or missing", + "nullable": true + }, + "policyId": { + "type": "string", + "description": "Notification policy that matched this incident", + "format": "uuid" + }, + "policyName": { + "type": "string", + "description": "Human-readable name of the matched policy (null if policy has been deleted)", + "nullable": true + }, + "status": { "type": "string", + "description": "Current dispatch state", "enum": [ - "bearer", - "basic", - "header", - "api_key" + "PENDING", + "DISPATCHING", + "DELIVERED", + "ESCALATING", + "ACKNOWLEDGED", + "COMPLETED" ] }, - "config": { - "oneOf": [ - { - "$ref": "#/components/schemas/ApiKeyAuthConfig" - }, - { - "$ref": "#/components/schemas/BasicAuthConfig" - }, - { - "$ref": "#/components/schemas/BearerAuthConfig" - }, - { - "$ref": "#/components/schemas/HeaderAuthConfig" - } + "completionReason": { + "type": "string", + "description": "Why the dispatch reached COMPLETED: EXHAUSTED (all steps ran, no ack), RESOLVED (incident resolved), NO_STEPS (policy had no steps). Null for non-terminal states.", + "nullable": true, + "enum": [ + "EXHAUSTED", + "RESOLVED", + "NO_STEPS" ] + }, + "currentStep": { + "type": "integer", + "description": "1-based index of the currently active escalation step", + "format": "int32" + }, + "totalSteps": { + "type": "integer", + "description": "Total number of escalation steps in the policy (null if policy has been deleted)", + "format": "int32", + "nullable": true + }, + "acknowledgedAt": { + "type": "string", + "description": "Timestamp when this dispatch was acknowledged (null if not acknowledged)", + "format": "date-time", + "nullable": true + }, + "acknowledgedBy": { + "type": "string", + "description": "Actor who acknowledged this dispatch (user email, api-key:, voice:, etc.); null if not acknowledged", + "nullable": true + }, + "acknowledgedVia": { + "type": "string", + "description": "Channel used to acknowledge (DASHBOARD, API, PHONE_CALL, INTERNAL, etc.); null if not acknowledged", + "nullable": true + }, + "matchedRules": { + "type": "array", + "description": "Labels of match rules that caused this dispatch (same wording as TestMatchResult); null on pre-V138 rows; catch-all is [\"(catch-all: no rules defined)\"]", + "nullable": true, + "items": { + "type": "string", + "description": "Labels of match rules that caused this dispatch (same wording as TestMatchResult); null on pre-V138 rows; catch-all is [\"(catch-all: no rules defined)\"]" + } + }, + "nextEscalationAt": { + "type": "string", + "description": "Timestamp when the next escalation step will fire (null if not scheduled)", + "format": "date-time", + "nullable": true + }, + "lastNotifiedAt": { + "type": "string", + "description": "Timestamp of the most recent notification delivery", + "format": "date-time", + "nullable": true + }, + "deliveries": { + "type": "array", + "description": "Delivery records for all channels associated with this dispatch", + "items": { + "$ref": "#/components/schemas/AlertDeliveryDto" + } + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the dispatch was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "Timestamp when the dispatch was last updated", + "format": "date-time" } - } + }, + "description": "Dispatch state for a single (incident, notification policy) pair, with delivery history" }, - "MonitorDto": { + "NotificationDto": { "required": [ - "config", "createdAt", + "title", + "type", "id", - "managedBy", + "read" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique notification identifier", + "format": "int64" + }, + "type": { + "type": "string", + "description": "Notification category (e.g. incident, monitor, team)" + }, + "title": { + "type": "string", + "description": "Short notification title" + }, + "body": { + "type": "string", + "description": "Full notification body; null for title-only notifications", + "nullable": true + }, + "resourceType": { + "type": "string", + "description": "Type of the resource this notification is about", + "nullable": true + }, + "resourceId": { + "type": "string", + "description": "ID of the resource this notification is about", + "nullable": true + }, + "read": { + "type": "boolean", + "description": "Whether the notification has been read" + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the notification was created", + "format": "date-time" + } + }, + "description": "In-app notification for the current user" + }, + "NotificationPolicyDto": { + "required": [ + "createdAt", + "escalation", + "id", + "matchRules", "name", - "regions", - "type", "updatedAt", "organizationId", - "frequencySeconds", - "enabled" + "enabled", + "priority" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Unique monitor identifier", + "description": "Unique notification policy identifier", "format": "uuid" }, "organizationId": { "type": "integer", - "description": "Organization this monitor belongs to", + "description": "Organization this policy belongs to", "format": "int32" }, "name": { "minLength": 1, "type": "string", - "description": "Human-readable name for this monitor" + "description": "Human-readable name for this policy" }, - "type": { + "description": { "type": "string", - "enum": [ - "HTTP", - "DNS", - "MCP_SERVER", - "TCP", - "ICMP", - "HEARTBEAT", - "BROWSER", - "MULTI_STEP_API" - ] + "description": "Optional note; null when unset", + "nullable": true }, - "config": { - "oneOf": [ - { - "$ref": "#/components/schemas/DnsMonitorConfig" - }, - { - "$ref": "#/components/schemas/HeartbeatMonitorConfig" - }, - { - "$ref": "#/components/schemas/HttpMonitorConfig" - }, - { - "$ref": "#/components/schemas/IcmpMonitorConfig" - }, - { - "$ref": "#/components/schemas/McpServerMonitorConfig" - }, + "matchRules": { + "type": "array", + "description": "Match rules (all must pass; empty = catch-all)", + "items": { + "$ref": "#/components/schemas/MatchRule" + } + }, + "escalation": { + "$ref": "#/components/schemas/EscalationChain" + }, + "enabled": { + "type": "boolean", + "description": "Whether this policy is active" + }, + "priority": { + "type": "integer", + "description": "Evaluation order; higher value = evaluated first", + "format": "int32" + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the policy was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "Timestamp when the policy was last updated", + "format": "date-time" + }, + "stats7d": { + "nullable": true, + "allOf": [ { - "$ref": "#/components/schemas/ScriptMonitorConfig" - }, + "$ref": "#/components/schemas/NotificationPolicyWindowStatsDto" + } + ] + }, + "stats30d": { + "nullable": true, + "allOf": [ { - "$ref": "#/components/schemas/TcpMonitorConfig" + "$ref": "#/components/schemas/NotificationPolicyWindowStatsDto" } ] }, - "frequencySeconds": { - "type": "integer", - "description": "Check frequency in seconds (30–86400)", - "format": "int32" + "lastFiredAt": { + "type": "string", + "description": "Created-at of the most recent dispatch for this policy; null if never fired", + "format": "date-time", + "nullable": true + }, + "lastFiredIncidentId": { + "type": "string", + "description": "Incident id of the most recent dispatch; null if never fired", + "format": "uuid", + "nullable": true + } + }, + "description": "Org-level notification policy with match rules and escalation chain" + }, + "NotificationPolicyWindowStatsDto": { + "required": [ + "ackableFires", + "acknowledgements", + "expired", + "failedSends", + "fires", + "sends" + ], + "type": "object", + "properties": { + "fires": { + "type": "integer", + "description": "Dispatches created in the window", + "format": "int32" + }, + "acknowledgements": { + "type": "integer", + "description": "Fires in the window that were acknowledged", + "format": "int32" + }, + "ackableFires": { + "type": "integer", + "description": "Ack ratio denominator: fires when the policy has an ack gate, else 0", + "format": "int32" + }, + "expired": { + "type": "integer", + "description": "Fires that exhausted escalation without acknowledgment", + "format": "int32" + }, + "sends": { + "type": "integer", + "description": "Alert deliveries linked to fires in the window", + "format": "int32" + }, + "failedSends": { + "type": "integer", + "description": "Linked deliveries with status FAILED", + "format": "int32" + }, + "medianAckSeconds": { + "type": "integer", + "description": "Median seconds from fire to ack among acknowledged fires; null when none", + "format": "int64", + "nullable": true + }, + "deepestStepReached": { + "type": "integer", + "description": "Highest escalation step reached in the window; null when no fires", + "format": "int32", + "nullable": true + }, + "lastFiredAt": { + "type": "string", + "description": "Created-at of the most recent fire in the window; null when none", + "format": "date-time", + "nullable": true + }, + "lastFiredIncidentId": { + "type": "string", + "description": "Incident id of the most recent fire in the window; null when none", + "format": "uuid", + "nullable": true + } + }, + "description": "Time-bounded notification policy activity aggregates" + }, + "OfficialSla": { + "type": "object", + "properties": { + "percentage": { + "type": "string", + "description": "Advertised uptime percentage, e.g. '99.99%'", + "nullable": true + }, + "scope": { + "type": "string", + "description": "Scope of the SLA, e.g. 'Monthly uptime per region'", + "nullable": true }, - "enabled": { - "type": "boolean", - "description": "Whether the monitor is active" + "measurement": { + "type": "string", + "description": "How the vendor measures uptime for SLA purposes", + "nullable": true }, - "regions": { + "exclusions": { + "type": "string", + "description": "Summary of exclusions from SLA calculation", + "nullable": true + }, + "appliesToPlans": { "type": "array", - "description": "Probe regions where checks are executed", + "description": "Plan names this SLA applies to, e.g. ['Enterprise']", + "nullable": true, "items": { "type": "string", - "description": "Probe regions where checks are executed" + "description": "Plan names this SLA applies to, e.g. ['Enterprise']" } }, - "managedBy": { + "notCovered": { + "type": "string", + "description": "Services/components NOT covered by the SLA", + "nullable": true + } + }, + "description": "The vendor's officially advertised SLA commitment" + }, + "OpsGenieChannelConfig": { + "required": [ + "channelType", + "apiKey" + ], + "type": "object", + "properties": { + "channelType": { "type": "string", - "description": "Source that created/owns this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API", "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" + "opsgenie" ] }, - "createdAt": { + "apiKey": { + "minLength": 1, "type": "string", - "description": "Timestamp when the monitor was created", - "format": "date-time" + "description": "OpsGenie API key for alert creation" }, - "updatedAt": { + "region": { "type": "string", - "description": "Timestamp when the monitor was last updated", - "format": "date-time" + "description": "OpsGenie API region: us or eu", + "nullable": true + } + } + }, + "OrganizationDto": { + "required": [ + "email", + "name", + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique organization identifier", + "format": "int32" }, - "assertions": { - "type": "array", - "description": "Assertions evaluated against each check result; null on list responses", - "nullable": true, - "items": { - "$ref": "#/components/schemas/MonitorAssertionDto" - } + "name": { + "type": "string", + "description": "Organization name" }, - "tags": { - "type": "array", - "description": "Tags applied to this monitor", - "nullable": true, - "items": { - "$ref": "#/components/schemas/TagDto" - } + "email": { + "type": "string", + "description": "Billing and contact email", + "nullable": true }, - "pingUrl": { + "size": { "type": "string", - "description": "Heartbeat ping URL; populated for HEARTBEAT monitors only", + "description": "Team size range (e.g. 1-10, 11-50)", "nullable": true }, - "environment": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/Summary" - } - ] + "industry": { + "type": "string", + "description": "Industry vertical (e.g. SaaS, Fintech)", + "nullable": true }, - "auth": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/MonitorAuthConfig" - } - ] + "websiteUrl": { + "type": "string", + "description": "Organization website URL", + "nullable": true + } + }, + "description": "Organization account details" + }, + "OrgIncidentAnnotationDto": { + "required": [ + "incidentId", + "severity", + "status", + "alerted" + ], + "type": "object", + "properties": { + "incidentId": { + "type": "string", + "description": "Internal org incident ID", + "format": "uuid" }, - "incidentPolicy": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/IncidentPolicyDto" - } - ] + "displayKey": { + "type": "string", + "description": "Human display key (e.g. DEV-42); null until platform INC codes ship", + "nullable": true }, - "alertChannelIds": { - "type": "array", - "description": "Alert channel IDs linked to this monitor; populated on single-monitor responses", - "nullable": true, - "items": { - "type": "string", - "description": "Alert channel IDs linked to this monitor; populated on single-monitor responses", - "format": "uuid" - } + "status": { + "type": "string", + "description": "Internal incident lifecycle status", + "enum": [ + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" + ] }, - "currentStatus": { + "severity": { "type": "string", - "description": "Current operational state — UP, DOWN, DEGRADED, PAUSED, or UNKNOWN if no probe data yet", - "nullable": true, + "description": "Internal incident severity", "enum": [ - "up", - "degraded", - "down", - "paused", - "unknown" + "DOWN", + "DEGRADED", + "MAINTENANCE" ] + }, + "alerted": { + "type": "boolean", + "description": "Whether alert channels were eligible to fire (false for AWARENESS silent tracking)" + }, + "startedAt": { + "type": "string", + "description": "When the internal incident started", + "format": "date-time", + "nullable": true } }, - "description": "Full monitor representation" + "description": "Linked internal incident annotation on a vendor status-event row" }, - "MonitorReference": { + "OrgInfo": { "required": [ - "id", - "name" + "name", + "id" ], "type": "object", "properties": { "id": { - "type": "string", - "description": "Monitor identifier", - "format": "uuid" + "type": "integer", + "description": "Organization ID", + "format": "int32" }, "name": { "type": "string", - "description": "Monitor name" + "description": "Organization name" } }, - "description": "Monitors that reference this secret; null on create/update responses" + "description": "Organization the key belongs to" }, - "MonitorsSummaryDto": { + "PackageUploadDto": { + "required": [ + "expiresAt", + "putUrl", + "requiredHeaders" + ], "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of monitors in the organization", - "format": "int64" - }, - "up": { - "type": "integer", - "description": "Number of monitors currently passing", - "format": "int64" + "putUrl": { + "minLength": 1, + "type": "string", + "description": "Presigned PUT URL for the zip bytes" }, - "down": { - "type": "integer", - "description": "Number of monitors currently failing (DOWN severity)", - "format": "int64" + "expiresAt": { + "type": "string", + "description": "When the signed URL expires", + "format": "date-time" }, - "degraded": { + "requiredHeaders": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Must send Content-Type: application/zip and If-None-Match: *" + }, + "description": "Must send Content-Type: application/zip and If-None-Match: *" + } + }, + "description": "Signed package upload target" + }, + "Pageable": { + "type": "object", + "properties": { + "page": { + "minimum": 0, "type": "integer", - "description": "Number of monitors with degraded status", - "format": "int64" + "format": "int32" }, - "paused": { + "size": { + "minimum": 1, "type": "integer", - "description": "Number of disabled monitors", - "format": "int64" - }, - "avgUptime24h": { - "type": "number", - "description": "Average uptime percentage across all monitors over last 24h", - "format": "double", - "nullable": true + "format": "int32" }, - "avgUptime30d": { - "type": "number", - "description": "Average uptime percentage across all monitors over last 30 days", - "format": "double", - "nullable": true + "sort": { + "type": "array", + "items": { + "type": "string" + } } }, - "description": "Dashboard summary counters for monitors", "required": [ - "total", - "up", - "down", - "degraded", - "paused" + "page", + "size", + "sort" ] }, - "MonitorTestRequest": { + "PagerDutyChannelConfig": { "required": [ - "config", - "type" + "channelType", + "routingKey" ], "type": "object", "properties": { - "type": { + "channelType": { "type": "string", - "description": "Monitor protocol type to test", "enum": [ - "HTTP", - "DNS", - "MCP_SERVER", - "TCP", - "ICMP", - "HEARTBEAT", - "BROWSER", - "MULTI_STEP_API" + "pagerduty" ] }, - "config": { - "oneOf": [ - { - "$ref": "#/components/schemas/DnsMonitorConfig" - }, - { - "$ref": "#/components/schemas/HeartbeatMonitorConfig" - }, - { - "$ref": "#/components/schemas/HttpMonitorConfig" - }, - { - "$ref": "#/components/schemas/IcmpMonitorConfig" - }, - { - "$ref": "#/components/schemas/McpServerMonitorConfig" - }, - { - "$ref": "#/components/schemas/ScriptMonitorConfig" - }, - { - "$ref": "#/components/schemas/TcpMonitorConfig" - } - ] + "routingKey": { + "minLength": 1, + "type": "string", + "description": "PagerDuty Events API v2 routing (integration) key" }, - "assertions": { - "type": "array", - "description": "Optional assertions to evaluate against the test result", - "nullable": true, - "items": { - "$ref": "#/components/schemas/CreateAssertionRequest" - } + "severityOverride": { + "type": "string", + "description": "Override PagerDuty severity mapping", + "nullable": true } } }, - "MonitorTestResultDto": { - "required": [ - "assertionResults", - "passed" - ], + "PageSection": { "type": "object", "properties": { - "passed": { - "type": "boolean" - }, - "error": { + "groupId": { "type": "string", + "description": "Group ID when this section is a group", + "format": "uuid", "nullable": true }, - "statusCode": { - "type": "integer", - "format": "int32", + "componentId": { + "type": "string", + "description": "Component ID when this section is an ungrouped component", + "format": "uuid", "nullable": true }, - "responseTimeMs": { + "pageOrder": { "type": "integer", - "format": "int64", - "nullable": true - }, - "responseHeaders": { - "type": "object", - "additionalProperties": { - "type": "array", - "nullable": true, - "items": { - "type": "string", - "nullable": true - } - }, - "nullable": true + "description": "Position on the page (0-based)", + "format": "int32" + } + }, + "description": "A top-level page section (either a group or an ungrouped component)", + "required": [ + "pageOrder" + ] + }, + "PhoneCallChannelConfig": { + "type": "object", + "properties": { + "channelType": { + "type": "string", + "enum": [ + "phone_call" + ] }, - "bodyPreview": { + "phoneNumber": { "type": "string", + "description": "Recipient phone number in E.164 format, e.g. +14155550123", "nullable": true }, - "responseSizeBytes": { + "verifiedPhoneNumberId": { "type": "integer", + "description": "Id of an org verified_phone_number row; alternative to phoneNumber", "format": "int64", "nullable": true }, - "redirectCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "finalUrl": { - "type": "string", - "nullable": true - }, - "assertionResults": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AssertionTestResultDto" - } - }, - "warnings": { + "phoneNumbers": { "type": "array", + "description": "Deprecated: use phoneNumber. Accepted as a length-1 list for one release; ignored when phoneNumber or id is set", "nullable": true, "items": { - "type": "string" + "type": "string", + "description": "Deprecated: use phoneNumber. Accepted as a length-1 list for one release; ignored when phoneNumber or id is set", + "nullable": true } + }, + "voiceLanguage": { + "type": "string", + "description": "TTS voice language/locale (default: en-US). See VoiceLanguage for supported values", + "nullable": true + }, + "preferredLanguage": { + "type": "string", + "description": "Preferred language for TTS and notifications (BCP-47, e.g. en-US, de-DE). Alias for voiceLanguage", + "nullable": true } - } + }, + "required": [ + "channelType" + ] }, - "MonitorVersionDto": { + "PlanInfo": { "required": [ - "changedVia", - "createdAt", - "id", - "monitorId", - "snapshot", - "version" + "entitlements", + "tier", + "usage", + "trialActive" ], "type": "object", "properties": { - "id": { + "tier": { "type": "string", - "description": "Unique version record identifier", - "format": "uuid" + "description": "Resolved plan tier", + "enum": [ + "FREE", + "STARTER", + "PRO", + "TEAM", + "BUSINESS", + "ENTERPRISE" + ] }, - "monitorId": { + "subscriptionStatus": { "type": "string", - "description": "Monitor this version belongs to", - "format": "uuid" + "description": "Subscription status (null if no subscription)", + "nullable": true }, - "version": { - "type": "integer", - "description": "Monotonically increasing version number", - "format": "int32" + "trialActive": { + "type": "boolean", + "description": "Whether the org is on a trial" }, - "snapshot": { - "$ref": "#/components/schemas/MonitorDto" + "trialExpiresAt": { + "type": "string", + "description": "Trial expiry (null if not trialing)", + "format": "date-time", + "nullable": true + }, + "entitlements": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/EntitlementDto" + }, + "description": "Entitlement limits keyed by entitlement name" + }, + "usage": { + "type": "object", + "additionalProperties": { + "type": "integer", + "description": "Current usage counters keyed by entitlement name", + "format": "int64" + }, + "description": "Current usage counters keyed by entitlement name" + } + }, + "description": "Billing plan and entitlement state" + }, + "PolicySnapshotDto": { + "required": [ + "engineVersion", + "firstSeenAt", + "hashHex", + "lastSeenAt", + "policy" + ], + "type": "object", + "properties": { + "hashHex": { + "minLength": 1, + "type": "string", + "description": "Hex-encoded SHA-256 of the canonical policy JSON" }, - "changedById": { - "type": "integer", - "description": "User ID who made the change; null for automated changes", - "format": "int32", - "nullable": true + "policy": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Canonical policy document (snake_case, sorted keys)" + }, + "description": "Canonical policy document (snake_case, sorted keys)" }, - "changedVia": { + "engineVersion": { + "minLength": 1, "type": "string", - "description": "Change source (DASHBOARD, CLI, API)", - "enum": [ - "API", - "DASHBOARD", - "CLI", - "TERRAFORM" - ] + "description": "Detection engine version that observed this policy" }, - "changeSummary": { + "firstSeenAt": { "type": "string", - "description": "Human-readable description of what changed", - "nullable": true + "description": "First time the detection engine evaluated against this policy bytes", + "format": "date-time" }, - "createdAt": { + "lastSeenAt": { "type": "string", - "description": "Timestamp when this version was recorded", + "description": "Most recent time the engine evaluated against this policy bytes", "format": "date-time" } }, - "description": "A point-in-time version snapshot of a monitor configuration" + "description": "Policy snapshot used during this check (all evaluations of a single check are against one policy)", + "nullable": true }, - "NewTagRequest": { + "PollChartBucketDto": { "required": [ - "name" + "bucket", + "totalPolls" ], "type": "object", "properties": { - "name": { - "maxLength": 100, - "minLength": 0, + "bucket": { "type": "string", - "description": "Tag name" + "description": "Start of the time bucket (ISO 8601)", + "format": "date-time" }, - "color": { - "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", - "type": "string", - "description": "Hex color code (defaults to #6B7280 if omitted)", - "nullable": true + "uptimePercent": { + "type": "number", + "description": "Uptime percentage for this bucket; null when no data", + "format": "double", + "nullable": true, + "example": 100 + }, + "avgResponseTimeMs": { + "type": "number", + "description": "Average response time in milliseconds for this bucket", + "format": "double", + "nullable": true, + "example": 245.3 + }, + "totalPolls": { + "type": "integer", + "description": "Total polls in this bucket", + "format": "int64", + "example": 60 } }, - "description": "Inline tag creation — creates the tag if it does not already exist" + "description": "Aggregated poll metrics for a time bucket" }, - "NoSlaContext": { + "PricingTier": { + "required": [ + "name" + ], "type": "object", "properties": { - "reason": { - "type": "string", - "description": "Reason no SLA is published", - "nullable": true - }, - "historicalClaim": { + "name": { "type": "string", - "description": "Non-binding historical uptime claim", - "nullable": true + "description": "Tier name, e.g. 'Free', 'Pro', 'Enterprise'" }, - "supportSla": { + "slaPercentage": { "type": "string", - "description": "Support response time SLA if different from uptime SLA", + "description": "SLA percentage for this tier, e.g. '99.9%'", "nullable": true }, - "enterpriseNote": { + "priceFrom": { "type": "string", - "description": "Note about enterprise/custom SLA availability", + "description": "Starting price, e.g. '$0', '$25/mo', 'Custom'", "nullable": true } }, - "description": "Context for vendors with no public SLA" + "description": "Pricing tiers with associated SLA levels" }, - "NotificationDispatchDto": { + "PublishRevisionRequest": { "required": [ - "createdAt", - "deliveries", - "id", - "incidentId", - "policyId", - "status", - "updatedAt", - "currentStep" + "revisionId" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "Unique dispatch record identifier", - "format": "uuid" - }, - "incidentId": { - "type": "string", - "description": "Incident this dispatch is for", - "format": "uuid" - }, - "incidentTitle": { - "type": "string", - "description": "Incident title at read time; null if untitled or missing", - "nullable": true - }, - "policyId": { + "revisionId": { "type": "string", - "description": "Notification policy that matched this incident", + "description": "Existing revision to activate as Head for this monitor's environment", "format": "uuid" - }, - "policyName": { + } + } + }, + "PublishStatusPageIncidentRequest": { + "type": "object", + "properties": { + "title": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "Human-readable name of the matched policy (null if policy has been deleted)", + "description": "Customer-facing title; null keeps draft value", "nullable": true }, - "status": { + "impact": { "type": "string", - "description": "Current dispatch state", + "description": "Impact level; null keeps draft value", + "nullable": true, "enum": [ - "PENDING", - "DISPATCHING", - "DELIVERED", - "ESCALATING", - "ACKNOWLEDGED", - "COMPLETED" + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" ] }, - "completionReason": { + "status": { "type": "string", - "description": "Why the dispatch reached COMPLETED: EXHAUSTED (all steps ran, no ack), RESOLVED (incident resolved), NO_STEPS (policy had no steps). Null for non-terminal states.", + "description": "Incident status; null keeps draft value (must be an active status)", "nullable": true, "enum": [ - "EXHAUSTED", - "RESOLVED", - "NO_STEPS" + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" ] }, - "currentStep": { - "type": "integer", - "description": "1-based index of the currently active escalation step", - "format": "int32" - }, - "totalSteps": { - "type": "integer", - "description": "Total number of escalation steps in the policy (null if policy has been deleted)", - "format": "int32", - "nullable": true - }, - "acknowledgedAt": { - "type": "string", - "description": "Timestamp when this dispatch was acknowledged (null if not acknowledged)", - "format": "date-time", - "nullable": true - }, - "acknowledgedBy": { - "type": "string", - "description": "Actor who acknowledged this dispatch (user email, api-key:, voice:, etc.); null if not acknowledged", - "nullable": true - }, - "acknowledgedVia": { + "body": { "type": "string", - "description": "Channel used to acknowledge (DASHBOARD, API, PHONE_CALL, INTERNAL, etc.); null if not acknowledged", + "description": "Initial update body; null keeps draft value", "nullable": true }, - "matchedRules": { + "affectedComponents": { "type": "array", - "description": "Labels of match rules that caused this dispatch (same wording as TestMatchResult); null on pre-V138 rows; catch-all is [\"(catch-all: no rules defined)\"]", + "description": "Affected components; null keeps draft value", "nullable": true, "items": { - "type": "string", - "description": "Labels of match rules that caused this dispatch (same wording as TestMatchResult); null on pre-V138 rows; catch-all is [\"(catch-all: no rules defined)\"]" + "$ref": "#/components/schemas/AffectedComponent" } }, - "nextEscalationAt": { - "type": "string", - "description": "Timestamp when the next escalation step will fire (null if not scheduled)", - "format": "date-time", + "notifySubscribers": { + "type": "boolean", + "description": "Whether to notify subscribers (default: true)", "nullable": true - }, - "lastNotifiedAt": { + } + } + }, + "PushbulletChannelConfig": { + "required": [ + "channelType", + "accessToken" + ], + "type": "object", + "properties": { + "channelType": { "type": "string", - "description": "Timestamp of the most recent notification delivery", - "format": "date-time", - "nullable": true - }, - "deliveries": { - "type": "array", - "description": "Delivery records for all channels associated with this dispatch", - "items": { - "$ref": "#/components/schemas/AlertDeliveryDto" - } + "enum": [ + "pushbullet" + ] }, - "createdAt": { + "accessToken": { + "minLength": 1, "type": "string", - "description": "Timestamp when the dispatch was created", - "format": "date-time" + "description": "Pushbullet access token" }, - "updatedAt": { + "deviceIden": { "type": "string", - "description": "Timestamp when the dispatch was last updated", - "format": "date-time" + "description": "Target device identifier (broadcasts to all if empty)", + "nullable": true } - }, - "description": "Dispatch state for a single (incident, notification policy) pair, with delivery history" + } }, - "NotificationDto": { + "PushoverChannelConfig": { "required": [ - "createdAt", - "title", - "type", - "id", - "read" + "channelType", + "userKey", + "appToken" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Unique notification identifier", - "format": "int64" - }, - "type": { + "channelType": { "type": "string", - "description": "Notification category (e.g. incident, monitor, team)" + "enum": [ + "pushover" + ] }, - "title": { + "userKey": { + "minLength": 1, "type": "string", - "description": "Short notification title" + "description": "Pushover user or group key" }, - "body": { + "appToken": { + "minLength": 1, "type": "string", - "description": "Full notification body; null for title-only notifications", - "nullable": true + "description": "Pushover application API token" }, - "resourceType": { + "priority": { "type": "string", - "description": "Type of the resource this notification is about", + "description": "Notification priority override (-2 to 2)", "nullable": true }, - "resourceId": { + "sound": { "type": "string", - "description": "ID of the resource this notification is about", + "description": "Notification sound override", "nullable": true - }, - "read": { - "type": "boolean", - "description": "Whether the notification has been read" - }, - "createdAt": { - "type": "string", - "description": "Timestamp when the notification was created", - "format": "date-time" } - }, - "description": "In-app notification for the current user" + } }, - "NotificationPolicyDto": { + "QuarantineMonitorRequest": { "required": [ - "createdAt", - "escalation", - "id", - "matchRules", - "name", - "updatedAt", - "organizationId", - "enabled", - "priority" + "expiresAt", + "reason" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "Unique notification policy identifier", - "format": "uuid" - }, - "organizationId": { - "type": "integer", - "description": "Organization this policy belongs to", - "format": "int32" - }, - "name": { - "minLength": 1, - "type": "string", - "description": "Human-readable name for this policy" - }, - "description": { - "type": "string", - "description": "Optional note; null when unset", - "nullable": true - }, - "matchRules": { - "type": "array", - "description": "Match rules (all must pass; empty = catch-all)", - "items": { - "$ref": "#/components/schemas/MatchRule" - } - }, - "escalation": { - "$ref": "#/components/schemas/EscalationChain" - }, - "enabled": { - "type": "boolean", - "description": "Whether this policy is active" - }, - "priority": { - "type": "integer", - "description": "Evaluation order; higher value = evaluated first", - "format": "int32" - }, - "createdAt": { + "reason": { + "maxLength": 280, + "minLength": 0, "type": "string", - "description": "Timestamp when the policy was created", - "format": "date-time" + "description": "Reason for this hold (max 280)" }, - "updatedAt": { + "expiresAt": { "type": "string", - "description": "Timestamp when the policy was last updated", + "description": "When the hold expires", "format": "date-time" }, - "stats7d": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/NotificationPolicyWindowStatsDto" - } - ] - }, - "stats30d": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/NotificationPolicyWindowStatsDto" - } - ] - }, - "lastFiredAt": { - "type": "string", - "description": "Created-at of the most recent dispatch for this policy; null if never fired", - "format": "date-time", - "nullable": true - }, - "lastFiredIncidentId": { + "fromRunId": { "type": "string", - "description": "Incident id of the most recent dispatch; null if never fired", + "description": "Run that prompted this hold", "format": "uuid", "nullable": true } - }, - "description": "Org-level notification policy with match rules and escalation chain" + } }, - "NotificationPolicyWindowStatsDto": { - "required": [ - "ackableFires", - "acknowledgements", - "expired", - "failedSends", - "fires", - "sends" - ], + "RateLimitInfo": { "type": "object", "properties": { - "fires": { + "requestsPerMinute": { "type": "integer", - "description": "Dispatches created in the window", - "format": "int32" + "description": "Maximum requests allowed per window", + "format": "int64" }, - "acknowledgements": { + "remaining": { "type": "integer", - "description": "Fires in the window that were acknowledged", - "format": "int32" + "description": "Requests remaining in the current window", + "format": "int64" }, - "ackableFires": { + "windowMs": { "type": "integer", - "description": "Ack ratio denominator: fires when the policy has an ack gate, else 0", - "format": "int32" - }, - "expired": { + "description": "Sliding window size in milliseconds", + "format": "int64" + } + }, + "description": "Rate-limit quota for the current sliding window", + "required": [ + "requestsPerMinute", + "remaining", + "windowMs" + ] + }, + "RecoveryPolicy": { + "type": "object", + "properties": { + "consecutiveSuccesses": { "type": "integer", - "description": "Fires that exhausted escalation without acknowledgment", + "description": "Consecutive passing checks required to auto-resolve the incident", "format": "int32" }, - "sends": { + "minRegionsPassing": { "type": "integer", - "description": "Alert deliveries linked to fires in the window", + "description": "Minimum regions that must be passing before recovery can complete", "format": "int32" }, - "failedSends": { + "cooldownMinutes": { "type": "integer", - "description": "Linked deliveries with status FAILED", + "description": "Minutes after resolve before a new incident may open on the same monitor", "format": "int32" - }, - "medianAckSeconds": { - "type": "integer", - "description": "Median seconds from fire to ack among acknowledged fires; null when none", - "format": "int64", - "nullable": true - }, - "deepestStepReached": { - "type": "integer", - "description": "Highest escalation step reached in the window; null when no fires", - "format": "int32", - "nullable": true - }, - "lastFiredAt": { - "type": "string", - "description": "Created-at of the most recent fire in the window; null when none", - "format": "date-time", - "nullable": true - }, - "lastFiredIncidentId": { - "type": "string", - "description": "Incident id of the most recent fire in the window; null when none", - "format": "uuid", - "nullable": true } }, - "description": "Time-bounded notification policy activity aggregates" + "description": "Auto-recovery settings", + "required": [ + "consecutiveSuccesses", + "minRegionsPassing", + "cooldownMinutes" + ] }, - "OfficialSla": { + "RedirectCountAssertion": { + "required": [ + "type", + "maxCount" + ], "type": "object", "properties": { - "percentage": { - "type": "string", - "description": "Advertised uptime percentage, e.g. '99.99%'", - "nullable": true - }, - "scope": { - "type": "string", - "description": "Scope of the SLA, e.g. 'Monthly uptime per region'", - "nullable": true - }, - "measurement": { - "type": "string", - "description": "How the vendor measures uptime for SLA purposes", - "nullable": true - }, - "exclusions": { - "type": "string", - "description": "Summary of exclusions from SLA calculation", - "nullable": true - }, - "appliesToPlans": { - "type": "array", - "description": "Plan names this SLA applies to, e.g. ['Enterprise']", - "nullable": true, - "items": { - "type": "string", - "description": "Plan names this SLA applies to, e.g. ['Enterprise']" - } - }, - "notCovered": { + "type": { "type": "string", - "description": "Services/components NOT covered by the SLA", - "nullable": true + "enum": [ + "redirect_count" + ] + }, + "maxCount": { + "type": "integer", + "description": "Maximum number of HTTP redirects allowed before the check fails", + "format": "int32" } - }, - "description": "The vendor's officially advertised SLA commitment" + } }, - "OpsGenieChannelConfig": { + "RedirectTargetAssertion": { "required": [ - "channelType", - "apiKey" + "type", + "expected", + "operator" ], "type": "object", "properties": { - "channelType": { + "type": { "type": "string", "enum": [ - "opsgenie" + "redirect_target" ] }, - "apiKey": { + "expected": { "minLength": 1, "type": "string", - "description": "OpsGenie API key for alert creation" + "description": "Expected final URL after following redirects" }, - "region": { + "operator": { "type": "string", - "description": "OpsGenie API region: us or eu", - "nullable": true + "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", + "enum": [ + "equals", + "contains", + "less_than", + "greater_than", + "matches", + "range" + ] } } }, - "OrganizationDto": { + "RegexBodyAssertion": { "required": [ - "email", - "name", - "id" + "type", + "pattern" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Unique organization identifier", - "format": "int32" - }, - "name": { - "type": "string", - "description": "Organization name" - }, - "email": { - "type": "string", - "description": "Billing and contact email", - "nullable": true - }, - "size": { - "type": "string", - "description": "Team size range (e.g. 1-10, 11-50)", - "nullable": true - }, - "industry": { + "type": { "type": "string", - "description": "Industry vertical (e.g. SaaS, Fintech)", - "nullable": true + "enum": [ + "regex_body" + ] }, - "websiteUrl": { + "pattern": { + "minLength": 1, "type": "string", - "description": "Organization website URL", - "nullable": true + "description": "Regular expression the response body must match" } - }, - "description": "Organization account details" + } }, - "OrgIncidentAnnotationDto": { + "RegionStatusDto": { "required": [ - "incidentId", - "severity", - "status", - "alerted" + "region", + "timestamp", + "passed" ], "type": "object", "properties": { - "incidentId": { + "region": { "type": "string", - "description": "Internal org incident ID", - "format": "uuid" + "description": "Region identifier", + "example": "us-east" }, - "displayKey": { - "type": "string", - "description": "Human display key (e.g. DEV-42); null until platform INC codes ship", - "nullable": true + "passed": { + "type": "boolean", + "description": "Whether the last check in this region passed", + "example": true }, - "status": { - "type": "string", - "description": "Internal incident lifecycle status", - "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" - ] + "responseTimeMs": { + "type": "integer", + "description": "Response time in milliseconds for the last check", + "format": "int32", + "nullable": true, + "example": 95 }, - "severity": { + "timestamp": { "type": "string", - "description": "Internal incident severity", - "enum": [ - "DOWN", - "DEGRADED", - "MAINTENANCE" - ] - }, - "alerted": { - "type": "boolean", - "description": "Whether alert channels were eligible to fire (false for AWARENESS silent tracking)" + "description": "Timestamp of the last check in this region (ISO 8601)", + "format": "date-time" }, - "startedAt": { + "severityHint": { "type": "string", - "description": "When the internal incident started", - "format": "date-time", + "description": "Severity hint: 'down' for hard failures, 'degraded' for warn-only failures, null when passing", "nullable": true } }, - "description": "Linked internal incident annotation on a vendor status-event row" + "description": "Latest check result for a single region" }, - "OrgInfo": { + "RelatedIncidentsResponse": { "required": [ - "name", - "id" + "data", + "total" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Organization ID", - "format": "int32" + "data": { + "type": "array", + "description": "Related incident rows (newest first, capped by limit)", + "items": { + "$ref": "#/components/schemas/IncidentDto" + } }, - "name": { + "total": { + "type": "integer", + "description": "Total matching incidents in the window, excluding the current incident", + "format": "int64" + } + }, + "description": "Related incidents sharing the same origin within a time window" + }, + "RemapSecretRequest": { + "type": "object", + "properties": { + "secretId": { "type": "string", - "description": "Organization name" + "description": "Secret to attach; null restores name-match", + "format": "uuid", + "nullable": true } }, - "description": "Organization the key belongs to" + "description": "Attach or clear a remapped secret" }, - "Pageable": { + "RemoveMonitorTagsRequest": { + "required": [ + "tagIds" + ], "type": "object", "properties": { - "page": { - "minimum": 0, - "type": "integer", - "format": "int32" - }, - "size": { - "minimum": 1, - "type": "integer", - "format": "int32" - }, - "sort": { + "tagIds": { + "minItems": 1, "type": "array", + "description": "IDs of the tags to detach from the monitor", "items": { - "type": "string" + "type": "string", + "description": "IDs of the tags to detach from the monitor", + "format": "uuid" } } }, + "description": "Request body for removing tags from a monitor" + }, + "ReorderComponentsRequest": { "required": [ - "page", - "size", - "sort" - ] + "positions" + ], + "type": "object", + "properties": { + "positions": { + "minItems": 1, + "type": "array", + "description": "Ordered list of component IDs with their new positions", + "items": { + "$ref": "#/components/schemas/ComponentPosition" + } + } + }, + "description": "Batch component reorder request" }, - "PagerDutyChannelConfig": { + "ReorderPageLayoutRequest": { "required": [ - "channelType", - "routingKey" + "sections" ], "type": "object", "properties": { - "channelType": { - "type": "string", - "enum": [ - "pagerduty" - ] - }, - "routingKey": { - "minLength": 1, - "type": "string", - "description": "PagerDuty Events API v2 routing (integration) key" + "sections": { + "minItems": 1, + "type": "array", + "description": "Top-level sections in their new order", + "items": { + "$ref": "#/components/schemas/PageSection" + } }, - "severityOverride": { + "groupOrders": { + "type": "array", + "description": "Within-group component ordering; only needed for groups whose internal order changed", + "nullable": true, + "items": { + "$ref": "#/components/schemas/GroupComponentOrder" + } + } + }, + "description": "Reorder page-level layout: groups and ungrouped components share one ordering" + }, + "ResolveIncidentRequest": { + "type": "object", + "properties": { + "body": { "type": "string", - "description": "Override PagerDuty severity mapping", + "description": "Optional resolution message or post-mortem notes", "nullable": true } } }, - "PageSection": { + "ResourceGroupDeleteBlockerDto": { + "required": [ + "componentId", + "componentName", + "statusPageId", + "statusPageName", + "statusPageSlug" + ], "type": "object", "properties": { - "groupId": { + "statusPageId": { "type": "string", - "description": "Group ID when this section is a group", - "format": "uuid", - "nullable": true + "description": "Status page that owns the blocking component", + "format": "uuid" + }, + "statusPageName": { + "minLength": 1, + "type": "string", + "description": "Human-readable status page name" + }, + "statusPageSlug": { + "minLength": 1, + "type": "string", + "description": "URL-safe status page slug" }, "componentId": { "type": "string", - "description": "Component ID when this section is an ungrouped component", - "format": "uuid", - "nullable": true + "description": "Blocking GROUP-typed status page component ID", + "format": "uuid" }, - "pageOrder": { - "type": "integer", - "description": "Position on the page (0-based)", - "format": "int32" + "componentName": { + "minLength": 1, + "type": "string", + "description": "Blocking component display name" + }, + "hostname": { + "type": "string", + "description": "Public hostname when a custom domain is configured; null otherwise", + "nullable": true } }, - "description": "A top-level page section (either a group or an ungrouped component)", - "required": [ - "pageOrder" - ] + "description": "Status-page component that references this resource group (blocks delete; public exposure)" }, - "PhoneCallChannelConfig": { + "ResourceGroupDto": { + "required": [ + "createdAt", + "health", + "id", + "name", + "slug", + "updatedAt", + "organizationId", + "suppressMemberAlerts" + ], "type": "object", "properties": { - "channelType": { + "id": { "type": "string", - "enum": [ - "phone_call" - ] + "description": "Unique resource group identifier", + "format": "uuid" }, - "phoneNumber": { + "organizationId": { + "type": "integer", + "description": "Organization this group belongs to", + "format": "int32" + }, + "name": { + "minLength": 1, "type": "string", - "description": "Recipient phone number in E.164 format, e.g. +14155550123", + "description": "Human-readable group name" + }, + "slug": { + "minLength": 1, + "type": "string", + "description": "URL-safe group identifier" + }, + "description": { + "type": "string", + "description": "Optional group description", "nullable": true }, - "verifiedPhoneNumberId": { + "alertPolicyId": { + "type": "string", + "description": "Notification policy applied to this group", + "format": "uuid", + "nullable": true + }, + "defaultFrequency": { "type": "integer", - "description": "Id of an org verified_phone_number row; alternative to phoneNumber", - "format": "int64", + "description": "Default check frequency in seconds for member monitors", + "format": "int32", "nullable": true }, - "phoneNumbers": { + "defaultRegions": { "type": "array", - "description": "Deprecated: use phoneNumber. Accepted as a length-1 list for one release; ignored when phoneNumber or id is set", + "description": "Default regions for member monitors", "nullable": true, "items": { "type": "string", - "description": "Deprecated: use phoneNumber. Accepted as a length-1 list for one release; ignored when phoneNumber or id is set", - "nullable": true + "description": "Default regions for member monitors" } }, - "voiceLanguage": { - "type": "string", - "description": "TTS voice language/locale (default: en-US). See VoiceLanguage for supported values", - "nullable": true + "defaultRetryStrategy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/RetryStrategy" + } + ] }, - "preferredLanguage": { + "defaultAlertChannels": { + "type": "array", + "description": "Default alert channel IDs for member monitors", + "nullable": true, + "items": { + "type": "string", + "description": "Default alert channel IDs for member monitors", + "format": "uuid" + } + }, + "defaultEnvironmentId": { "type": "string", - "description": "Preferred language for TTS and notifications (BCP-47, e.g. en-US, de-DE). Alias for voiceLanguage", + "description": "Default environment ID for member monitors", + "format": "uuid", "nullable": true - } - }, - "required": [ - "channelType" - ] - }, - "PlanInfo": { - "required": [ - "entitlements", - "tier", - "usage", - "trialActive" - ], - "type": "object", - "properties": { - "tier": { + }, + "healthThresholdType": { "type": "string", - "description": "Resolved plan tier", + "description": "Health threshold type: COUNT or PERCENTAGE", + "nullable": true, "enum": [ - "FREE", - "STARTER", - "PRO", - "TEAM", - "BUSINESS", - "ENTERPRISE" + "COUNT", + "PERCENTAGE" ] }, - "subscriptionStatus": { - "type": "string", - "description": "Subscription status (null if no subscription)", + "healthThresholdValue": { + "type": "number", + "description": "Health threshold value", "nullable": true }, - "trialActive": { + "suppressMemberAlerts": { "type": "boolean", - "description": "Whether the org is on a trial" + "description": "When true, member-level incidents skip notification dispatch; only group alerts fire" }, - "trialExpiresAt": { - "type": "string", - "description": "Trial expiry (null if not trialing)", - "format": "date-time", + "confirmationDelaySeconds": { + "type": "integer", + "description": "Seconds to wait after health threshold breach before creating group incident", + "format": "int32", "nullable": true }, - "entitlements": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/EntitlementDto" - }, - "description": "Entitlement limits keyed by entitlement name" + "recoveryCooldownMinutes": { + "type": "integer", + "description": "Cooldown minutes after group incident resolves before a new one can open", + "format": "int32", + "nullable": true }, - "usage": { - "type": "object", - "additionalProperties": { - "type": "integer", - "description": "Current usage counters keyed by entitlement name", - "format": "int64" - }, - "description": "Current usage counters keyed by entitlement name" - } - }, - "description": "Billing plan and entitlement state" - }, - "PolicySnapshotDto": { - "required": [ - "engineVersion", - "firstSeenAt", - "hashHex", - "lastSeenAt", - "policy" - ], - "type": "object", - "properties": { - "hashHex": { - "minLength": 1, - "type": "string", - "description": "Hex-encoded SHA-256 of the canonical policy JSON" + "health": { + "$ref": "#/components/schemas/ResourceGroupHealthDto" }, - "policy": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Canonical policy document (snake_case, sorted keys)" - }, - "description": "Canonical policy document (snake_case, sorted keys)" + "members": { + "type": "array", + "description": "Member list with individual statuses; populated on detail GET only", + "nullable": true, + "items": { + "$ref": "#/components/schemas/ResourceGroupMemberDto" + } }, - "engineVersion": { - "minLength": 1, + "deleteBlockedBy": { + "type": "array", + "description": "Status-page GROUP components that reference this group (delete blockers / public exposure); populated on detail GET only — omitted on list", + "nullable": true, + "items": { + "$ref": "#/components/schemas/ResourceGroupDeleteBlockerDto" + } + }, + "openRegionIncident": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/IncidentDto" + } + ] + }, + "managedBy": { "type": "string", - "description": "Detection engine version that observed this policy" + "description": "Source that created/owns this group: DASHBOARD, CLI, TERRAFORM, MCP, or API. Null on groups created before this attribution column existed.", + "nullable": true, + "enum": [ + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" + ] }, - "firstSeenAt": { + "createdAt": { "type": "string", - "description": "First time the detection engine evaluated against this policy bytes", + "description": "Timestamp when the group was created", "format": "date-time" }, - "lastSeenAt": { + "updatedAt": { "type": "string", - "description": "Most recent time the engine evaluated against this policy bytes", + "description": "Timestamp when the group was last updated", "format": "date-time" } }, - "description": "Policy snapshot used during this check (all evaluations of a single check are against one policy)", - "nullable": true + "description": "Resource group with health summary and optional member details" }, - "PollChartBucketDto": { + "ResourceGroupHealthDto": { "required": [ - "bucket", - "totalPolls" + "status", + "totalMembers", + "operationalCount", + "activeIncidents" ], "type": "object", "properties": { - "bucket": { + "status": { "type": "string", - "description": "Start of the time bucket (ISO 8601)", - "format": "date-time" + "description": "Worst-of health status across all members", + "enum": [ + "operational", + "maintenance", + "degraded", + "down" + ] }, - "uptimePercent": { - "type": "number", - "description": "Uptime percentage for this bucket; null when no data", - "format": "double", - "nullable": true, - "example": 100 + "totalMembers": { + "type": "integer", + "description": "Total number of members in the group", + "format": "int32" }, - "avgResponseTimeMs": { - "type": "number", - "description": "Average response time in milliseconds for this bucket", - "format": "double", + "operationalCount": { + "type": "integer", + "description": "Number of members currently in operational status", + "format": "int32" + }, + "activeIncidents": { + "type": "integer", + "description": "Number of members currently non-operational (not an incident-row count)", + "format": "int32" + }, + "thresholdStatus": { + "type": "string", + "description": "Computed group health status based on threshold: 'healthy', 'degraded', or 'down'. Null when no health threshold is configured.", "nullable": true, - "example": 245.3 + "enum": [ + "healthy", + "degraded", + "down" + ] }, - "totalPolls": { + "failingCount": { "type": "integer", - "description": "Total polls in this bucket", - "format": "int64", - "example": 60 + "description": "Number of failing members at time of last evaluation; null when no threshold configured", + "format": "int32", + "nullable": true + }, + "healthBreachedSince": { + "type": "string", + "description": "When the health threshold was first breached in the current cycle; null when not breached", + "format": "date-time", + "nullable": true + }, + "healthEvaluatedAt": { + "type": "string", + "description": "When group health was last evaluated (threshold or stamp-only); null until first evaluation", + "format": "date-time", + "nullable": true } }, - "description": "Aggregated poll metrics for a time bucket" + "description": "Aggregated health summary for a resource group" }, - "PricingTier": { + "ResourceGroupMemberDto": { "required": [ - "name" + "createdAt", + "groupId", + "id", + "memberType", + "status" ], "type": "object", "properties": { - "name": { + "id": { "type": "string", - "description": "Tier name, e.g. 'Free', 'Pro', 'Enterprise'" + "description": "Unique group member record identifier", + "format": "uuid" }, - "slaPercentage": { + "groupId": { "type": "string", - "description": "SLA percentage for this tier, e.g. '99.9%'", + "description": "Resource group this member belongs to", + "format": "uuid" + }, + "memberType": { + "type": "string", + "description": "Type of member: 'monitor' or 'service'" + }, + "monitorId": { + "type": "string", + "description": "Monitor ID; set when memberType is 'monitor'", + "format": "uuid", "nullable": true }, - "priceFrom": { + "serviceId": { "type": "string", - "description": "Starting price, e.g. '$0', '$25/mo', 'Custom'", + "description": "Service ID; set when memberType is 'service'", + "format": "uuid", "nullable": true - } - }, - "description": "Pricing tiers with associated SLA levels" - }, - "PublishStatusPageIncidentRequest": { - "type": "object", - "properties": { - "title": { - "maxLength": 500, - "minLength": 0, + }, + "name": { "type": "string", - "description": "Customer-facing title; null keeps draft value", + "description": "Display name of the referenced monitor or service", "nullable": true }, - "impact": { + "slug": { "type": "string", - "description": "Impact level; null keeps draft value", - "nullable": true, - "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" - ] + "description": "Slug identifier for the service (services only); used for icons and uptime API calls", + "nullable": true + }, + "subscriptionId": { + "type": "string", + "description": "Subscription ID for the service (services only); used to link to the dependency detail page", + "format": "uuid", + "nullable": true }, "status": { "type": "string", - "description": "Incident status; null keeps draft value (must be an active status)", - "nullable": true, + "description": "Computed health status for this member", "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" + "operational", + "maintenance", + "degraded", + "down" ] }, - "body": { + "effectiveFrequency": { "type": "string", - "description": "Initial update body; null keeps draft value", + "description": "Effective check frequency label showing the group default when the monitor inherits it; null for services or when no group default is configured", "nullable": true }, - "affectedComponents": { + "createdAt": { + "type": "string", + "description": "Timestamp when the member was added to the group", + "format": "date-time" + }, + "uptime24h": { + "type": "number", + "description": "24h uptime percentage; populated when includeMetrics=true", + "format": "double", + "nullable": true + }, + "chartData": { "type": "array", - "description": "Affected components; null keeps draft value", + "description": "Uptime tick values (0-100) for last-24h mini chart; populated when includeMetrics=true", "nullable": true, "items": { - "$ref": "#/components/schemas/AffectedComponent" + "type": "number", + "description": "Uptime tick values (0-100) for last-24h mini chart; populated when includeMetrics=true", + "format": "double" } }, - "notifySubscribers": { - "type": "boolean", - "description": "Whether to notify subscribers (default: true)", + "avgLatencyMs": { + "type": "number", + "description": "Average latency in ms (monitors only); populated when includeMetrics=true", + "format": "double", "nullable": true - } - } - }, - "PushbulletChannelConfig": { - "required": [ - "channelType", - "accessToken" - ], - "type": "object", - "properties": { - "channelType": { + }, + "p95LatencyMs": { + "type": "number", + "description": "P95 latency in ms (monitors only); populated when includeMetrics=true", + "format": "double", + "nullable": true + }, + "lastCheckedAt": { "type": "string", - "enum": [ - "pushbullet" - ] + "description": "Timestamp of the most recent health check; populated when includeMetrics=true", + "format": "date-time", + "nullable": true }, - "accessToken": { - "minLength": 1, + "monitorType": { "type": "string", - "description": "Pushbullet access token" + "description": "Monitor type (HTTP, DNS, TCP, ICMP, HEARTBEAT, MCP); monitors only", + "nullable": true }, - "deviceIden": { + "environmentName": { "type": "string", - "description": "Target device identifier (broadcasts to all if empty)", + "description": "Environment name; monitors only", + "nullable": true + }, + "groupMembershipCount": { + "type": "integer", + "description": "Count of resource groups this monitor or service belongs to; detail GET only — omitted on list", + "format": "int32", + "nullable": true + }, + "failingSince": { + "type": "string", + "description": "Start of the current non-operational stretch; null when operational or unknown (services OK); detail GET only — omitted on list", + "format": "date-time", + "nullable": true + }, + "alertCollapsed": { + "type": "boolean", + "description": "True when an active member incident records this group among alertCollapsedByResourceGroupIds; detail GET only — omitted on list", "nullable": true + }, + "incidentMarks": { + "type": "array", + "description": "Incident marks for the trailing 24h strip; null when metrics omitted or failed; detail GET only — omitted on list", + "nullable": true, + "items": { + "$ref": "#/components/schemas/ResourceGroupMemberIncidentMarkDto" + } } - } + }, + "description": "A single member of a resource group with its computed health status" }, - "PushoverChannelConfig": { + "ResourceGroupMemberIncidentMarkDto": { "required": [ - "channelType", - "userKey", - "appToken" + "at" ], "type": "object", "properties": { - "channelType": { - "type": "string", - "enum": [ - "pushover" - ] - }, - "userKey": { - "minLength": 1, - "type": "string", - "description": "Pushover user or group key" - }, - "appToken": { - "minLength": 1, + "at": { "type": "string", - "description": "Pushover application API token" + "description": "Incident startedAt (or first confirmed) within the trailing 24h window", + "format": "date-time" }, - "priority": { + "incidentId": { "type": "string", - "description": "Notification priority override (-2 to 2)", + "description": "Incident ID for navigation; null when unknown", + "format": "uuid", "nullable": true }, - "sound": { + "severity": { "type": "string", - "description": "Notification sound override", + "description": "Optional severity display hint", "nullable": true } - } + }, + "description": "Member incident mark for the trailing 24h uptime strip" }, - "RateLimitInfo": { + "ResponseSizeAssertion": { "type": "object", "properties": { - "requestsPerMinute": { - "type": "integer", - "description": "Maximum requests allowed per window", - "format": "int64" - }, - "remaining": { - "type": "integer", - "description": "Requests remaining in the current window", - "format": "int64" + "type": { + "type": "string", + "enum": [ + "response_size" + ] }, - "windowMs": { + "maxBytes": { "type": "integer", - "description": "Sliding window size in milliseconds", - "format": "int64" + "description": "Maximum response body size in bytes before the check fails", + "format": "int32" } }, - "description": "Rate-limit quota for the current sliding window", "required": [ - "requestsPerMinute", - "remaining", - "windowMs" + "type", + "maxBytes" ] }, - "RecoveryPolicy": { + "ResponseTimeAssertion": { "type": "object", "properties": { - "consecutiveSuccesses": { - "type": "integer", - "description": "Consecutive passing checks required to auto-resolve the incident", - "format": "int32" - }, - "minRegionsPassing": { - "type": "integer", - "description": "Minimum regions that must be passing before recovery can complete", - "format": "int32" + "type": { + "type": "string", + "enum": [ + "response_time" + ] }, - "cooldownMinutes": { + "thresholdMs": { "type": "integer", - "description": "Minutes after resolve before a new incident may open on the same monitor", + "description": "Maximum allowed response time in milliseconds before the check fails", "format": "int32" } }, - "description": "Auto-recovery settings", "required": [ - "consecutiveSuccesses", - "minRegionsPassing", - "cooldownMinutes" + "type", + "thresholdMs" ] }, - "RedirectCountAssertion": { + "ResponseTimeWarnAssertion": { "type": "object", "properties": { "type": { "type": "string", "enum": [ - "redirect_count" + "response_time_warn" ] }, - "maxCount": { + "warnMs": { "type": "integer", - "description": "Maximum number of HTTP redirects allowed before the check fails", + "description": "HTTP response time in milliseconds that triggers a warning only", "format": "int32" } }, "required": [ "type", - "maxCount" + "warnMs" ] }, - "RedirectTargetAssertion": { + "ResultSummaryDto": { "required": [ - "type", - "expected", - "operator" + "chartData", + "currentStatus", + "latestPerRegion" ], "type": "object", "properties": { - "type": { + "currentStatus": { "type": "string", + "description": "Derived current status across all regions", "enum": [ - "redirect_target" + "up", + "degraded", + "down", + "paused", + "unknown" ] }, - "expected": { - "minLength": 1, - "type": "string", - "description": "Expected final URL after following redirects" + "latestPerRegion": { + "type": "array", + "description": "Latest check result per region", + "items": { + "$ref": "#/components/schemas/RegionStatusDto" + } }, - "operator": { - "type": "string", - "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", - "enum": [ - "equals", - "contains", - "less_than", - "greater_than", - "matches", - "range" - ] + "chartData": { + "type": "array", + "description": "Time-bucketed chart data for the requested window", + "items": { + "$ref": "#/components/schemas/ChartBucketDto" + } + }, + "uptime24h": { + "type": "number", + "description": "Uptime percentage over the last 24 hours; null when no data", + "format": "double", + "nullable": true, + "example": 99.95 + }, + "uptimeWindow": { + "type": "number", + "description": "Uptime percentage for the selected chart window; null when no data", + "format": "double", + "nullable": true, + "example": 99.8 } - } + }, + "description": "Dashboard summary: current status, per-region latest results, and chart data" }, - "RegexBodyAssertion": { + "RetryStrategy": { "required": [ "type", - "pattern" + "maxRetries", + "interval" ], "type": "object", "properties": { "type": { "type": "string", - "enum": [ - "regex_body" - ] + "description": "Retry strategy kind, e.g. fixed interval between attempts" }, - "pattern": { - "minLength": 1, - "type": "string", - "description": "Regular expression the response body must match" + "maxRetries": { + "type": "integer", + "description": "Maximum number of retries after a failed check", + "format": "int32" + }, + "interval": { + "type": "integer", + "description": "Delay between retry attempts in seconds", + "format": "int32" } - } + }, + "description": "Default retry strategy for member monitors; null clears" }, - "RegionStatusDto": { + "RevisionDiffDto": { "required": [ - "region", - "timestamp", - "passed" + "hunks", + "left", + "right" ], "type": "object", "properties": { - "region": { - "type": "string", - "description": "Region identifier", - "example": "us-east" + "left": { + "$ref": "#/components/schemas/RevisionDto" }, - "passed": { - "type": "boolean", - "description": "Whether the last check in this region passed", - "example": true - }, - "responseTimeMs": { - "type": "integer", - "description": "Response time in milliseconds for the last check", - "format": "int32", - "nullable": true, - "example": 95 - }, - "timestamp": { - "type": "string", - "description": "Timestamp of the last check in this region (ISO 8601)", - "format": "date-time" + "right": { + "$ref": "#/components/schemas/RevisionDto" }, - "severityHint": { - "type": "string", - "description": "Severity hint: 'down' for hard failures, 'degraded' for warn-only failures, null when passing", - "nullable": true + "hunks": { + "type": "array", + "description": "File and field-level hunks (bounded)", + "items": { + "$ref": "#/components/schemas/RevisionDiffHunkDto" + } } }, - "description": "Latest check result for a single region" + "description": "Bounded comparison of two revisions" }, - "RelatedIncidentsResponse": { + "RevisionDiffHunkDto": { "required": [ - "data", - "total" + "change", + "path" ], "type": "object", "properties": { - "data": { - "type": "array", - "description": "Related incident rows (newest first, capped by limit)", - "items": { - "$ref": "#/components/schemas/IncidentDto" - } + "path": { + "minLength": 1, + "type": "string", + "description": "Path or field name (entrypoint, keys, or file path)" }, - "total": { - "type": "integer", - "description": "Total matching incidents in the window, excluding the current incident", - "format": "int64" + "change": { + "type": "string", + "description": "Whether this path was added, removed, or changed", + "enum": [ + "added", + "removed", + "changed" + ] + }, + "left": { + "type": "string", + "description": "Left value when present", + "nullable": true + }, + "right": { + "type": "string", + "description": "Right value when present", + "nullable": true } }, - "description": "Related incidents sharing the same origin within a time window" + "description": "One bounded diff hunk between revisions" }, - "RemoveMonitorTagsRequest": { + "RevisionDto": { "required": [ - "tagIds" + "createdAt", + "definitionId", + "digest", + "entrypoint", + "files", + "id", + "keys", + "number" ], "type": "object", "properties": { - "tagIds": { - "minItems": 1, + "id": { + "type": "string", + "description": "Revision identifier", + "format": "uuid" + }, + "definitionId": { + "type": "string", + "description": "Parent definition", + "format": "uuid" + }, + "number": { + "type": "integer", + "description": "Monotonic revision number within the definition", + "format": "int32" + }, + "digest": { + "minLength": 1, + "type": "string", + "description": "SHA-256 hex digest of the zip" + }, + "entrypoint": { + "minLength": 1, + "type": "string", + "description": "Entrypoint file that runs" + }, + "files": { "type": "array", - "description": "IDs of the tags to detach from the monitor", + "description": "Paths present in the zip", "items": { "type": "string", - "description": "IDs of the tags to detach from the monitor", - "format": "uuid" + "description": "Paths present in the zip" + } + }, + "keys": { + "type": "array", + "description": "Secret key names the code demands", + "items": { + "type": "string", + "description": "Secret key names the code demands" } + }, + "downloadUntil": { + "type": "string", + "description": "When package bytes expire for download", + "format": "date-time", + "nullable": true + }, + "gitSha": { + "type": "string", + "description": "Git commit SHA when sourced from Git", + "nullable": true + }, + "gitMessage": { + "type": "string", + "description": "Git commit message", + "nullable": true + }, + "gitFile": { + "type": "string", + "description": "Declaring Git file path", + "nullable": true + }, + "authoredBy": { + "type": "string", + "description": "Who authored this package", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "When the revision was minted", + "format": "date-time" } }, - "description": "Request body for removing tags from a monitor" + "description": "Definition revision package" }, - "ReorderComponentsRequest": { + "RollbackPreviewDto": { "required": [ - "positions" + "affectedMonitors", + "target" ], "type": "object", "properties": { - "positions": { - "minItems": 1, + "target": { + "$ref": "#/components/schemas/RevisionDto" + }, + "current": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/DefinitionHeadDto" + } + ] + }, + "affectedMonitors": { "type": "array", - "description": "Ordered list of component IDs with their new positions", + "description": "Monitors sharing this definition and environment", "items": { - "$ref": "#/components/schemas/ComponentPosition" + "$ref": "#/components/schemas/MonitorDto" } } }, - "description": "Batch component reorder request" + "description": "Consequence preview for rolling back Head in this environment" }, - "ReorderPageLayoutRequest": { + "RollbackRevisionRequest": { "required": [ - "sections" + "reason", + "revisionId" ], "type": "object", "properties": { - "sections": { - "minItems": 1, - "type": "array", - "description": "Top-level sections in their new order", - "items": { - "$ref": "#/components/schemas/PageSection" - } + "revisionId": { + "type": "string", + "description": "Existing revision to restore as Head for this monitor's environment", + "format": "uuid" }, - "groupOrders": { - "type": "array", - "description": "Within-group component ordering; only needed for groups whose internal order changed", - "nullable": true, - "items": { - "$ref": "#/components/schemas/GroupComponentOrder" - } + "reason": { + "maxLength": 280, + "minLength": 0, + "type": "string", + "description": "Why this rollback was performed (1–280 chars)" } - }, - "description": "Reorder page-level layout: groups and ungrouped components share one ordering" + } }, - "ResolveIncidentRequest": { + "RootlyChannelConfig": { + "required": [ + "channelType", + "apiKey" + ], "type": "object", "properties": { - "body": { + "channelType": { "type": "string", - "description": "Optional resolution message or post-mortem notes", + "enum": [ + "rootly" + ] + }, + "apiKey": { + "minLength": 1, + "type": "string", + "description": "Rootly API token with incident creation permission" + }, + "severity": { + "type": "string", + "description": "Severity slug override (e.g. sev0, sev1)", "nullable": true } } }, - "ResourceGroupDeleteBlockerDto": { + "RuleEvaluationDto": { "required": [ - "componentId", - "componentName", - "statusPageId", - "statusPageName", - "statusPageSlug" + "checkId", + "engineVersion", + "evaluationDetails", + "id", + "inputResultIds", + "monitorId", + "occurredAt", + "policySnapshotHashHex", + "region", + "ruleScope", + "ruleType", + "ruleIndex", + "outputMatched" ], "type": "object", "properties": { - "statusPageId": { + "id": { "type": "string", - "description": "Status page that owns the blocking component", + "description": "Forensic row UUID", "format": "uuid" }, - "statusPageName": { + "occurredAt": { + "type": "string", + "description": "When the evaluation ran", + "format": "date-time" + }, + "monitorId": { + "type": "string", + "description": "Monitor that produced the input check result", + "format": "uuid" + }, + "region": { "minLength": 1, "type": "string", - "description": "Human-readable status page name" + "description": "Probe region of the input check result" }, - "statusPageSlug": { + "policySnapshotHashHex": { "minLength": 1, "type": "string", - "description": "URL-safe status page slug" + "description": "Hex-encoded hash of the policy snapshot this rule came from" }, - "componentId": { + "ruleIndex": { + "type": "integer", + "description": "Index into the policy's triggerRules array (0-based)", + "format": "int32" + }, + "ruleType": { + "minLength": 1, "type": "string", - "description": "Blocking GROUP-typed status page component ID", - "format": "uuid" + "description": "Rule type (e.g. consecutive_failures, failures_in_window)" }, - "componentName": { + "ruleScope": { "minLength": 1, "type": "string", - "description": "Blocking component display name" + "description": "Rule scope (per_region | multi_region)" }, - "hostname": { + "inputResultIds": { + "minItems": 1, + "type": "array", + "description": "check_results IDs that were inputs to this evaluation (newest first)", + "items": { + "type": "string", + "description": "check_results IDs that were inputs to this evaluation (newest first)", + "format": "uuid" + } + }, + "outputMatched": { + "type": "boolean", + "description": "Whether the rule fired on this evaluation" + }, + "evaluationDetails": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Structured details (e.g. failure counts, response-time aggregates)" + }, + "description": "Structured details (e.g. failure counts, response-time aggregates)" + }, + "engineVersion": { + "minLength": 1, "type": "string", - "description": "Public hostname when a custom domain is configured; null otherwise", + "description": "Detection engine version that ran this evaluation" + }, + "checkId": { + "type": "string", + "description": "Scheduler-minted check execution ID (V92) — the causal chain identifier", + "format": "uuid" + }, + "triggeringTransitionId": { + "type": "string", + "description": "If this evaluation caused a state transition, points to that transition's id", + "format": "uuid", "nullable": true } }, - "description": "Status-page component that references this resource group (blocks delete; public exposure)" + "description": "All rule evaluations that ran for this check" }, - "ResourceGroupDto": { + "RunArtifactDto": { "required": [ "createdAt", - "health", "id", - "name", - "slug", - "updatedAt", - "organizationId", - "suppressMemberAlerts" + "kind", + "lifecycle", + "runId", + "organizationId" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Unique resource group identifier", + "description": "Unique artifact identifier", "format": "uuid" }, "organizationId": { "type": "integer", - "description": "Organization this group belongs to", + "description": "Organization this artifact belongs to", "format": "int32" }, - "name": { - "minLength": 1, + "runId": { "type": "string", - "description": "Human-readable group name" + "description": "Run this artifact belongs to", + "format": "uuid" }, - "slug": { - "minLength": 1, + "stepId": { "type": "string", - "description": "URL-safe group identifier" + "description": "Step this screenshot belongs to; null for whole-run kinds", + "format": "uuid", + "nullable": true }, - "description": { + "kind": { "type": "string", - "description": "Optional group description", + "description": "File kind", + "enum": [ + "screenshot", + "video", + "trace", + "har", + "console", + "runner_log" + ] + }, + "lifecycle": { + "type": "string", + "description": "Whether bytes are available, processing, or gone", + "enum": [ + "available", + "processing", + "failed", + "not_captured", + "suppressed", + "never_reached", + "expired", + "no_browser" + ] + }, + "captureReason": { + "type": "string", + "description": "Why this file was captured", + "nullable": true, + "enum": [ + "on_failure", + "named_step", + "customer" + ] + }, + "byteSize": { + "type": "integer", + "description": "Stored size in bytes", + "format": "int64", "nullable": true }, - "alertPolicyId": { + "contentType": { "type": "string", - "description": "Notification policy applied to this group", - "format": "uuid", + "description": "MIME type of the stored file", "nullable": true }, - "defaultFrequency": { + "durationMs": { "type": "integer", - "description": "Default check frequency in seconds for member monitors", + "description": "Video duration in milliseconds", "format": "int32", "nullable": true }, - "defaultRegions": { - "type": "array", - "description": "Default regions for member monitors", - "nullable": true, - "items": { - "type": "string", - "description": "Default regions for member monitors" - } - }, - "defaultRetryStrategy": { + "viewport": { "nullable": true, "allOf": [ { - "$ref": "#/components/schemas/RetryStrategy" + "$ref": "#/components/schemas/ArtifactViewport" } ] }, - "defaultAlertChannels": { - "type": "array", - "description": "Default alert channel IDs for member monitors", - "nullable": true, - "items": { - "type": "string", - "description": "Default alert channel IDs for member monitors", - "format": "uuid" - } - }, - "defaultEnvironmentId": { - "type": "string", - "description": "Default environment ID for member monitors", - "format": "uuid", - "nullable": true - }, - "healthThresholdType": { + "expiresAt": { "type": "string", - "description": "Health threshold type: COUNT or PERCENTAGE", - "nullable": true, - "enum": [ - "COUNT", - "PERCENTAGE" - ] - }, - "healthThresholdValue": { - "type": "number", - "description": "Health threshold value", + "description": "When stored bytes expire", + "format": "date-time", "nullable": true }, - "suppressMemberAlerts": { - "type": "boolean", - "description": "When true, member-level incidents skip notification dispatch; only group alerts fire" - }, - "confirmationDelaySeconds": { + "expectedByteSize": { "type": "integer", - "description": "Seconds to wait after health threshold breach before creating group incident", - "format": "int32", + "description": "Expected size while a video is encoding", + "format": "int64", "nullable": true }, - "recoveryCooldownMinutes": { + "encodeEtaMs": { "type": "integer", - "description": "Cooldown minutes after group incident resolves before a new one can open", + "description": "Estimated remaining encode time in milliseconds", "format": "int32", "nullable": true }, - "health": { - "$ref": "#/components/schemas/ResourceGroupHealthDto" - }, - "members": { - "type": "array", - "description": "Member list with individual statuses; populated on detail GET only", - "nullable": true, - "items": { - "$ref": "#/components/schemas/ResourceGroupMemberDto" - } - }, - "deleteBlockedBy": { - "type": "array", - "description": "Status-page GROUP components that reference this group (delete blockers / public exposure); populated on detail GET only — omitted on list", - "nullable": true, - "items": { - "$ref": "#/components/schemas/ResourceGroupDeleteBlockerDto" - } - }, - "openRegionIncident": { + "traceMeta": { "nullable": true, "allOf": [ { - "$ref": "#/components/schemas/IncidentDto" + "$ref": "#/components/schemas/ArtifactTraceMeta" } ] }, - "managedBy": { + "createdAt": { "type": "string", - "description": "Source that created/owns this group: DASHBOARD, CLI, TERRAFORM, MCP, or API. Null on groups created before this attribution column existed.", + "description": "When this file row was created", + "format": "date-time" + } + }, + "description": "Run evidence file" + }, + "RunAttemptDto": { + "type": "object", + "properties": { + "attempt": { + "type": "integer", + "description": "1-based attempt number", + "format": "int32" + }, + "outcome": { + "type": "string", + "description": "Attempt outcome; null while the case is open", "nullable": true, "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" + "passed", + "failed", + "execution_error", + "timed_out", + "passed_on_retry", + "cancelled", + "inconclusive" ] }, - "createdAt": { + "startedAt": { "type": "string", - "description": "Timestamp when the group was created", - "format": "date-time" + "description": "When this attempt started", + "format": "date-time", + "nullable": true }, - "updatedAt": { + "finishedAt": { "type": "string", - "description": "Timestamp when the group was last updated", - "format": "date-time" + "description": "When this attempt finished", + "format": "date-time", + "nullable": true } }, - "description": "Resource group with health summary and optional member details" + "description": "In-check attempt", + "required": [ + "attempt" + ] }, - "ResourceGroupHealthDto": { + "RunCaseDto": { "required": [ + "id", + "runId", "status", - "totalMembers", - "operationalCount", - "activeIncidents" + "steps", + "title", + "organizationId", + "attempt", + "index" ], "type": "object", "properties": { - "status": { + "id": { "type": "string", - "description": "Worst-of health status across all members", - "enum": [ - "operational", - "maintenance", - "degraded", - "down" - ] + "description": "Case identifier", + "format": "uuid" }, - "totalMembers": { + "organizationId": { "type": "integer", - "description": "Total number of members in the group", + "description": "Organization this case belongs to", "format": "int32" }, - "operationalCount": { + "runId": { + "type": "string", + "description": "Run this case belongs to", + "format": "uuid" + }, + "attempt": { "type": "integer", - "description": "Number of members currently in operational status", + "description": "Playwright in-case attempt number", "format": "int32" }, - "activeIncidents": { + "index": { "type": "integer", - "description": "Number of members currently non-operational (not an incident-row count)", + "description": "Zero-based case index within the attempt", "format": "int32" }, - "thresholdStatus": { + "title": { "type": "string", - "description": "Computed group health status based on threshold: 'healthy', 'degraded', or 'down'. Null when no health threshold is configured.", - "nullable": true, + "description": "Case title" + }, + "file": { + "type": "string", + "description": "Spec path inside the package", + "nullable": true + }, + "status": { + "type": "string", + "description": "Case status", "enum": [ - "healthy", - "degraded", - "down" + "pending", + "running", + "passed", + "failed", + "timed_out", + "skipped", + "interrupted" ] }, - "failingCount": { - "type": "integer", - "description": "Number of failing members at time of last evaluation; null when no threshold configured", - "format": "int32", + "startedAt": { + "type": "string", + "description": "When the case started", + "format": "date-time", "nullable": true }, - "healthBreachedSince": { + "finishedAt": { "type": "string", - "description": "When the health threshold was first breached in the current cycle; null when not breached", + "description": "When the case finished", "format": "date-time", "nullable": true }, - "healthEvaluatedAt": { + "durationMs": { + "type": "integer", + "description": "Reporter duration in milliseconds", + "format": "int32", + "nullable": true + }, + "steps": { + "type": "array", + "description": "Steps on this case", + "items": { + "$ref": "#/components/schemas/RunStepDto" + } + } + }, + "description": "Run case with nested steps" + }, + "RunCaseListParams": { + "type": "object", + "properties": { + "attempt": { + "type": "integer", + "description": "Only return cases for this Playwright attempt", + "format": "int32", + "nullable": true + } + } + }, + "RunConsoleDto": { + "required": [ + "groups", + "state" + ], + "type": "object", + "properties": { + "state": { + "minLength": 1, "type": "string", - "description": "When group health was last evaluated (threshold or stamp-only); null until first evaluation", - "format": "date-time", + "description": "on for browser, no_browser for API_CHECK" + }, + "reason": { + "type": "string", + "description": "Absence copy when state is no_browser", "nullable": true + }, + "groups": { + "type": "array", + "description": "Grouped messages; empty when ungrouped or no_browser", + "items": { + "$ref": "#/components/schemas/ConsoleGroupDto" + } + }, + "lines": { + "type": "array", + "description": "Raw lines when ungrouped=true", + "nullable": true, + "items": { + "$ref": "#/components/schemas/ConsoleLineDto" + } } }, - "description": "Aggregated health summary for a resource group" + "description": "Console groups or ungrouped lines" }, - "ResourceGroupMemberDto": { + "RunConsoleParams": { + "type": "object", + "properties": { + "attempt": { + "type": "integer", + "description": "In-check attempt (default selected attempt)", + "format": "int32", + "nullable": true + }, + "ungrouped": { + "type": "boolean", + "description": "Return chronological lines instead of groups", + "nullable": true + }, + "level": { + "type": "string", + "description": "Filter error, warning, or info", + "nullable": true + }, + "format": { + "type": "string", + "description": "raw downloads the ungrouped log as text/plain", + "nullable": true + } + } + }, + "RunDto": { "required": [ - "createdAt", - "groupId", + "attempts", + "bindingVersionSnapshot", + "bundleDigest", + "capturePolicySnapshot", + "enqueuedAt", + "evidence", "id", - "memberType", - "status" + "monitorId", + "phase", + "region", + "revisionId", + "source", + "tabCounts", + "organizationId", + "cancelRequested", + "stream", + "attempt", + "attemptOf" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Unique group member record identifier", + "description": "Unique run identifier", "format": "uuid" }, - "groupId": { + "organizationId": { + "type": "integer", + "description": "Organization this run belongs to", + "format": "int32" + }, + "monitorId": { "type": "string", - "description": "Resource group this member belongs to", + "description": "Monitor this run belongs to", "format": "uuid" }, - "memberType": { + "monitorName": { "type": "string", - "description": "Type of member: 'monitor' or 'service'" + "description": "Monitor display name", + "nullable": true }, - "monitorId": { + "monitorType": { "type": "string", - "description": "Monitor ID; set when memberType is 'monitor'", + "description": "Monitor type", + "nullable": true, + "enum": [ + "HTTP", + "DNS", + "MCP_SERVER", + "TCP", + "ICMP", + "HEARTBEAT", + "BROWSER", + "MULTI_STEP_API" + ] + }, + "host": { + "type": "string", + "description": "Target host from the environment BASE_URL", + "nullable": true + }, + "environmentId": { + "type": "string", + "description": "Environment this run executed in", "format": "uuid", "nullable": true }, - "serviceId": { + "environmentName": { + "type": "string", + "description": "Environment display name", + "nullable": true + }, + "revisionId": { + "type": "string", + "description": "Revision this run executed", + "format": "uuid" + }, + "region": { + "minLength": 1, + "type": "string", + "description": "Probe region for this run" + }, + "source": { + "type": "string", + "description": "What triggered this run", + "enum": [ + "schedule", + "run_now", + "ci", + "fast_retry", + "remote_validation", + "deployment_validation", + "session_renew" + ] + }, + "enqueuedAt": { + "type": "string", + "description": "When this run was enqueued", + "format": "date-time" + }, + "evaluationCycleId": { "type": "string", - "description": "Service ID; set when memberType is 'service'", + "description": "Evaluation cycle grouping this run with retries", "format": "uuid", "nullable": true }, - "name": { + "retryOfRunId": { "type": "string", - "description": "Display name of the referenced monitor or service", + "description": "Parent run when this is a fast retry", + "format": "uuid", "nullable": true }, - "slug": { + "retriedFromRunId": { "type": "string", - "description": "Slug identifier for the service (services only); used for icons and uptime API calls", + "description": "Fast-retry parent run", + "format": "uuid", "nullable": true }, - "subscriptionId": { + "phase": { "type": "string", - "description": "Subscription ID for the service (services only); used to link to the dependency detail page", - "format": "uuid", - "nullable": true + "description": "Current run phase", + "enum": [ + "created", + "queued", + "starting", + "running", + "finalizing", + "finished" + ] }, - "status": { + "cancelRequested": { + "type": "boolean", + "description": "Whether cancel was requested" + }, + "outcome": { "type": "string", - "description": "Computed health status for this member", + "description": "Outcome; null until the run is finished", + "nullable": true, "enum": [ - "operational", - "maintenance", - "degraded", - "down" + "passed", + "failed", + "execution_error", + "timed_out", + "passed_on_retry", + "cancelled", + "inconclusive" ] }, - "effectiveFrequency": { + "headline": { "type": "string", - "description": "Effective check frequency label showing the group default when the monitor inherits it; null for services or when no group default is configured", + "description": "Last control headline", "nullable": true }, - "createdAt": { + "executionLine": { "type": "string", - "description": "Timestamp when the member was added to the group", - "format": "date-time" + "description": "Live execution one-liner", + "nullable": true }, - "uptime24h": { - "type": "number", - "description": "24h uptime percentage; populated when includeMetrics=true", - "format": "double", + "metaLine": { + "type": "string", + "description": "Server-composed header meta line", "nullable": true }, - "chartData": { - "type": "array", - "description": "Uptime tick values (0-100) for last-24h mini chart; populated when includeMetrics=true", - "nullable": true, - "items": { - "type": "number", - "description": "Uptime tick values (0-100) for last-24h mini chart; populated when includeMetrics=true", - "format": "double" - } + "bundleDigest": { + "minLength": 1, + "type": "string", + "description": "Package digest frozen at create" }, - "avgLatencyMs": { - "type": "number", - "description": "Average latency in ms (monitors only); populated when includeMetrics=true", - "format": "double", + "startedAt": { + "type": "string", + "description": "When execution claimed a seat", + "format": "date-time", "nullable": true }, - "p95LatencyMs": { - "type": "number", - "description": "P95 latency in ms (monitors only); populated when includeMetrics=true", - "format": "double", + "finishedAt": { + "type": "string", + "description": "When the run finished", + "format": "date-time", "nullable": true }, - "lastCheckedAt": { + "updatedAt": { "type": "string", - "description": "Timestamp of the most recent health check; populated when includeMetrics=true", + "description": "When the run row last changed", "format": "date-time", "nullable": true }, - "monitorType": { + "lastHeartbeatAt": { "type": "string", - "description": "Monitor type (HTTP, DNS, TCP, ICMP, HEARTBEAT, MCP); monitors only", + "description": "Last supervisor heartbeat", + "format": "date-time", "nullable": true }, - "environmentName": { + "cancelledBy": { "type": "string", - "description": "Environment name; monitors only", + "description": "Who requested cancel", "nullable": true }, - "groupMembershipCount": { + "artifactsExpiredAt": { + "type": "string", + "description": "When artifact bytes expired", + "format": "date-time", + "nullable": true + }, + "capturePolicySnapshot": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Capture settings frozen at create" + }, + "description": "Capture settings frozen at create" + }, + "bindingVersionSnapshot": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Resolved secret key names frozen at create" + }, + "description": "Resolved secret key names frozen at create" + }, + "durationMs": { "type": "integer", - "description": "Count of resource groups this monitor or service belongs to; detail GET only — omitted on list", + "description": "Wall time from claim to finish", + "format": "int64", + "nullable": true + }, + "queueWaitMs": { + "type": "integer", + "description": "Time spent waiting for a seat", + "format": "int64", + "nullable": true + }, + "queuePosition": { + "type": "integer", + "description": "Live queue position; null when not queued", "format": "int32", "nullable": true }, - "failingSince": { - "type": "string", - "description": "Start of the current non-operational stretch; null when operational or unknown (services OK); detail GET only — omitted on list", - "format": "date-time", + "heartbeatAgeMs": { + "type": "integer", + "description": "Milliseconds since the last supervisor heartbeat", + "format": "int64", "nullable": true }, - "alertCollapsed": { + "stream": { "type": "boolean", - "description": "True when an active member incident records this group among alertCollapsedByResourceGroupIds; detail GET only — omitted on list", - "nullable": true + "description": "True while the run is still live and clients may stream" }, - "incidentMarks": { + "evidence": { "type": "array", - "description": "Incident marks for the trailing 24h strip; null when metrics omitted or failed; detail GET only — omitted on list", + "description": "List evidence chips in SHOT → TRACE → VIDEO → NET order", + "items": { + "$ref": "#/components/schemas/RunEvidenceDto" + } + }, + "tabCounts": { + "$ref": "#/components/schemas/RunTabCountsDto" + }, + "live": { "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/RunLiveDto" + } + ] + }, + "attempt": { + "type": "integer", + "description": "Selected in-check attempt (1-based)", + "format": "int32" + }, + "attemptOf": { + "type": "integer", + "description": "In-check attempt count", + "format": "int32" + }, + "attempts": { + "type": "array", + "description": "In-check attempts", "items": { - "$ref": "#/components/schemas/ResourceGroupMemberIncidentMarkDto" + "$ref": "#/components/schemas/RunAttemptDto" } + }, + "incidentId": { + "type": "string", + "description": "Open incident for this monitor", + "format": "uuid", + "nullable": true } }, - "description": "A single member of a resource group with its computed health status" + "description": "Code-monitor run" }, - "ResourceGroupMemberIncidentMarkDto": { + "RunEventDto": { "required": [ - "at" + "createdAt", + "id", + "payload", + "runId", + "type", + "organizationId", + "seq" ], "type": "object", "properties": { - "at": { + "id": { "type": "string", - "description": "Incident startedAt (or first confirmed) within the trailing 24h window", - "format": "date-time" + "description": "Event identifier", + "format": "uuid" }, - "incidentId": { + "organizationId": { + "type": "integer", + "description": "Organization this event belongs to", + "format": "int32" + }, + "runId": { "type": "string", - "description": "Incident ID for navigation; null when unknown", + "description": "Run this event belongs to", + "format": "uuid" + }, + "seq": { + "type": "integer", + "description": "Supervisor-monotonic sequence, starts at 1", + "format": "int64" + }, + "type": { + "type": "string", + "description": "Control event type", + "enum": [ + "phase", + "headline", + "case_started", + "case_finished", + "step_started", + "step_finished", + "artifact_ready", + "artifact_lifecycle", + "finished", + "stream_gap" + ] + }, + "caseId": { + "type": "string", + "description": "Case this event refers to", "format": "uuid", "nullable": true }, - "severity": { + "stepId": { "type": "string", - "description": "Optional severity display hint", + "description": "Step this event refers to", + "format": "uuid", + "nullable": true + }, + "artifactId": { + "type": "string", + "description": "Artifact this event refers to", + "format": "uuid", "nullable": true + }, + "payload": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Small typed payload for this event" + }, + "description": "Small typed payload for this event" + }, + "createdAt": { + "type": "string", + "description": "When the event was persisted", + "format": "date-time" } }, - "description": "Member incident mark for the trailing 24h uptime strip" + "description": "Run control event" }, - "ResponseSizeAssertion": { + "RunEventParams": { "type": "object", "properties": { - "type": { + "after": { + "type": "integer", + "description": "Replay events with seq greater than this value", + "format": "int64", + "nullable": true + } + } + }, + "RunEvidenceDto": { + "required": [ + "kind", + "state" + ], + "type": "object", + "properties": { + "kind": { "type": "string", + "description": "Evidence kind in SHOT → TRACE → VIDEO → NET order", "enum": [ - "response_size" + "screenshot", + "trace", + "video", + "network" ] }, - "maxBytes": { - "type": "integer", - "description": "Maximum response body size in bytes before the check fails", - "format": "int32" + "state": { + "type": "string", + "description": "Whether the artifact is usable", + "enum": [ + "present", + "bad", + "processing", + "expired" + ] } }, - "required": [ - "type", - "maxBytes" - ] + "description": "List evidence chip" }, - "ResponseTimeAssertion": { + "RunListParams": { "type": "object", "properties": { - "type": { + "phase": { "type": "string", - "enum": [ - "response_time" - ] + "description": "Filter by run phase; omit to return every phase", + "nullable": true }, - "thresholdMs": { + "outcome": { + "type": "string", + "description": "Filter by persist outcome; omit to return every outcome", + "nullable": true + }, + "region": { + "type": "string", + "description": "Filter by probe region", + "nullable": true + }, + "source": { + "type": "string", + "description": "Filter by what triggered the run", + "nullable": true + }, + "environmentId": { + "type": "string", + "description": "Only return runs whose monitor lives in this environment", + "format": "uuid", + "nullable": true + }, + "from": { + "type": "string", + "description": "Inclusive lower bound on enqueued_at (default now-30m)", + "format": "date-time", + "nullable": true + }, + "to": { + "type": "string", + "description": "Inclusive upper bound on enqueued_at (default now)", + "format": "date-time", + "nullable": true + }, + "q": { + "type": "string", + "description": "Substring match on monitor name or headline", + "nullable": true + }, + "size": { + "maximum": 100, + "minimum": 1, "type": "integer", - "description": "Maximum allowed response time in milliseconds before the check fails", + "description": "Page size (1–100, default 50)", + "format": "int32" + }, + "page": { + "minimum": 0, + "type": "integer", + "description": "Zero-based page index (default 0)", "format": "int32" } }, "required": [ - "type", - "thresholdMs" + "size", + "page" ] }, - "ResponseTimeWarnAssertion": { + "RunLiveDto": { "type": "object", "properties": { - "type": { + "stepIndex": { + "type": "integer", + "description": "Current step index", + "format": "int32", + "nullable": true + }, + "stepTitle": { "type": "string", - "enum": [ - "response_time_warn" - ] + "description": "Current step title", + "nullable": true }, - "warnMs": { + "stepCount": { "type": "integer", - "description": "HTTP response time in milliseconds that triggers a warning only", + "description": "Known step count for this attempt", "format": "int32" + }, + "artifactsUploaded": { + "type": "integer", + "description": "Artifacts already available", + "format": "int32", + "nullable": true + }, + "artifactsExpected": { + "type": "integer", + "description": "Artifacts expected for this run", + "format": "int32", + "nullable": true } }, + "description": "Live run progress", "required": [ - "type", - "warnMs" + "stepCount" ] }, - "ResultSummaryDto": { + "RunnerLogLiveEvent": { "required": [ - "chartData", - "currentStatus", - "latestPerRegion" + "line", + "ts" ], "type": "object", "properties": { - "currentStatus": { + "ts": { "type": "string", - "description": "Derived current status across all regions", - "enum": [ - "up", - "degraded", - "down", - "paused", - "unknown" - ] - }, - "latestPerRegion": { - "type": "array", - "description": "Latest check result per region", - "items": { - "$ref": "#/components/schemas/RegionStatusDto" - } - }, - "chartData": { - "type": "array", - "description": "Time-bucketed chart data for the requested window", - "items": { - "$ref": "#/components/schemas/ChartBucketDto" - } + "description": "Loki timestamp in nanoseconds" }, - "uptime24h": { - "type": "number", - "description": "Uptime percentage over the last 24 hours; null when no data", - "format": "double", - "nullable": true, - "example": 99.95 - }, - "uptimeWindow": { - "type": "number", - "description": "Uptime percentage for the selected chart window; null when no data", - "format": "double", - "nullable": true, - "example": 99.8 + "line": { + "minLength": 1, + "type": "string", + "description": "One runner-log line" } }, - "description": "Dashboard summary: current status, per-region latest results, and chart data" + "description": "Live runner-log line" }, - "RetryStrategy": { + "RunNetworkDto": { "required": [ - "type", - "maxRetries", - "interval" + "data", + "hasMore" ], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Retry strategy kind, e.g. fixed interval between attempts" + "data": { + "type": "array", + "description": "Waterfall rows on this page", + "items": { + "$ref": "#/components/schemas/NetworkRowDto" + } }, - "maxRetries": { + "caseDurationMs": { "type": "integer", - "description": "Maximum number of retries after a failed check", - "format": "int32" + "description": "Case wall time for waterfall bar scale", + "format": "int64", + "nullable": true }, - "interval": { - "type": "integer", - "description": "Delay between retry attempts in seconds", - "format": "int32" + "nextCursor": { + "type": "string", + "description": "Opaque cursor for the next page", + "nullable": true + }, + "hasMore": { + "type": "boolean", + "description": "Whether more rows exist beyond this page" } }, - "description": "Default retry strategy for member monitors; null clears" + "description": "Network waterfall page" }, - "RootlyChannelConfig": { - "required": [ - "channelType", - "apiKey" - ], + "RunNetworkParams": { "type": "object", "properties": { - "channelType": { + "attempt": { + "type": "integer", + "description": "In-check attempt (default selected attempt)", + "format": "int32", + "nullable": true + }, + "failed": { + "type": "boolean", + "description": "Only rows with status >= 400 or a failure", + "nullable": true + }, + "slow": { + "type": "boolean", + "description": "Only rows with durationMs >= 1000", + "nullable": true + }, + "stepId": { "type": "string", - "enum": [ - "rootly" - ] + "description": "Only rows for this step", + "nullable": true }, - "apiKey": { - "minLength": 1, + "xhr": { + "type": "boolean", + "description": "Only xhr, fetch, and api resource types", + "nullable": true + }, + "source": { "type": "string", - "description": "Rootly API token with incident creation permission" + "description": "page or request", + "nullable": true }, - "severity": { + "cursor": { "type": "string", - "description": "Severity slug override (e.g. sev0, sev1)", + "description": "Opaque cursor from the previous page", "nullable": true } } }, - "RuleEvaluationDto": { + "RunStepDto": { "required": [ - "checkId", - "engineVersion", - "evaluationDetails", + "caseId", + "category", "id", - "inputResultIds", - "monitorId", - "occurredAt", - "policySnapshotHashHex", - "region", - "ruleScope", - "ruleType", - "ruleIndex", - "outputMatched" + "runId", + "status", + "title", + "organizationId", + "attempt", + "index" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Forensic row UUID", + "description": "Step identifier", "format": "uuid" }, - "occurredAt": { - "type": "string", - "description": "When the evaluation ran", - "format": "date-time" + "organizationId": { + "type": "integer", + "description": "Organization this step belongs to", + "format": "int32" }, - "monitorId": { + "runId": { "type": "string", - "description": "Monitor that produced the input check result", + "description": "Run this step belongs to", "format": "uuid" }, - "region": { - "minLength": 1, + "caseId": { "type": "string", - "description": "Probe region of the input check result" + "description": "Case this step belongs to", + "format": "uuid" }, - "policySnapshotHashHex": { - "minLength": 1, - "type": "string", - "description": "Hex-encoded hash of the policy snapshot this rule came from" + "attempt": { + "type": "integer", + "description": "Playwright in-case attempt number", + "format": "int32" }, - "ruleIndex": { + "index": { "type": "integer", - "description": "Index into the policy's triggerRules array (0-based)", + "description": "Zero-based index within the case attempt", "format": "int32" }, - "ruleType": { - "minLength": 1, + "title": { "type": "string", - "description": "Rule type (e.g. consecutive_failures, failures_in_window)" + "description": "Step title" }, - "ruleScope": { - "minLength": 1, + "category": { "type": "string", - "description": "Rule scope (per_region | multi_region)" + "description": "Step category", + "enum": [ + "named", + "assertion", + "browser_action" + ] }, - "inputResultIds": { - "minItems": 1, - "type": "array", - "description": "check_results IDs that were inputs to this evaluation (newest first)", - "items": { - "type": "string", - "description": "check_results IDs that were inputs to this evaluation (newest first)", - "format": "uuid" - } + "status": { + "type": "string", + "description": "Step status", + "enum": [ + "pending", + "running", + "passed", + "slow", + "failed", + "skipped", + "suppressed", + "never_reached" + ] }, - "outputMatched": { - "type": "boolean", - "description": "Whether the rule fired on this evaluation" + "startedAt": { + "type": "string", + "description": "When the step started", + "format": "date-time", + "nullable": true }, - "evaluationDetails": { + "finishedAt": { + "type": "string", + "description": "When the step finished", + "format": "date-time", + "nullable": true + }, + "durationMs": { + "type": "integer", + "description": "Reporter duration in milliseconds", + "format": "int32", + "nullable": true + }, + "error": { + "type": "string", + "description": "Error when the step failed", + "nullable": true + }, + "assertion": { "type": "object", "additionalProperties": { "type": "object", - "description": "Structured details (e.g. failure counts, response-time aggregates)" + "description": "Assertion payload when this step is an assertion", + "nullable": true }, - "description": "Structured details (e.g. failure counts, response-time aggregates)" - }, - "engineVersion": { - "minLength": 1, - "type": "string", - "description": "Detection engine version that ran this evaluation" + "description": "Assertion payload when this step is an assertion", + "nullable": true + } + }, + "description": "Run step" + }, + "RunTabCountsDto": { + "type": "object", + "properties": { + "steps": { + "type": "integer", + "description": "Step rows for the selected attempt", + "format": "int32" }, - "checkId": { - "type": "string", - "description": "Scheduler-minted check execution ID (V92) — the causal chain identifier", - "format": "uuid" + "assets": { + "type": "integer", + "description": "Items across asset kinds, excluding dead no-browser rows", + "format": "int32" }, - "triggeringTransitionId": { - "type": "string", - "description": "If this evaluation caused a state transition, points to that transition's id", - "format": "uuid", - "nullable": true + "diff": { + "type": "integer", + "description": "1 when a diff baseline exists or this run passed on retry", + "format": "int32" } }, - "description": "All rule evaluations that ran for this check" + "description": "Run detail tab counts", + "required": [ + "steps", + "assets", + "diff" + ] }, "ScheduledMaintenanceDto": { "required": [ @@ -34642,27 +41540,55 @@ "description": "A scheduled maintenance window from a vendor status page" }, "ScriptMonitorConfig": { - "required": [ - "script" - ], "type": "object", + "additionalProperties": false, "properties": { "script": { "maxLength": 65536, - "minLength": 1, + "minLength": 0, "type": "string", - "description": "Playwright test script source code" + "description": "Legacy inline script on existing rows", + "nullable": true, + "readOnly": true }, "timeoutSeconds": { - "maximum": 120, + "maximum": 240, "minimum": 5, "type": "integer", - "description": "Maximum execution time in seconds (5–120)", + "description": "Maximum execution time in seconds (5–240)", "format": "int32", "nullable": true + }, + "runtimeId": { + "maxLength": 32, + "minLength": 0, + "pattern": "^$|^[A-Za-z0-9._-]+$", + "type": "string", + "description": "Runtime pin YYYY.MM; omit uses workspace default then sole available", + "nullable": true } } }, + "SecretAuditDto": { + "type": "object", + "properties": { + "updatedAt": { + "type": "string", + "description": "When this secret was last updated", + "format": "date-time", + "nullable": true + }, + "updatedBy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/UserDto" + } + ] + } + }, + "description": "Last update time and author for a secret" + }, "SecretDto": { "required": [ "createdAt", @@ -34704,14 +41630,69 @@ }, "usedByMonitors": { "type": "array", - "description": "Monitors that reference this secret; null on create/update responses", + "description": "Monitors that reference this secret for authentication", "nullable": true, "items": { "$ref": "#/components/schemas/MonitorReference" } } }, - "description": "Secret with change-detection hash; plaintext value is never returned" + "description": "Organization secret and its change-detection hash" + }, + "SecretRequestDto": { + "required": [ + "key", + "readiness" + ], + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Secret key this monitor requires" + }, + "secret": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/SecretDto" + } + ] + }, + "readiness": { + "type": "string", + "description": "Whether this key is resolved or missing", + "enum": [ + "resolved", + "missing" + ] + }, + "fulfilledBy": { + "type": "string", + "description": "Fulfilled from environment variables or a secret", + "nullable": true, + "enum": [ + "env", + "secret" + ] + } + }, + "description": "Secret key a monitor requires and how it is fulfilled" + }, + "SecretUsageDto": { + "required": [ + "monitors" + ], + "type": "object", + "properties": { + "monitors": { + "type": "array", + "description": "Monitors that reference this secret", + "items": { + "$ref": "#/components/schemas/MonitorDto" + } + } + }, + "description": "Monitors that reference this secret" }, "SeoMetadataDto": { "type": "object", @@ -35867,6 +42848,28 @@ } } }, + "SingleValueResponseDefinitionDetailDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DefinitionDetailDto" + } + } + }, + "SingleValueResponseDefinitionHeadDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DefinitionHeadDto" + } + } + }, "SingleValueResponseDekRotationResultDto": { "required": [ "data" @@ -36037,6 +43040,28 @@ } } }, + "SingleValueResponseMonitorSecretRequestsDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MonitorSecretRequestsDto" + } + } + }, + "SingleValueResponseMonitorSessionDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MonitorSessionDto" + } + } + }, "SingleValueResponseMonitorTestResultDto": { "required": [ "data" @@ -36059,6 +43084,17 @@ } } }, + "SingleValueResponseNetworkRowDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NetworkRowDto" + } + } + }, "SingleValueResponseNotificationDispatchDto": { "required": [ "data" @@ -36092,6 +43128,17 @@ } } }, + "SingleValueResponsePackageUploadDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PackageUploadDto" + } + } + }, "SingleValueResponsePolicySnapshotDto": { "required": [ "data" @@ -36147,6 +43194,72 @@ } } }, + "SingleValueResponseRevisionDiffDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RevisionDiffDto" + } + } + }, + "SingleValueResponseRevisionDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RevisionDto" + } + } + }, + "SingleValueResponseRollbackPreviewDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RollbackPreviewDto" + } + } + }, + "SingleValueResponseRunConsoleDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RunConsoleDto" + } + } + }, + "SingleValueResponseRunDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RunDto" + } + } + }, + "SingleValueResponseSecretAuditDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SecretAuditDto" + } + } + }, "SingleValueResponseSecretDto": { "required": [ "data" @@ -36158,6 +43271,17 @@ } } }, + "SingleValueResponseSecretUsageDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SecretUsageDto" + } + } + }, "SingleValueResponseServiceDayDetailDto": { "required": [ "data" @@ -36658,6 +43782,10 @@ } }, "SslExpiryAssertion": { + "required": [ + "type", + "minDaysRemaining" + ], "type": "object", "properties": { "type": { @@ -36671,11 +43799,7 @@ "description": "Minimum days before TLS certificate expiry; fails or warns below this threshold", "format": "int32" } - }, - "required": [ - "type", - "minDaysRemaining" - ] + } }, "StateTransitionDetails": { "required": [ @@ -37822,10 +44946,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -37858,10 +44978,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -37894,10 +45010,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -37930,10 +45042,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -37966,10 +45074,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38002,9 +45106,37 @@ "type": "integer", "format": "int32", "nullable": true + } + } + }, + "TableValueResultDefinitionDto": { + "required": [ + "data", + "hasNext", + "hasPrev" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DefinitionDto" + } }, - "nextCursor": { - "type": "string", + "hasNext": { + "type": "boolean" + }, + "hasPrev": { + "type": "boolean" + }, + "totalElements": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "totalPages": { + "type": "integer", + "format": "int32", "nullable": true } } @@ -38038,10 +45170,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38074,10 +45202,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38110,10 +45234,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38146,10 +45266,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38182,10 +45298,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38218,10 +45330,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38254,10 +45362,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38290,10 +45394,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38326,10 +45426,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38362,10 +45458,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38398,10 +45490,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38434,10 +45522,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38470,10 +45554,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38506,9 +45586,37 @@ "type": "integer", "format": "int32", "nullable": true + } + } + }, + "TableValueResultRevisionDto": { + "required": [ + "data", + "hasNext", + "hasPrev" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RevisionDto" + } }, - "nextCursor": { - "type": "string", + "hasNext": { + "type": "boolean" + }, + "hasPrev": { + "type": "boolean" + }, + "totalElements": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "totalPages": { + "type": "integer", + "format": "int32", "nullable": true } } @@ -38542,14 +45650,42 @@ "type": "integer", "format": "int32", "nullable": true + } + } + }, + "TableValueResultRunArtifactDto": { + "required": [ + "data", + "hasNext", + "hasPrev" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RunArtifactDto" + } }, - "nextCursor": { - "type": "string", + "hasNext": { + "type": "boolean" + }, + "hasPrev": { + "type": "boolean" + }, + "totalElements": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "totalPages": { + "type": "integer", + "format": "int32", "nullable": true } } }, - "TableValueResultScheduledMaintenanceDto": { + "TableValueResultRunCaseDto": { "required": [ "data", "hasNext", @@ -38560,7 +45696,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledMaintenanceDto" + "$ref": "#/components/schemas/RunCaseDto" } }, "hasNext": { @@ -38578,14 +45714,42 @@ "type": "integer", "format": "int32", "nullable": true + } + } + }, + "TableValueResultRunDto": { + "required": [ + "data", + "hasNext", + "hasPrev" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RunDto" + } }, - "nextCursor": { - "type": "string", + "hasNext": { + "type": "boolean" + }, + "hasPrev": { + "type": "boolean" + }, + "totalElements": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "totalPages": { + "type": "integer", + "format": "int32", "nullable": true } } }, - "TableValueResultSecretDto": { + "TableValueResultScheduledMaintenanceDto": { "required": [ "data", "hasNext", @@ -38596,7 +45760,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SecretDto" + "$ref": "#/components/schemas/ScheduledMaintenanceDto" } }, "hasNext": { @@ -38614,9 +45778,37 @@ "type": "integer", "format": "int32", "nullable": true + } + } + }, + "TableValueResultSecretDto": { + "required": [ + "data", + "hasNext", + "hasPrev" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecretDto" + } + }, + "hasNext": { + "type": "boolean" + }, + "hasPrev": { + "type": "boolean" + }, + "totalElements": { + "type": "integer", + "format": "int64", + "nullable": true }, - "nextCursor": { - "type": "string", + "totalPages": { + "type": "integer", + "format": "int32", "nullable": true } } @@ -38650,10 +45842,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38686,10 +45874,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38722,10 +45906,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38758,10 +45938,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38794,10 +45970,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38830,10 +46002,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38866,10 +46034,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38902,10 +46066,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38938,10 +46098,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38974,10 +46130,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39010,10 +46162,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39046,10 +46194,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39082,10 +46226,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39118,10 +46258,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39154,10 +46290,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39190,10 +46322,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39729,6 +46857,80 @@ }, "description": "TLS/SSL certificate details for HTTPS targets" }, + "TraceEntryPoint": { + "required": [ + "actionIndex", + "id", + "label", + "note" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Doorway id", + "enum": [ + "failing_action", + "failing_step", + "first_failed_request", + "case_start" + ] + }, + "actionIndex": { + "type": "integer", + "description": "Action index this doorway opens", + "format": "int32" + }, + "label": { + "minLength": 1, + "type": "string", + "description": "Label shown on the doorway" + }, + "note": { + "minLength": 1, + "type": "string", + "description": "Short note for why this doorway exists" + } + }, + "description": "Four doorways into the downloaded file" + }, + "TraceNearbyAction": { + "required": [ + "actionIndex", + "kind", + "title", + "isTeardown" + ], + "type": "object", + "properties": { + "actionIndex": { + "type": "integer", + "description": "Action index in the Playwright trace", + "format": "int32" + }, + "kind": { + "minLength": 1, + "type": "string", + "description": "Playwright action kind" + }, + "title": { + "minLength": 1, + "type": "string", + "description": "Human title for this action" + }, + "durationMs": { + "type": "integer", + "description": "Action duration in milliseconds", + "format": "int32", + "nullable": true + }, + "isTeardown": { + "type": "boolean", + "description": "Whether this action is teardown" + } + }, + "description": "Actions around the failure, teardown labelled" + }, "TriggerRule": { "required": [ "scope", @@ -40474,7 +47676,7 @@ "maxLength": 255, "minLength": 0, "type": "string", - "description": "New monitor name; null preserves current", + "description": "New monitor name. Null preserves current", "nullable": true }, "config": { @@ -40507,27 +47709,27 @@ "maximum": 86400, "minimum": 10, "type": "integer", - "description": "New check frequency in seconds (10–86400); null preserves current", + "description": "New check frequency in seconds (10–86400). Null preserves current", "format": "int32", "nullable": true }, "enabled": { "type": "boolean", - "description": "Enable or disable the monitor; null preserves current", + "description": "Enable or disable the monitor (pause or resume). Null preserves current", "nullable": true }, "regions": { "type": "array", - "description": "New probe regions; null preserves current. Allowed values are deployment-dependent.", + "description": "New probe regions. Null preserves current. Allowed values are deployment-dependent", "nullable": true, "items": { "type": "string", - "description": "New probe regions; null preserves current. Allowed values are deployment-dependent." + "description": "New probe regions. Null preserves current. Allowed values are deployment-dependent" } }, "managedBy": { "type": "string", - "description": "New ownership source: DASHBOARD, CLI, TERRAFORM, MCP, or API; null preserves current value", + "description": "New ownership source: DASHBOARD, CLI, TERRAFORM, MCP, or API. Null preserves current", "nullable": true, "enum": [ "DASHBOARD", @@ -40539,7 +47741,7 @@ }, "environmentId": { "type": "string", - "description": "New environment ID; null preserves current (use clearEnvironmentId to unset)", + "description": "New environment; null preserves current", "format": "uuid", "nullable": true }, @@ -40550,7 +47752,7 @@ }, "assertions": { "type": "array", - "description": "Replace all assertions; null preserves current", + "description": "Replace all assertions. Null preserves current", "nullable": true, "items": { "$ref": "#/components/schemas/CreateAssertionRequest" @@ -40579,11 +47781,11 @@ }, "alertChannelIds": { "type": "array", - "description": "Replace alert channel list; null preserves current", + "description": "Replace alert channel list. Null preserves current", "nullable": true, "items": { "type": "string", - "description": "Replace alert channel list; null preserves current", + "description": "Replace alert channel list. Null preserves current", "format": "uuid" } }, @@ -40594,6 +47796,35 @@ "$ref": "#/components/schemas/AddMonitorTagsRequest" } ] + }, + "capturePolicy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/CapturePolicy" + } + ] + }, + "fastRetryMaxAttempts": { + "maximum": 10, + "minimum": 0, + "type": "integer", + "description": "Fast-retry attempts after failure. Null preserves current. 0 disables", + "format": "int32", + "nullable": true + }, + "package": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/MonitorPackageSpec" + } + ] + }, + "status": { + "type": "string", + "description": "Not writable; use pause or resume", + "nullable": true } } }, @@ -41508,6 +48739,35 @@ "channelType" ] }, + "UpsertMonitorSessionRequest": { + "required": [ + "reusePolicy", + "setupFile" + ], + "type": "object", + "properties": { + "reusePolicy": { + "type": "string", + "description": "When to reuse the cached session across runs", + "enum": [ + "reuse", + "every_run", + "on_failure" + ] + }, + "setupFile": { + "minLength": 1, + "type": "string", + "description": "Setup file path inside the package zip" + }, + "expiresAt": { + "type": "string", + "description": "When the cached session expires; null preserves current", + "format": "date-time", + "nullable": true + } + } + }, "UptimeBucketDto": { "required": [ "timestamp", @@ -41594,6 +48854,73 @@ "incidentCount" ] }, + "UserDto": { + "required": [ + "createdAt", + "email", + "updatedAt", + "userRole", + "id", + "emailVerified" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique user identifier", + "format": "int32" + }, + "email": { + "type": "string", + "description": "User email address" + }, + "emailVerified": { + "type": "boolean", + "description": "Whether the email address has been verified" + }, + "name": { + "type": "string", + "description": "Display name; null if not set", + "nullable": true + }, + "userRole": { + "type": "string", + "description": "Platform role: USER or SUPERADMIN", + "enum": [ + "SUPERADMIN", + "ADMIN", + "USER" + ] + }, + "onboardingStage": { + "type": "string", + "description": "Current onboarding progress stage; null when completed", + "nullable": true, + "enum": [ + "WELCOME", + "FIRST_MONITOR", + "SETUP_COMPLETE", + "COMPLETED" + ] + }, + "imageUrl": { + "type": "string", + "description": "Profile image URL; null if not set", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "Timestamp when the account was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "Timestamp when the account was last updated", + "format": "date-time" + } + }, + "description": "User account details" + }, "VoiceLanguageDto": { "required": [ "code", @@ -41905,6 +49232,19 @@ }, "description": "Workspace within an organization" }, + "WriteSecretEnvironmentValueRequest": { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "minLength": 1, + "type": "string", + "description": "Plaintext value to encrypt for this environment" + } + } + }, "ZapierChannelConfig": { "required": [ "channelType", diff --git a/uv.lock b/uv.lock index c9ed256..b252a9e 100644 --- a/uv.lock +++ b/uv.lock @@ -401,7 +401,7 @@ wheels = [ [[package]] name = "devhelm-mcp-server" -version = "1.6.0" +version = "1.7.0" source = { editable = "." } dependencies = [ { name = "devhelm" },