From 4e800608ea856e759c333d70b7fff01d68c6e794 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 2 Sep 2026 12:21:29 +0000 Subject: [PATCH] chore: update generated API types from latest spec --- docs/openapi/monitoring-api.json | 27057 ++++++++++++++++++----------- src/devhelm/_generated.py | 1437 +- 2 files changed, 18141 insertions(+), 10353 deletions(-) diff --git a/docs/openapi/monitoring-api.json b/docs/openapi/monitoring-api.json index 146f30f..04c272b 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,47 @@ } } }, - "/api/v1/status-pages": { + "/api/v1/runs/{id}/events": { "get": { "tags": [ - "Status Pages" + "Runs" + ], + "summary": "Stream run control events", + "operationId": "streamRunEvents", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "params", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/RunEventParams" + } + }, + { + "name": "Last-Event-ID", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } ], - "summary": "List status pages for the workspace", - "operationId": "list_4", "responses": { "200": { - "description": "OK", + "description": "Server-sent persist control events", "content": { - "*/*": { + "text/event-stream": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageDto" + "$ref": "#/components/schemas/RunEventDto" } } } @@ -17158,30 +17585,34 @@ } } } - }, - "post": { + } + }, + "/api/v1/runs/{id}/runner-log": { + "get": { "tags": [ - "Status Pages" + "Runs" ], - "summary": "Create a status page", - "operationId": "create_5", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStatusPageRequest" - } + "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", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } - }, - "required": true - }, + } + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { - "*/*": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" + "type": "string" } } } @@ -17269,13 +17700,14 @@ } } }, - "/api/v1/status-pages/{id}": { + "/api/v1/runs/{id}/runner-log/live": { "get": { "tags": [ - "Status Pages" + "Runs" ], - "summary": "Get a status page", - "operationId": "get_2", + "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", @@ -17289,11 +17721,11 @@ ], "responses": { "200": { - "description": "OK", + "description": "Server-sent runner-log lines", "content": { - "*/*": { + "text/event-stream": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" + "$ref": "#/components/schemas/RunnerLogLiveEvent" } } } @@ -17379,41 +17811,131 @@ } } } - }, - "put": { + } + }, + "/api/v1/secrets": { + "get": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Update a status page", - "operationId": "update_3", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "List organization 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" + } + } } } + } + }, + "post": { + "tags": [ + "Secrets" ], + "summary": "Create secret", + "operationId": "create_6", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateStatusPageRequest" + "$ref": "#/components/schemas/CreateSecretRequest" } } }, "required": true }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" + "$ref": "#/components/schemas/SingleValueResponseSecretDto" } } } @@ -17499,27 +18021,45 @@ } } } - }, - "delete": { + } + }, + "/api/v1/secrets/{key}": { + "put": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Delete a status page", - "operationId": "delete_3", + "summary": "Update secret", + "operationId": "update_4", "parameters": [ { - "name": "id", + "name": "key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSecretRequest" + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseSecretDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -17602,36 +18142,26 @@ } } } - } - }, - "/api/v1/status-pages/{id}/components": { - "get": { + }, + "delete": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "List all components", - "operationId": "listComponents", + "summary": "Delete secret", + "operationId": "delete_4", "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/TableValueResultStatusPageComponentDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -17714,41 +18244,32 @@ } } } - }, - "post": { + } + }, + "/api/v1/secrets/{key}/audit": { + "get": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Add a component to the status page", - "operationId": "createComponent", + "summary": "Last update metadata for a secret", + "operationId": "audit", "parameters": [ { - "name": "id", + "name": "key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStatusPageComponentRequest" - } - } - }, - "required": true - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" + "$ref": "#/components/schemas/SingleValueResponseSecretAuditDto" } } } @@ -17836,25 +18357,24 @@ } } }, - "/api/v1/status-pages/{id}/components/{componentId}": { + "/api/v1/secrets/{key}/environments/{environmentId}": { "put": { "tags": [ - "Status Pages" + "Secrets" ], - "summary": "Update a component", - "operationId": "updateComponent", + "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": { @@ -17867,131 +18387,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateStatusPageComponentRequest" + "$ref": "#/components/schemas/WriteSecretEnvironmentValueRequest" } } }, "required": true }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" - } - } - } - }, - "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": "Remove a component from the status page", - "operationId": "deleteComponent", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "componentId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], "responses": { "204": { "description": "No Content" @@ -18079,41 +18480,20 @@ } } }, - "/api/v1/status-pages/{id}/components/{componentId}/measured-uptime": { + "/api/v1/secrets/{key}/usage": { "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": "Secret usage across monitors", + "operationId": "usage", "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 +18503,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageMeasuredComponentUptimeDto" + "$ref": "#/components/schemas/SingleValueResponseSecretUsageDto" } } } @@ -18211,51 +18591,20 @@ } } }, - "/api/v1/status-pages/{id}/components/{componentId}/override": { - "put": { + "/api/v1/service-subscriptions": { + "get": { "tags": [ - "Status Pages" - ], - "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", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "componentId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Service Subscriptions" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetStatusPageComponentOverrideRequest" - } - } - }, - "required": true - }, + "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" } } } @@ -18341,13 +18690,15 @@ } } } - }, - "delete": { + } + }, + "/api/v1/service-subscriptions/{id}": { + "get": { "tags": [ - "Status Pages" + "Service Subscriptions" ], - "summary": "Clear a timed human status override on a component", - "operationId": "clearComponentOverride", + "summary": "Get a subscription by its ID", + "operationId": "get_11", "parameters": [ { "name": "id", @@ -18357,15 +18708,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "componentId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "responses": { @@ -18374,7 +18716,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" + "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" } } } @@ -18460,16 +18802,14 @@ } } } - } - }, - "/api/v1/status-pages/{id}/components/{componentId}/uptime": { - "get": { + }, + "delete": { "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": "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", @@ -18479,37 +18819,11 @@ "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": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TableValueResultComponentUptimeDayDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -18594,13 +18908,14 @@ } } }, - "/api/v1/status-pages/{id}/components/reorder": { - "put": { + "/api/v1/service-subscriptions/{id}/alert-sensitivity": { + "patch": { "tags": [ - "Status Pages" + "Service Subscriptions" ], - "summary": "Batch reorder components (and optionally move between groups)", - "operationId": "reorderComponents", + "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", @@ -18616,15 +18931,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReorderComponentsRequest" + "$ref": "#/components/schemas/UpdateAlertSensitivityRequest" } } }, "required": true }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -18709,31 +19031,40 @@ } } }, - "/api/v1/status-pages/{id}/domains": { - "get": { + "/api/v1/service-subscriptions/{slug}": { + "post": { "tags": [ - "Status Pages" + "Service Subscriptions" ], - "summary": "List custom domains", - "operationId": "listDomains", + "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" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceSubscribeRequest" + } + } + } + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageCustomDomainDto" + "$ref": "#/components/schemas/SingleValueResponseServiceSubscriptionDto" } } } @@ -18819,41 +19150,98 @@ } } } - }, - "post": { + } + }, + "/api/v1/services": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Add a custom domain", - "operationId": "addDomain", + "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" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddCustomDomainRequest" - } + }, + { + "name": "status", + "in": "query", + "description": "Filter by current overall_status (exact match)", + "required": false, + "schema": { + "type": "string" } }, - "required": true - }, + { + "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": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" + "$ref": "#/components/schemas/CursorPageServiceCatalogDto" } } } @@ -18941,36 +19329,54 @@ } } }, - "/api/v1/status-pages/{id}/domains/{domainId}": { - "delete": { + "/api/v1/services/{slugOrId}": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Remove a custom domain", - "operationId": "removeDomain", + "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 } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseServiceDetailDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -19055,31 +19461,61 @@ } } }, - "/api/v1/status-pages/{id}/domains/{domainId}/primary": { - "post": { + "/api/v1/services/{slugOrId}/components": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Mark a verified custom domain as the page's primary host", - "operationId": "setPrimaryDomain", + "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": { @@ -19088,7 +19524,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" + "$ref": "#/components/schemas/TableValueResultServiceComponentDto" } } } @@ -19176,31 +19612,66 @@ } } }, - "/api/v1/status-pages/{id}/domains/{domainId}/verify": { - "post": { + "/api/v1/services/{slugOrId}/components/{componentId}/uptime": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Trigger domain verification check", - "operationId": "verifyDomain", + "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", - "format": "uuid" + "type": "string" } }, { - "name": "domainId", + "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": { @@ -19209,7 +19680,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" + "$ref": "#/components/schemas/TableValueResultComponentUptimeDayDto" } } } @@ -19297,21 +19768,56 @@ } } }, - "/api/v1/status-pages/{id}/groups": { + "/api/v1/services/{slugOrId}/components/uptime": { "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "List component groups with nested components", - "operationId": "listGroups", + "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" + ] + } + }, + { + "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" } } ], @@ -19321,7 +19827,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageComponentGroupDto" + "$ref": "#/components/schemas/SingleValueResponseBatchComponentUptimeDto" } } } @@ -19407,41 +19913,43 @@ } } } - }, - "post": { + } + }, + "/api/v1/services/{slugOrId}/days/{date}": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Create a component group", - "operationId": "createGroup", + "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" + } + }, + { + "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/CreateStatusPageComponentGroupRequest" - } - } - }, - "required": true - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentGroupDto" + "$ref": "#/components/schemas/SingleValueResponseServiceDayDetailDto" } } } @@ -19529,50 +20037,61 @@ } } }, - "/api/v1/status-pages/{id}/groups/{groupId}": { - "put": { + "/api/v1/services/{slugOrId}/incidents": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Update a component group", - "operationId": "updateGroup", + "summary": "List incident history for a service (paginated)", + "operationId": "listIncidents_1", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "from", + "in": "query", + "description": "Earliest start date (ISO 8601 date)", + "required": false, "schema": { "type": "string", - "format": "uuid" + "format": "date" } }, { - "name": "groupId", - "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": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateStatusPageComponentGroupRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentGroupDto" + "$ref": "#/components/schemas/TableValueResultServiceIncidentDto" } } } @@ -19658,25 +20177,26 @@ } } } - }, - "delete": { + } + }, + "/api/v1/services/{slugOrId}/incidents/{incidentId}": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Delete a component group (components become ungrouped)", - "operationId": "deleteGroup", + "summary": "Get incident detail with full update timeline", + "operationId": "getIncident_1", "parameters": [ { - "name": "id", + "name": "slugOrId", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "groupId", + "name": "incidentId", "in": "path", "required": true, "schema": { @@ -19686,8 +20206,15 @@ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseServiceIncidentDetailDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -19772,46 +20299,21 @@ } } }, - "/api/v1/status-pages/{id}/incidents": { + "/api/v1/services/{slugOrId}/live-status": { "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "List incidents for this status page (paginated)", - "operationId": "listIncidents", + "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", + "name": "slugOrId", "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" + "type": "string" } } ], @@ -19821,7 +20323,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseServiceLiveStatusDto" } } } @@ -19907,41 +20409,44 @@ } } } - }, - "post": { + } + }, + "/api/v1/services/{slugOrId}/maintenances": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Create a status page incident (manual)", - "operationId": "createIncident", + "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" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStatusPageIncidentRequest" + }, + { + "name": "status", + "in": "query", + "description": "Filter by status (e.g. scheduled, in_progress, verifying, completed)", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" } } - }, - "required": true - }, + } + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/TableValueResultScheduledMaintenanceDto" } } } @@ -20029,30 +20534,40 @@ } } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}": { + "/api/v1/services/{slugOrId}/poll-results": { "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Get incident details with timeline", - "operationId": "getIncident", + "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 } } ], @@ -20062,7 +20577,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/CursorPageServicePollResultDto" } } } @@ -20148,50 +20663,46 @@ } } } - }, - "put": { + } + }, + "/api/v1/services/{slugOrId}/poll-summary": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Update an incident", - "operationId": "updateIncident", + "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" + ] } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateStatusPageIncidentRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseServicePollSummaryDto" } } } @@ -20277,36 +20788,99 @@ } } } - }, - "delete": { + } + }, + "/api/v1/services/{slugOrId}/status-events": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Delete an incident", - "operationId": "deleteIncident", + "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" + } + }, + { + "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": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CursorPageStatusEventDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -20391,36 +20965,66 @@ } } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}/dismiss": { - "post": { + "/api/v1/services/{slugOrId}/uptime": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Dismiss a draft incident (soft-deletes: resolves without publishing)", - "operationId": "dismissIncident", + "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" + ] } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseServiceUptimeResponse" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -20502,52 +21106,71 @@ } } } - } + }, + "security": [ + { + "BearerAuth": [] + } + ] } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}/publish": { - "post": { + "/api/v1/services/incidents": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Publish a draft incident (sets publishedAt, applies component statuses, notifies subscribers)", - "operationId": "publishIncident", + "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" + ] } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublishStatusPageIncidentRequest" - } + }, + { + "name": "category", + "in": "query", + "description": "Filter by service category", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/Pageable" } } - }, + ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/TableValueResultServiceIncidentDto" } } } @@ -20635,50 +21258,33 @@ } } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}/updates": { - "post": { + "/api/v1/services/summary": { + "get": { "tags": [ - "Status Pages" + "Status Data" ], - "summary": "Post an incident timeline update", - "operationId": "postIncidentUpdate", + "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, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "incidentId", - "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/CreateStatusPageIncidentUpdateRequest" - } - } - }, - "required": true - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseGlobalStatusSummaryDto" } } } @@ -20766,59 +21372,20 @@ } } }, - "/api/v1/status-pages/{id}/incidents/{incidentId}/updates/{updateId}": { - "patch": { + "/api/v1/status-pages": { + "get": { "tags": [ "Status Pages" ], - "summary": "Edit an existing incident timeline update body", - "operationId": "patchIncidentUpdate", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "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 - }, + "summary": "List status pages for the workspace", + "operationId": "list_4", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentUpdateDto" + "$ref": "#/components/schemas/TableValueResultStatusPageDto" } } } @@ -20904,39 +21471,33 @@ } } } - } - }, - "/api/v1/status-pages/{id}/layout/reorder": { - "put": { + }, + "post": { "tags": [ "Status Pages" ], - "summary": "Reorder page-level layout: groups and ungrouped components share one ordering", - "operationId": "reorderLayout", - "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/ReorderPageLayoutRequest" + "$ref": "#/components/schemas/CreateStatusPageRequest" } } }, "required": true }, "responses": { - "204": { - "description": "No Content" + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -21021,13 +21582,13 @@ } } }, - "/api/v1/status-pages/{id}/maintenance": { + "/api/v1/status-pages/{id}": { "get": { "tags": [ "Status Pages" ], - "summary": "List maintenance windows for this status page (paginated)", - "operationId": "listMaintenance", + "summary": "Get a status page", + "operationId": "get_2", "parameters": [ { "name": "id", @@ -21037,31 +21598,6 @@ "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": { @@ -21070,7 +21606,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" } } } @@ -21157,12 +21693,12 @@ } } }, - "post": { + "put": { "tags": [ "Status Pages" ], - "summary": "Schedule a maintenance window", - "operationId": "createMaintenance", + "summary": "Update a status page", + "operationId": "update_3", "parameters": [ { "name": "id", @@ -21178,19 +21714,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateStatusPageMaintenanceRequest" + "$ref": "#/components/schemas/UpdateStatusPageRequest" } } }, "required": true }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageDto" } } } @@ -21276,15 +21812,13 @@ } } } - } - }, - "/api/v1/status-pages/{id}/maintenance/{windowId}": { - "get": { + }, + "delete": { "tags": [ "Status Pages" ], - "summary": "Get a maintenance window with timeline", - "operationId": "getMaintenance", + "summary": "Delete a status page", + "operationId": "delete_3", "parameters": [ { "name": "id", @@ -21294,27 +21828,11 @@ "type": "string", "format": "uuid" } - }, - { - "name": "windowId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -21397,13 +21915,15 @@ } } } - }, - "put": { + } + }, + "/api/v1/status-pages/{id}/components": { + "get": { "tags": [ "Status Pages" ], - "summary": "Update a maintenance window", - "operationId": "updateMaintenance", + "summary": "List all components", + "operationId": "listComponents", "parameters": [ { "name": "id", @@ -21413,34 +21933,15 @@ "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" + "$ref": "#/components/schemas/TableValueResultStatusPageComponentDto" } } } @@ -21527,12 +22028,12 @@ } } }, - "delete": { + "post": { "tags": [ "Status Pages" ], - "summary": "Cancel a maintenance window", - "operationId": "deleteMaintenance", + "summary": "Add a component to the status page", + "operationId": "createComponent", "parameters": [ { "name": "id", @@ -21542,20 +22043,28 @@ "type": "string", "format": "uuid" } - }, - { - "name": "windowId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], + "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", @@ -21640,13 +22149,13 @@ } } }, - "/api/v1/status-pages/{id}/maintenance/{windowId}/dismiss": { - "post": { + "/api/v1/status-pages/{id}/components/{componentId}": { + "put": { "tags": [ "Status Pages" ], - "summary": "Dismiss a draft maintenance window", - "operationId": "dismissMaintenance", + "summary": "Update a component", + "operationId": "updateComponent", "parameters": [ { "name": "id", @@ -21658,7 +22167,7 @@ } }, { - "name": "windowId", + "name": "componentId", "in": "path", "required": true, "schema": { @@ -21667,9 +22176,26 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateStatusPageComponentRequest" + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -21752,15 +22278,13 @@ } } } - } - }, - "/api/v1/status-pages/{id}/maintenance/{windowId}/publish": { - "post": { + }, + "delete": { "tags": [ "Status Pages" ], - "summary": "Publish a draft maintenance window", - "operationId": "publishMaintenance", + "summary": "Remove a component from the status page", + "operationId": "deleteComponent", "parameters": [ { "name": "id", @@ -21772,7 +22296,7 @@ } }, { - "name": "windowId", + "name": "componentId", "in": "path", "required": true, "schema": { @@ -21781,25 +22305,9 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublishStatusPageIncidentRequest" - } - } - } - }, "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -21884,13 +22392,14 @@ } } }, - "/api/v1/status-pages/{id}/maintenance/{windowId}/updates": { - "post": { + "/api/v1/status-pages/{id}/components/{componentId}/measured-uptime": { + "get": { "tags": [ "Status Pages" ], - "summary": "Post a maintenance window timeline update", - "operationId": "postMaintenanceUpdate", + "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", @@ -21902,32 +22411,32 @@ } }, { - "name": "windowId", + "name": "componentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "days", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 90 + } } ], - "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/SingleValueResponseStatusPageMeasuredComponentUptimeDto" } } } @@ -22015,13 +22524,14 @@ } } }, - "/api/v1/status-pages/{id}/maintenance/{windowId}/updates/{updateId}": { - "patch": { + "/api/v1/status-pages/{id}/components/{componentId}/override": { + "put": { "tags": [ "Status Pages" ], - "summary": "Edit an existing maintenance timeline update body", - "operationId": "patchMaintenanceUpdate", + "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", @@ -22033,16 +22543,7 @@ } }, { - "name": "windowId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "updateId", + "name": "componentId", "in": "path", "required": true, "schema": { @@ -22055,7 +22556,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateStatusPageIncidentUpdateRequest" + "$ref": "#/components/schemas/SetStatusPageComponentOverrideRequest" } } }, @@ -22067,7 +22568,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentUpdateDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" } } } @@ -22153,16 +22654,13 @@ } } } - } - }, - "/api/v1/status-pages/{id}/notification-deliveries": { - "get": { + }, + "delete": { "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": "Clear a timed human status override on a component", + "operationId": "clearComponentOverride", "parameters": [ { "name": "id", @@ -22174,27 +22672,13 @@ } }, { - "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" - ] - } } ], "responses": { @@ -22203,7 +22687,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageNotificationDeliveryDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentDto" } } } @@ -22291,13 +22775,14 @@ } } }, - "/api/v1/status-pages/{id}/notification-deliveries/{deliveryId}": { + "/api/v1/status-pages/{id}/components/{componentId}/uptime": { "get": { "tags": [ "Status Pages" ], - "summary": "Get a notification delivery receipt", - "operationId": "getNotificationDelivery", + "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", @@ -22309,13 +22794,23 @@ } }, { - "name": "deliveryId", + "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": { @@ -22324,7 +22819,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageNotificationDeliveryDto" + "$ref": "#/components/schemas/TableValueResultComponentUptimeDayDto" } } } @@ -22412,14 +22907,13 @@ } } }, - "/api/v1/status-pages/{id}/notification-deliveries/{deliveryId}/retry": { - "post": { + "/api/v1/status-pages/{id}/components/reorder": { + "put": { "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": "Batch reorder components (and optionally move between groups)", + "operationId": "reorderComponents", "parameters": [ { "name": "id", @@ -22429,28 +22923,22 @@ "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" - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReorderComponentsRequest" } } }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + }, "400": { "description": "Bad request — the payload failed validation", "content": { @@ -22534,13 +23022,13 @@ } } }, - "/api/v1/status-pages/{id}/subscribers": { + "/api/v1/status-pages/{id}/domains": { "get": { "tags": [ "Status Pages" ], - "summary": "List subscribers including awaiting confirmation (paginated)", - "operationId": "listSubscribers", + "summary": "List custom domains", + "operationId": "listDomains", "parameters": [ { "name": "id", @@ -22550,14 +23038,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "pageable", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/Pageable" - } } ], "responses": { @@ -22566,7 +23046,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultStatusPageSubscriberDto" + "$ref": "#/components/schemas/TableValueResultStatusPageCustomDomainDto" } } } @@ -22657,8 +23137,8 @@ "tags": [ "Status Pages" ], - "summary": "Add a subscriber; requireConfirmation=true for EMAIL double opt-in, omit/false confirms immediately", - "operationId": "addSubscriber", + "summary": "Add a custom domain", + "operationId": "addDomain", "parameters": [ { "name": "id", @@ -22674,7 +23154,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AdminAddSubscriberRequest" + "$ref": "#/components/schemas/AddCustomDomainRequest" } } }, @@ -22686,7 +23166,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseStatusPageSubscriberDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" } } } @@ -22774,13 +23254,13 @@ } } }, - "/api/v1/status-pages/{id}/subscribers/{subscriberId}": { + "/api/v1/status-pages/{id}/domains/{domainId}": { "delete": { "tags": [ "Status Pages" ], - "summary": "Remove a subscriber", - "operationId": "removeSubscriber", + "summary": "Remove a custom domain", + "operationId": "removeDomain", "parameters": [ { "name": "id", @@ -22792,7 +23272,7 @@ } }, { - "name": "subscriberId", + "name": "domainId", "in": "path", "required": true, "schema": { @@ -22888,20 +23368,30 @@ } } }, - "/api/v1/tags": { - "get": { + "/api/v1/status-pages/{id}/domains/{domainId}/primary": { + "post": { "tags": [ - "Tags" + "Status Pages" ], - "summary": "List tags for the authenticated organization", - "operationId": "list_3", + "summary": "Mark a verified custom domain as the page's primary host", + "operationId": "setPrimaryDomain", "parameters": [ { - "name": "pageable", - "in": "query", + "name": "id", + "in": "path", "required": true, "schema": { - "$ref": "#/components/schemas/Pageable" + "type": "string", + "format": "uuid" + } + }, + { + "name": "domainId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], @@ -22911,7 +23401,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultTagDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" } } } @@ -22997,30 +23487,42 @@ } } } - }, + } + }, + "/api/v1/status-pages/{id}/domains/{domainId}/verify": { "post": { "tags": [ - "Tags" + "Status Pages" ], - "summary": "Create a new tag", - "operationId": "create_4", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateTagRequest" - } + "summary": "Trigger domain verification check", + "operationId": "verifyDomain", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "required": true - }, + { + "name": "domainId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseTagDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageCustomDomainDto" } } } @@ -23108,13 +23610,13 @@ } } }, - "/api/v1/tags/{id}": { + "/api/v1/status-pages/{id}/groups": { "get": { "tags": [ - "Tags" + "Status Pages" ], - "summary": "Get a tag by ID", - "operationId": "getById", + "summary": "List component groups with nested components", + "operationId": "listGroups", "parameters": [ { "name": "id", @@ -23132,7 +23634,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseTagDto" + "$ref": "#/components/schemas/TableValueResultStatusPageComponentGroupDto" } } } @@ -23219,12 +23721,134 @@ } } }, + "post": { + "tags": [ + "Status Pages" + ], + "summary": "Create a component group", + "operationId": "createGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateStatusPageComponentGroupRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Created", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentGroupDto" + } + } + } + }, + "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}/groups/{groupId}": { "put": { "tags": [ - "Tags" + "Status Pages" ], - "summary": "Update a tag's name and/or color", - "operationId": "update_2", + "summary": "Update a component group", + "operationId": "updateGroup", "parameters": [ { "name": "id", @@ -23234,13 +23858,22 @@ "type": "string", "format": "uuid" } + }, + { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateTagRequest" + "$ref": "#/components/schemas/UpdateStatusPageComponentGroupRequest" } } }, @@ -23252,7 +23885,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseTagDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageComponentGroupDto" } } } @@ -23341,10 +23974,10 @@ }, "delete": { "tags": [ - "Tags" + "Status Pages" ], - "summary": "Delete a tag (cascades to all monitor associations)", - "operationId": "delete_2", + "summary": "Delete a component group (components become ungrouped)", + "operationId": "deleteGroup", "parameters": [ { "name": "id", @@ -23354,6 +23987,15 @@ "type": "string", "format": "uuid" } + }, + { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -23443,21 +24085,56 @@ } } }, - "/api/v1/vaults/rotate": { - "post": { + "/api/v1/status-pages/{id}/incidents": { + "get": { "tags": [ - "Vault" + "Status Pages" + ], + "summary": "List incidents for this status page (paginated)", + "operationId": "listIncidents", + "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": "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" + "$ref": "#/components/schemas/TableValueResultStatusPageIncidentDto" } } } @@ -23543,129 +24220,29 @@ } } } - } - }, - "/api/v1/webhooks": { - "get": { + }, + "post": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "List webhook endpoints for the authenticated org", - "operationId": "list_2", + "summary": "Create a status page incident (manual)", + "operationId": "createIncident", "parameters": [ { - "name": "pageable", - "in": "query", + "name": "id", + "in": "path", "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" - } - } + "type": "string", + "format": "uuid" } } - } - }, - "post": { - "tags": [ - "Webhooks" ], - "summary": "Register a new webhook endpoint", - "operationId": "create_3", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateWebhookEndpointRequest" + "$ref": "#/components/schemas/CreateStatusPageIncidentRequest" } } }, @@ -23677,7 +24254,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -23765,13 +24342,13 @@ } } }, - "/api/v1/webhooks/{id}": { + "/api/v1/status-pages/{id}/incidents/{incidentId}": { "get": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Get a single webhook endpoint", - "operationId": "get_1", + "summary": "Get incident details with timeline", + "operationId": "getIncident", "parameters": [ { "name": "id", @@ -23781,6 +24358,15 @@ "type": "string", "format": "uuid" } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -23789,7 +24375,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -23878,10 +24464,10 @@ }, "put": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Update a webhook endpoint", - "operationId": "update_1", + "summary": "Update an incident", + "operationId": "updateIncident", "parameters": [ { "name": "id", @@ -23891,13 +24477,22 @@ "type": "string", "format": "uuid" } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateWebhookEndpointRequest" + "$ref": "#/components/schemas/UpdateStatusPageIncidentRequest" } } }, @@ -23909,7 +24504,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookEndpointDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -23998,10 +24593,10 @@ }, "delete": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Delete a webhook endpoint", - "operationId": "delete_1", + "summary": "Delete an incident", + "operationId": "deleteIncident", "parameters": [ { "name": "id", @@ -24011,6 +24606,15 @@ "type": "string", "format": "uuid" } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -24100,13 +24704,13 @@ } } }, - "/api/v1/webhooks/{id}/deliveries": { - "get": { + "/api/v1/status-pages/{id}/incidents/{incidentId}/dismiss": { + "post": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "List recent deliveries for a webhook endpoint", - "operationId": "listDeliveries", + "summary": "Dismiss a draft incident (soft-deletes: resolves without publishing)", + "operationId": "dismissIncident", "parameters": [ { "name": "id", @@ -24118,26 +24722,18 @@ } }, { - "name": "limit", - "in": "query", - "required": false, + "name": "incidentId", + "in": "path", + "required": true, "schema": { - "type": "integer", - "format": "int32", - "default": 20 + "type": "string", + "format": "uuid" } } ], "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TableValueResultWebhookDeliveryDto" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad request — the payload failed validation", @@ -24222,13 +24818,13 @@ } } }, - "/api/v1/webhooks/{id}/test": { + "/api/v1/status-pages/{id}/incidents/{incidentId}/publish": { "post": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Send a test delivery to a webhook endpoint", - "operationId": "test", + "summary": "Publish a draft incident (sets publishedAt, applies component statuses, notifies subscribers)", + "operationId": "publishIncident", "parameters": [ { "name": "id", @@ -24238,13 +24834,22 @@ "type": "string", "format": "uuid" } + }, + { + "name": "incidentId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestWebhookEndpointRequest" + "$ref": "#/components/schemas/PublishStatusPageIncidentRequest" } } } @@ -24255,7 +24860,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWebhookTestResult" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -24343,21 +24948,50 @@ } } }, - "/api/v1/webhooks/events": { - "get": { + "/api/v1/status-pages/{id}/incidents/{incidentId}/updates": { + "post": { "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": "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" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateStatusPageIncidentUpdateRequest" + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/WebhookEventCatalogResponse" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -24445,20 +25079,59 @@ } } }, - "/api/v1/webhooks/signing-secret": { - "get": { + "/api/v1/status-pages/{id}/incidents/{incidentId}/updates/{updateId}": { + "patch": { "tags": [ - "Webhooks" + "Status Pages" ], - "summary": "Get signing secret metadata for the authenticated org", - "operationId": "getSigningSecretInfo", + "summary": "Edit an existing incident timeline update body", + "operationId": "patchIncidentUpdate", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "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/SingleValueResponseWebhookSigningSecretDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentUpdateDto" } } } @@ -24546,24 +25219,38 @@ } } }, - "/api/v1/webhooks/signing-secret/rotate": { - "post": { + "/api/v1/status-pages/{id}/layout/reorder": { + "put": { "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": "Reorder page-level layout: groups and ungrouped components share one ordering", + "operationId": "reorderLayout", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReorderPageLayoutRequest" } } }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + }, "400": { "description": "Bad request — the payload failed validation", "content": { @@ -24647,14 +25334,40 @@ } } }, - "/api/v1/workspaces": { + "/api/v1/status-pages/{id}/maintenance": { "get": { "tags": [ - "Workspaces" + "Status Pages" ], - "summary": "List workspaces", - "operationId": "list_1", + "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", @@ -24670,7 +25383,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/TableValueResultWorkspaceDto" + "$ref": "#/components/schemas/TableValueResultStatusPageIncidentDto" } } } @@ -24759,15 +25472,26 @@ }, "post": { "tags": [ - "Workspaces" + "Status Pages" + ], + "summary": "Schedule a maintenance window", + "operationId": "createMaintenance", + "parameters": [ + { + "name": "id", + "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/CreateStatusPageMaintenanceRequest" } } }, @@ -24779,7 +25503,7 @@ "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWorkspaceDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -24867,151 +25591,40 @@ } } }, - "/api/v1/workspaces/{workspaceId}": { + "/api/v1/status-pages/{id}/maintenance/{windowId}": { "get": { "tags": [ - "Workspaces" + "Status Pages" ], - "summary": "Get workspace by ID", - "operationId": "get", + "summary": "Get a maintenance window with timeline", + "operationId": "getMaintenance", "parameters": [ { - "name": "workspaceId", + "name": "id", "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" - } - } + "type": "string", + "format": "uuid" } }, - "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", + "name": "windowId", "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateWorkspaceRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { - "$ref": "#/components/schemas/SingleValueResponseWorkspaceDto" + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" } } } @@ -25098,26 +25711,52 @@ } } }, - "delete": { + "put": { "tags": [ - "Workspaces" + "Status Pages" ], - "summary": "Delete workspace", - "operationId": "delete", + "summary": "Update a maintenance window", + "operationId": "updateMaintenance", "parameters": [ { - "name": "workspaceId", + "name": "id", "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int32" + "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": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleValueResponseStatusPageIncidentDto" + } + } + } }, "400": { "description": "Bad request — the payload failed validation", @@ -25200,413 +25839,5997 @@ } } } - } - } - }, - "components": { - "schemas": { - "AcknowledgeAllIncidentsResponse": { - "required": [ - "acknowledged", - "skipped" + }, + "delete": { + "tags": [ + "Status Pages" ], - "type": "object", - "properties": { - "acknowledged": { - "type": "array", - "description": "Dispatches successfully acknowledged in this request", - "items": { - "$ref": "#/components/schemas/NotificationDispatchDto" + "summary": "Cancel a maintenance window", + "operationId": "deleteMaintenance", + "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": { + "204": { + "description": "No Content" }, - "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" + } + }, + "/api/v1/status-pages/{id}/maintenance/{windowId}/dismiss": { + "post": { + "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": [ - "OPERATIONAL", - "DEGRADED_PERFORMANCE", - "PARTIAL_OUTAGE", - "MAJOR_OUTAGE", - "UNDER_MAINTENANCE" - ] - } - }, - "description": "Updated affected components; null preserves current" - }, - "AlertChannelDisplayConfig": { - "type": "object", - "properties": { - "recipients": { - "type": "array", - "description": "Email recipients list (email channels)", - "nullable": true, - "items": { + "summary": "Dismiss a draft maintenance window", + "operationId": "dismissMaintenance", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string", - "description": "Email recipients list (email channels)" + "format": "uuid" } }, - "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": { + { + "name": "windowId", + "in": "path", + "required": true, + "schema": { "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 + "format": "uuid" + } + } + ], + "responses": { + "204": { + "description": "No Content" }, - "visibility": { - "type": "string", - "description": "incident.io incident visibility", - "nullable": true + "400": { + "description": "Bad request — the payload failed validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "severity": { - "type": "string", - "description": "Rootly incident severity slug", - "nullable": true + "401": { + "description": "Unauthorized — missing or invalid credentials", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "site": { - "type": "string", - "description": "Datadog site region", - "nullable": true + "403": { + "description": "Forbidden — the actor lacks permission for this resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "projectKey": { - "type": "string", - "description": "Jira project key", - "nullable": true + "404": { + "description": "Not found — the requested resource does not exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "phoneNumber": { - "type": "string", - "description": "Recipient phone number in E.164 format (SMS / phone-call channels)", - "nullable": true + "409": { + "description": "Conflict — the request collides with current resource state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "verifiedPhoneNumberId": { - "type": "integer", - "description": "Id of the org verified_phone_number row bound to this channel", - "format": "int64", - "nullable": true + "500": { + "description": "Internal server error — see the message field for details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "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" + "502": { + "description": "Bad gateway — an upstream provider returned an error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } } }, - "voiceLanguage": { - "type": "string", - "description": "BCP-47 voice language for phone-call TTS (e.g. en-US, de-DE)", + "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", + "MAJOR_OUTAGE", + "UNDER_MAINTENANCE" + ] + } + }, + "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" + ] + }, + "BodyContainsAssertion": { + "required": [ + "type", + "substring" + ], + "type": "object", + "properties": { + "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": "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": "Tag IDs to attach or detach (required for ADD_TAG and REMOVE_TAG)", + "format": "uuid" + } + }, + "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": "When to capture screenshots", + "nullable": true, + "enum": [ + "always", + "on_failure", + "off" + ] + }, + "trace": { + "type": "string", + "description": "When to capture a Playwright trace", + "nullable": true, + "enum": [ + "always", + "on_failure", + "off" + ] + }, + "video": { + "type": "string", + "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)" + }, + "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": "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": { + "type": "array", + "description": "Individual assertion evaluation results", + "nullable": true, + "items": { + "$ref": "#/components/schemas/AssertionResultDto" + } + }, + "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": "Final URL after redirects", + "nullable": true + }, + "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": "Unique identifier of the check result", + "format": "uuid" + }, + "timestamp": { + "type": "string", + "description": "Timestamp when the check was executed (ISO 8601)", + "format": "date-time" + }, + "region": { + "type": "string", + "description": "Region where the check was executed", + "example": "us-east" + }, + "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": "Reason for failure when passed=false", + "nullable": true + }, + "severityHint": { + "type": "string", + "description": "Severity hint: 'down' for hard failures, 'degraded' for warn-only failures, null when passing", + "nullable": true + }, + "details": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/CheckResultDetailsDto" + } + ] + }, + "checkId": { + "type": "string", + "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" + }, + "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", + "enum": [ + "code" + ] + }, + "exitCode": { + "type": "integer", + "description": "Container exit code (0 = pass)", + "format": "int32" + }, + "stdoutSnippet": { + "type": "string", + "description": "Truncated stdout from the container", + "nullable": true + }, + "stderrSnippet": { + "type": "string", + "description": "Truncated stderr from the container", + "nullable": true + }, + "steps": { + "type": "array", + "description": "Named steps extracted from Playwright test output", + "nullable": true, + "items": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/CodeCheckStep" + } + ] + } + }, + "failureKind": { + "type": "string", + "description": "Failure classification: timeout, assertion, or error", + "nullable": true + }, + "timedOut": { + "type": "boolean", + "description": "Whether the run hit a step/total/run-budget timeout", + "nullable": true + } + }, + "required": [ + "check_type", + "exitCode" + ] + }, + "CodeCheckStep": { + "required": [ + "name", + "status" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Step name from test.step() or test() call" + }, + "status": { + "type": "string", + "description": "Step outcome: passed, failed, skipped, or timedOut" + }, + "durationMs": { + "type": "integer", + "description": "Step duration in milliseconds", + "format": "int32", + "nullable": true + }, + "error": { + "type": "string", + "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" + }, + "componentName": { + "type": "string", + "description": "Component display name" + }, + "groupName": { + "type": "string", + "description": "Parent group display name when the component belongs to a group", + "nullable": true + }, + "uptimePercentage": { + "type": "number", + "description": "Computed uptime % for this component on this day", + "format": "double" + }, + "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": "Component ID", + "format": "uuid" + }, + "displayOrder": { + "type": "integer", + "description": "New display order (0-based)", + "format": "int32" + }, + "groupId": { + "type": "string", + "description": "Target group ID, null for ungrouped", + "format": "uuid", + "nullable": true + } + }, + "description": "A single component position" + }, + "ComponentSample": { + "required": [ + "componentId", + "newStatus" + ], + "type": "object", + "properties": { + "componentId": { + "type": "string", + "description": "Component ID", + "format": "uuid" + }, + "componentName": { + "type": "string", + "description": "Component display name", + "nullable": true + }, + "oldStatus": { + "type": "string", + "description": "Previous status before the flip", + "nullable": true + }, + "newStatus": { + "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" + }, + "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": "Component UUID" + }, + "name": { + "type": "string", + "description": "Human-readable component name" + }, + "status": { + "type": "string", + "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" + }, + "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": "Start-of-day timestamp for this bucket (UTC midnight, ISO 8601)", + "format": "date-time" + }, + "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" + }, + "degradedSeconds": { + "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" + }, + "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 + }, + "week": { + "type": "number", + "description": "Uptime percentage over the last 7 days", + "format": "double", + "nullable": true, + "example": 99.98 + }, + "month": { + "type": "number", + "description": "Uptime percentage over the last 30 days", + "format": "double", + "nullable": true, + "example": 99.92 + }, + "source": { + "type": "string", + "description": "Data source: vendor_reported or incident_derived", + "example": "vendor_reported" + } + }, + "description": "Inline uptime percentages for 24h, 7d, 30d" + }, + "ConfirmationPolicy": { + "required": [ + "type", + "minRegionsFailing", + "maxWaitSeconds" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "How incident confirmation is coordinated across regions", + "enum": [ + "multi_region" + ] + }, + "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" + }, + "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" + } + ] + }, + "managedBy": { + "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" + ] + } + } + }, + "CreateApiKeyRequest": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 200, + "minLength": 0, + "type": "string", + "description": "Human-readable name to identify this API key" + }, + "expiresAt": { + "type": "string", + "description": "Optional expiration timestamp in ISO 8601 format", + "format": "date-time", + "nullable": true + } + } + }, + "CreateAssertionRequest": { + "required": [ + "config" + ], + "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" + } + ] + }, + "severity": { + "type": "string", + "description": "Outcome severity: FAIL (fails the check) or WARN (warns without failing, default: FAIL)", + "nullable": true, + "enum": [ + "fail", + "warn" + ] + } + }, + "description": "Replace all assertions. Null preserves current" + }, + "CreateEnvironmentRequest": { + "required": [ + "name", + "slug" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 100, + "minLength": 0, + "type": "string", + "description": "Human-readable environment name" + }, + "slug": { + "maxLength": 100, + "minLength": 0, + "pattern": "^[a-z0-9][a-z0-9_-]*$", + "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", + "nullable": true + }, + "isDefault": { + "type": "boolean", + "description": "Whether this is the default environment for new monitors (default: false)", + "nullable": true + } + } + }, + "CreateInviteRequest": { + "required": [ + "email", + "roleOffered" + ], + "type": "object", + "properties": { + "email": { + "minLength": 1, + "type": "string", + "description": "Email address to invite", + "format": "email" + }, + "roleOffered": { + "type": "string", + "description": "Role to assign on acceptance", + "enum": [ + "OWNER", + "ADMIN", + "MEMBER" + ] + } + }, + "description": "Invite a new member to the organization by email" + }, + "CreateMaintenanceWindowRequest": { + "required": [ + "endsAt", + "startsAt" + ], + "type": "object", + "properties": { + "monitorId": { + "type": "string", + "description": "Monitor to attach this maintenance window to; null for org-wide", + "format": "uuid", "nullable": true }, - "preferredLanguage": { + "startsAt": { "type": "string", - "description": "Preferred language for SMS/voice (BCP-47, e.g. en-US, de-DE)", + "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 + }, + "reason": { + "maxLength": 500, + "minLength": 0, + "type": "string", + "description": "Human-readable reason for the maintenance (max 500 chars)", + "nullable": true + }, + "suppressAlerts": { + "type": "boolean", + "description": "Whether to suppress alerts during this window (default: true)", "nullable": true } - }, - "description": "Non-sensitive alert channel configuration metadata" + } }, - "AlertChannelDto": { + "CreateManualIncidentRequest": { "required": [ - "channelType", - "createdAt", - "enabled", - "id", - "name", - "updatedAt" + "severity", + "title" ], "type": "object", "properties": { - "id": { + "title": { + "minLength": 1, "type": "string", - "description": "Unique alert channel identifier", - "format": "uuid" + "description": "Short summary of the incident" + }, + "severity": { + "type": "string", + "description": "Incident severity: DOWN, DEGRADED, or MAINTENANCE", + "enum": [ + "DOWN", + "DEGRADED", + "MAINTENANCE" + ] + }, + "monitorId": { + "type": "string", + "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 + } + } + }, + "CreateMonitorRequest": { + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { "name": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "Human-readable channel name" + "description": "Human-readable name for this monitor" }, - "channelType": { + "type": { "type": "string", - "description": "Channel integration type (e.g. SLACK, PAGERDUTY, EMAIL)", + "description": "Monitor protocol type", "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" + "HTTP", + "DNS", + "MCP_SERVER", + "TCP", + "ICMP", + "HEARTBEAT", + "BROWSER", + "MULTI_STEP_API" ] }, - "displayConfig": { + "config": { "nullable": true, - "allOf": [ + "oneOf": [ { - "$ref": "#/components/schemas/AlertChannelDisplayConfig" + "$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 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", + "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" + } + }, "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.", + "description": "Source that created this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API", "nullable": true, "enum": [ "DASHBOARD", @@ -25616,8951 +31839,8851 @@ "API" ] }, - "lastDeliveryAt": { + "environmentId": { "type": "string", - "description": "Timestamp of the most recent delivery attempt", - "format": "date-time", + "description": "Environment to associate with this monitor. Required for browser and multi-step monitors", + "format": "uuid", "nullable": true }, - "lastDeliveryStatus": { + "assertions": { + "type": "array", + "description": "Assertions to evaluate against each check result", + "nullable": true, + "items": { + "$ref": "#/components/schemas/CreateAssertionRequest" + } + }, + "auth": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/MonitorAuthConfig" + } + ] + }, + "incidentPolicy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/UpdateIncidentPolicyRequest" + } + ] + }, + "alertChannelIds": { + "type": "array", + "description": "Alert channels to notify when this monitor triggers", + "nullable": true, + "items": { + "type": "string", + "description": "Alert channels to notify when this monitor triggers", + "format": "uuid" + } + }, + "tags": { + "nullable": true, + "allOf": [ + { + "$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 or 0 disables", + "format": "int32", + "nullable": true + }, + "definitionId": { "type": "string", - "description": "Outcome of the most recent delivery (SUCCESS, FAILED, etc.)", + "description": "Existing definition to reuse for a sibling monitor", + "format": "uuid", + "nullable": true + }, + "package": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/MonitorPackageSpec" + } + ] + } + } + }, + "CreateNotificationPolicyRequest": { + "required": [ + "escalation", + "name" + ], + "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 + }, + "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": "Alert channel with non-sensitive configuration metadata" + "description": "Request body for creating a notification policy" }, - "AlertDeliveryDto": { + "CreatePackageUploadRequest": { "required": [ - "channel", - "channelId", - "channelType", - "createdAt", - "eventType", - "id", - "incidentId", - "status", - "stepNumber", - "fireCount", - "attemptCount" + "digest" ], "type": "object", "properties": { - "id": { + "digest": { + "maxLength": 64, + "minLength": 64, "type": "string", - "format": "uuid" + "description": "SHA-256 hex digest of the package zip to upload (64 chars)" + } + } + }, + "CreateResourceGroupRequest": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Human-readable name for this group" }, - "incidentId": { + "description": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "Incident that triggered this delivery", - "format": "uuid" + "description": "Optional description (max 500)", + "nullable": true }, - "dispatchId": { + "alertPolicyId": { "type": "string", - "description": "Notification dispatch that created this delivery", + "description": "Optional notification policy to apply for this group", "format": "uuid", "nullable": true }, - "channelId": { + "defaultFrequency": { + "maximum": 86400, + "minimum": 30, + "type": "integer", + "description": "Default check frequency in seconds applied to members (30–86400)", + "format": "int32", + "nullable": true + }, + "defaultRegions": { + "type": "array", + "description": "Default regions applied to member monitors", + "nullable": true, + "items": { + "type": "string", + "description": "Default regions applied to member monitors" + } + }, + "defaultRetryStrategy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/RetryStrategy" + } + ] + }, + "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": "Alert channel ID", - "format": "uuid" + "description": "Default environment ID applied to member monitors", + "format": "uuid", + "nullable": true }, - "channel": { + "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": "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, + "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)" + }, + "value": { + "maxLength": 32768, + "minLength": 0, + "type": "string", + "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 + }, + "displayOrder": { + "type": "integer", + "description": "Position in the group list", + "format": "int32", + "nullable": true + }, + "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 + } + } + }, + "CreateStatusPageComponentRequest": { + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "Human-readable channel name" + "description": "Component display name" }, - "channelType": { + "description": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "Alert channel type (e.g. slack, email, webhook)" + "description": "Optional description shown on expand", + "nullable": true }, - "status": { + "type": { "type": "string", - "description": "Current delivery status", + "description": "Component type: MONITOR, GROUP, STATIC, or DEPENDENCY", "enum": [ - "PENDING", - "DELIVERED", - "RETRY_PENDING", - "FAILED", - "CANCELLED", - "SKIPPED_NO_CREDIT", - "SKIPPED_UNVERIFIED", - "SKIPPED_OPTED_OUT", - "SKIPPED_RATE_LIMITED" + "MONITOR", + "GROUP", + "STATIC", + "DEPENDENCY" ] }, - "eventType": { + "monitorId": { "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" + "description": "Monitor ID (required when type=MONITOR)", + "format": "uuid", + "nullable": true }, - "lastAttemptAt": { + "resourceGroupId": { "type": "string", - "description": "When the last attempt was made", - "format": "date-time", + "description": "Resource group ID (required when type=GROUP)", + "format": "uuid", "nullable": true }, - "nextRetryAt": { + "serviceSubscriptionId": { "type": "string", - "description": "When the next retry is scheduled (null if not retrying)", - "format": "date-time", + "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 }, - "deliveredAt": { + "groupId": { "type": "string", - "description": "Timestamp when the delivery was confirmed (null if not yet delivered)", - "format": "date-time", + "description": "Component group ID for visual grouping", + "format": "uuid", "nullable": true }, - "errorMessage": { - "type": "string", - "description": "Error message from the last failed attempt", + "showUptime": { + "type": "boolean", + "description": "Whether to show the uptime bar (default: true; false for DEPENDENCY)", "nullable": true }, - "createdAt": { + "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", - "format": "date-time" + "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": "Delivery record for a single channel within a notification dispatch" + } }, - "ApiKeyAuthConfig": { + "CreateStatusPageIncidentRequest": { "required": [ - "type", - "headerName" + "body", + "impact", + "title" ], "type": "object", "properties": { - "type": { + "title": { + "maxLength": 500, + "minLength": 0, + "type": "string", + "description": "Customer-facing incident title" + }, + "status": { "type": "string", + "description": "Initial status (default: INVESTIGATING)", + "nullable": true, "enum": [ - "api_key" + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" ] }, - "headerName": { + "impact": { + "type": "string", + "description": "Impact level: NONE, MINOR, MAJOR, or CRITICAL", + "enum": [ + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" + ] + }, + "body": { "minLength": 1, - "pattern": "^[A-Za-z0-9\\-_]+$", "type": "string", - "description": "HTTP header name that carries the API key" + "description": "Initial update body in markdown" }, - "vaultSecretId": { + "affectedComponents": { + "type": "array", + "description": "Component IDs affected by this incident", + "nullable": true, + "items": { + "$ref": "#/components/schemas/AffectedComponent" + } + }, + "notifySubscribers": { + "type": "boolean", + "description": "Whether to email confirmed subscribers about this incident (default: true)", + "nullable": true + }, + "monitoringIncidentId": { "type": "string", - "description": "Vault secret ID for the API key value", + "description": "Monitoring incident ID to link this status page incident to; null for standalone", "format": "uuid", "nullable": true } } }, - "ApiKeyCreateResponse": { + "CreateStatusPageIncidentUpdateRequest": { "required": [ - "createdAt", - "key", - "name", - "id" + "body", + "status" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Unique API key identifier", - "format": "int32" - }, - "name": { - "minLength": 1, + "status": { "type": "string", - "description": "Human-readable name for this API key" + "description": "Incident status at this point in the timeline", + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] }, - "key": { + "body": { "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" + "description": "Update body in markdown" }, - "expiresAt": { - "type": "string", - "description": "Timestamp when the key expires; null if no expiration", - "format": "date-time", + "notifySubscribers": { + "type": "boolean", + "description": "Whether to email confirmed subscribers about this update (default: true)", "nullable": true + }, + "affectedComponents": { + "type": "array", + "description": "Updated affected components; null preserves current", + "nullable": true, + "items": { + "$ref": "#/components/schemas/AffectedComponent" + } } - }, - "description": "Created API key with the full key value — store it now, it won't be shown again" + } }, - "ApiKeyDto": { + "CreateStatusPageMaintenanceRequest": { "required": [ - "createdAt", - "key", - "name", - "updatedAt", - "id" + "body", + "impact", + "scheduledFor", + "title" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Unique API key identifier", - "format": "int32" + "title": { + "maxLength": 500, + "minLength": 0, + "type": "string", + "description": "Customer-facing maintenance title" }, - "name": { - "minLength": 1, + "status": { "type": "string", - "description": "Human-readable name for this API key" + "description": "Initial status (default: INVESTIGATING)", + "nullable": true, + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] }, - "key": { - "minLength": 1, + "impact": { "type": "string", - "description": "Full API key value in dh_live_* format" + "description": "Impact level: NONE, MINOR, MAJOR, or CRITICAL", + "enum": [ + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" + ] }, - "createdAt": { + "body": { + "minLength": 1, "type": "string", - "description": "Timestamp when the key was created", - "format": "date-time" + "description": "Initial update body in markdown" }, - "updatedAt": { + "affectedComponents": { + "type": "array", + "description": "Component IDs affected by this window", + "nullable": true, + "items": { + "$ref": "#/components/schemas/AffectedComponent" + } + }, + "scheduledFor": { "type": "string", - "description": "Timestamp when the key was last updated", + "description": "Maintenance start time", "format": "date-time" }, - "lastUsedAt": { + "scheduledUntil": { "type": "string", - "description": "Timestamp of the most recent API call; null if never used", + "description": "Maintenance end time", "format": "date-time", "nullable": true }, - "revokedAt": { - "type": "string", - "description": "Timestamp when the key was revoked; null if active", - "format": "date-time", + "autoResolve": { + "type": "boolean", + "description": "Auto-resolve at scheduledUntil (default: false)", "nullable": true }, - "expiresAt": { - "type": "string", - "description": "Timestamp when the key expires; null if no expiration", - "format": "date-time", + "notifySubscribers": { + "type": "boolean", + "description": "Whether to email confirmed subscribers about this window (default: true)", "nullable": true } - }, - "description": "API key for programmatic access to the DevHelm API" + } }, - "AssertionResultDto": { + "CreateStatusPageRequest": { "required": [ - "severity", - "type", - "passed" + "name", + "slug" ], "type": "object", "properties": { - "type": { + "name": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "Assertion type", - "example": "status_code" + "description": "Human-readable name for this status page" }, - "passed": { - "type": "boolean", - "description": "Whether the assertion passed" + "slug": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$", + "type": "string", + "description": "URL slug (lowercase, hyphens, globally unique)" }, - "severity": { + "description": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "Assertion severity", - "enum": [ - "fail", - "warn" + "description": "Optional description shown below the page header", + "nullable": true + }, + "branding": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/StatusPageBranding" + } ] }, - "message": { + "visibility": { "type": "string", - "description": "Human-readable result message", + "description": "Page visibility: PUBLIC, PASSWORD, or IP_RESTRICTED (default: PUBLIC)", + "nullable": true, + "enum": [ + "PUBLIC", + "PASSWORD", + "IP_RESTRICTED" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the page is enabled (default: true)", "nullable": true }, - "expected": { + "incidentMode": { "type": "string", - "description": "Expected value", + "description": "Incident mode: MANUAL, REVIEW, or AUTOMATIC (default: AUTOMATIC)", "nullable": true, - "example": "200" + "enum": [ + "MANUAL", + "REVIEW", + "AUTOMATIC" + ] }, - "actual": { + "managedBy": { "type": "string", - "description": "Actual value observed", + "description": "Source creating this page: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API when omitted.", "nullable": true, - "example": "503" + "enum": [ + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" + ] } - }, - "description": "Result of evaluating a single assertion against a check result" + } }, - "AssertionTestResultDto": { + "CreateTagRequest": { "required": [ - "assertionType", - "message", - "severity", - "passed" + "name" ], "type": "object", "properties": { - "assertionType": { + "name": { + "maxLength": 100, + "minLength": 0, "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" + "description": "Tag name, unique within the org" }, - "severity": { + "color": { + "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "type": "string", - "description": "Assertion severity: FAIL or WARN", - "enum": [ - "fail", - "warn" - ] - }, - "message": { + "description": "Hex color code (defaults to #6B7280 if omitted)", + "nullable": true + } + }, + "description": "Request body for creating a tag" + }, + "CreateWebhookEndpointRequest": { + "required": [ + "subscribedEvents", + "url" + ], + "type": "object", + "properties": { + "url": { + "maxLength": 2048, + "minLength": 0, "type": "string", - "description": "Human-readable result description" + "description": "HTTPS endpoint that receives webhook event payloads" }, - "expected": { + "description": { + "maxLength": 255, + "minLength": 0, "type": "string", - "description": "Expected value", + "description": "Optional human-readable description", "nullable": true }, - "actual": { - "type": "string", - "description": "Actual value observed during the test", - "nullable": true + "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" + ] + } } } }, - "AuditEventDto": { + "CreateWorkspaceRequest": { "required": [ - "action", - "createdAt", - "id" + "name" ], "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": { + "name": { + "minLength": 1, + "type": "string", + "description": "Workspace name" + } + }, + "description": "Create a new workspace within the organization" + }, + "CreditPolicy": { + "type": "object", + "properties": { + "summary": { "type": "string", - "description": "Email of the actor; null for system actions", + "description": "Brief summary of credit policy", "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)", + "maxCreditPercent": { + "type": "integer", + "description": "Max credit as percent of monthly fee", + "format": "int32", "nullable": true }, - "resourceId": { - "type": "string", - "description": "ID of the affected resource", + "claimWindowDays": { + "type": "integer", + "description": "Days to submit a credit claim after eligibility", + "format": "int32", "nullable": true }, - "resourceName": { - "type": "string", - "description": "Human-readable name of the affected resource", + "creditApplicationDays": { + "type": "integer", + "description": "Days for credit to be applied after approval", + "format": "int32", "nullable": true }, - "metadata": { + "tiers": { + "type": "array", + "description": "Credit tiers by uptime threshold", "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" + "items": { + "$ref": "#/components/schemas/CreditTier" + } } }, - "oneOf": [ - { - "$ref": "#/components/schemas/MemberRoleChangedMetadata" - } - ] + "description": "Service credit policy for SLA violations" }, - "AuthMeResponse": { + "CreditTier": { "required": [ - "key", - "organization", - "plan", - "rateLimits" + "uptimeRange" ], "type": "object", "properties": { - "key": { - "$ref": "#/components/schemas/KeyInfo" + "uptimeRange": { + "type": "string", + "description": "Uptime range, e.g. '99.1% – 99.98%'" }, - "organization": { - "$ref": "#/components/schemas/OrgInfo" + "creditPercent": { + "type": "integer", + "description": "Credit percent of monthly fee", + "format": "int32", + "nullable": true }, - "plan": { - "$ref": "#/components/schemas/PlanInfo" + "formula": { + "type": "string", + "description": "Credit formula when percent is not a fixed number", + "nullable": true }, - "rateLimits": { - "$ref": "#/components/schemas/RateLimitInfo" + "notes": { + "type": "string", + "description": "Additional notes on this credit tier", + "nullable": true } }, - "description": "Identity, organization, plan, and rate-limit info for the authenticated API key" + "description": "Credit tiers by uptime threshold" }, - "BasicAuthConfig": { + "CursorPageCheckResultDto": { + "required": [ + "data", + "hasMore" + ], "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "basic" - ] + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/CheckResultDto" + } }, - "vaultSecretId": { + "nextCursor": { "type": "string", - "description": "Vault secret ID holding Basic auth username and password", - "format": "uuid", + "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" } }, - "required": [ - "type" - ] + "description": "Cursor-paginated response for time-series and append-only data" }, - "BatchComponentUptimeDto": { + "CursorPageIncidentActivityEventDto": { "required": [ - "components" + "data", + "hasMore" ], "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)" + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/IncidentActivityEventDto" + } + }, + "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": "Batch daily uptime per component, keyed by component ID" + "description": "Cursor-paginated response for time-series and append-only data" }, - "BearerAuthConfig": { + "CursorPageNotificationDispatchDto": { + "required": [ + "data", + "hasMore" + ], "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "bearer" - ] + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/NotificationDispatchDto" + } }, - "vaultSecretId": { + "nextCursor": { "type": "string", - "description": "Vault secret ID holding the bearer token value", - "format": "uuid", + "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" } }, - "required": [ - "type" - ] + "description": "Cursor-paginated response for time-series and append-only data" }, - "BodyContainsAssertion": { + "CursorPageRunDto": { "required": [ - "type", - "substring" + "data", + "hasMore" ], "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "body_contains" - ] + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/RunDto" + } }, - "substring": { - "minLength": 1, + "nextCursor": { "type": "string", - "description": "Substring that must appear in the response body" + "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" }, - "BulkMonitorActionRequest": { + "CursorPageServiceCatalogDto": { "required": [ - "action", - "monitorIds" + "data", + "hasMore" ], "type": "object", "properties": { - "monitorIds": { - "maxItems": 200, - "minItems": 0, + "data": { "type": "array", - "description": "IDs of monitors to act on (max 200)", + "description": "Items on this page", "items": { - "type": "string", - "description": "IDs of monitors to act on (max 200)", - "format": "uuid" + "$ref": "#/components/schemas/ServiceCatalogDto" } }, - "action": { + "nextCursor": { "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": "Tag IDs to attach or detach (required for ADD_TAG and REMOVE_TAG)", - "format": "uuid" - } + "description": "Opaque cursor for the next page; null when there are no more results", + "nullable": true }, - "newTags": { - "type": "array", - "description": "New tags to create and attach (only for ADD_TAG)", - "nullable": true, - "items": { - "$ref": "#/components/schemas/NewTagRequest" - } + "hasMore": { + "type": "boolean", + "description": "Whether more results exist beyond this page" } }, - "description": "Request body for performing a bulk action on multiple monitors" + "description": "Cursor-paginated response for time-series and append-only data" }, - "BulkMonitorActionResult": { + "CursorPageServicePollResultDto": { "required": [ - "failed", - "succeeded" + "data", + "hasMore" ], "type": "object", "properties": { - "succeeded": { + "data": { "type": "array", - "description": "IDs of monitors on which the action succeeded", + "description": "Items on this page", "items": { - "type": "string", - "description": "IDs of monitors on which the action succeeded", - "format": "uuid" + "$ref": "#/components/schemas/ServicePollResultDto" } }, - "failed": { - "type": "array", - "description": "Monitors on which the action failed, with the reason for each failure", - "items": { - "$ref": "#/components/schemas/FailureDetail" - } + "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": "Result of a bulk monitor action, including partial-success details" + "description": "Cursor-paginated response for time-series and append-only data" }, - "CategoryDto": { + "CursorPageStatusEventDto": { "required": [ - "category", - "serviceCount" + "data", + "hasMore" ], "type": "object", "properties": { - "category": { + "data": { + "type": "array", + "description": "Items on this page", + "items": { + "$ref": "#/components/schemas/StatusEventDto" + } + }, + "nextCursor": { "type": "string", - "description": "Category name (e.g. CI/CD, Cloud, Payments)" + "description": "Opaque cursor for the next page; null when there are no more results", + "nullable": true }, - "serviceCount": { - "type": "integer", - "description": "Number of services in this category", - "format": "int64" + "hasMore": { + "type": "boolean", + "description": "Whether more results exist beyond this page" } }, - "description": "Service category with its count of catalog entries" + "description": "Cursor-paginated response for time-series and append-only data" }, - "ChangeRoleRequest": { + "DashboardOverviewDto": { "required": [ - "orgRole" + "incidents", + "monitors" ], "type": "object", "properties": { - "orgRole": { - "type": "string", - "description": "New role to assign", - "enum": [ - "OWNER", - "ADMIN", - "MEMBER" - ] + "monitors": { + "$ref": "#/components/schemas/MonitorsSummaryDto" + }, + "incidents": { + "$ref": "#/components/schemas/IncidentsSummaryDto" } }, - "description": "Update an organization member's role" + "description": "Combined dashboard overview for monitors and incidents" }, - "ChangeStatusRequest": { + "DatadogChannelConfig": { "required": [ - "status" + "channelType", + "apiKey" ], "type": "object", "properties": { - "status": { + "channelType": { "type": "string", - "description": "New membership status (ACTIVE or SUSPENDED)", "enum": [ - "INVITED", - "ACTIVE", - "SUSPENDED", - "LEFT", - "REMOVED", - "DECLINED" + "datadog" ] + }, + "apiKey": { + "minLength": 1, + "type": "string", + "description": "Datadog API key" + }, + "site": { + "type": "string", + "description": "Datadog site region (e.g. datadoghq.com, datadoghq.eu, us3.datadoghq.com)", + "nullable": true + }, + "tags": { + "type": "string", + "description": "Comma-separated tags to attach to events", + "nullable": true } - }, - "description": "Update an organization member's status" + } }, - "ChartBucketDto": { + "DayIncident": { "required": [ - "bucket" + "affectedComponentIds", + "affectedComponentNames", + "id", + "impact", + "status", + "title", + "scheduled" ], "type": "object", "properties": { - "bucket": { + "id": { "type": "string", - "description": "Start of the time bucket (ISO 8601)", - "format": "date-time", - "example": "2026-03-12T10:00:00Z" + "description": "Status page incident UUID", + "format": "uuid" }, - "uptimePercent": { - "type": "number", - "description": "Uptime percentage for this bucket; null when no data", - "format": "double", - "nullable": true, - "example": 100 + "title": { + "type": "string", + "description": "Incident title" }, - "avgLatencyMs": { - "type": "number", - "description": "Weighted average latency in milliseconds for this bucket", - "format": "double", - "nullable": true, - "example": 120.3 + "status": { + "type": "string", + "description": "Lifecycle status (investigating, identified, monitoring, resolved, …)", + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] }, - "p95LatencyMs": { - "type": "number", - "description": "95th percentile latency in milliseconds (max across regions)", - "format": "double", - "nullable": true, - "example": 250 + "impact": { + "type": "string", + "description": "Severity bucket (none, minor, major, critical)", + "enum": [ + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" + ] }, - "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 + "scheduled": { + "type": "boolean", + "description": "True for a maintenance window; false for an incident" }, - "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", + "startedAt": { + "type": "string", + "description": "Incident start timestamp", + "format": "date-time", "nullable": true }, - "responseBodySnapshot": { + "resolvedAt": { "type": "string", - "description": "Raw response body snapshot (may be HTML, XML, JSON, or plain text)", + "description": "Incident resolved timestamp; null while still active", + "format": "date-time", "nullable": true }, - "assertionResults": { + "affectedComponentNames": { "type": "array", - "description": "Individual assertion evaluation results", - "nullable": true, + "description": "Display names of components affected by this incident (deduplicated)", "items": { - "$ref": "#/components/schemas/AssertionResultDto" + "type": "string", + "description": "Display names of components affected by this incident (deduplicated)" } }, - "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": "Final URL after redirects", - "nullable": true - }, - "responseSizeBytes": { - "type": "integer", - "description": "Response body size in bytes", - "format": "int32", - "nullable": true, - "example": 4096 + "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" + }, + "DefinitionDetailDto": { + "required": [ + "definition", + "heads" + ], + "type": "object", + "properties": { + "definition": { + "$ref": "#/components/schemas/DefinitionDto" }, - "checkDetails": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/CheckTypeDetailsDto" - } - ] + "heads": { + "type": "array", + "description": "Active Heads per environment", + "items": { + "$ref": "#/components/schemas/DefinitionHeadDto" + } } }, - "description": "Type-specific details captured during a check execution" + "description": "Definition with Heads for each environment" }, - "CheckResultDto": { + "DefinitionDto": { "required": [ + "createdAt", "id", - "region", - "timestamp", - "passed" + "name", + "slug", + "updatedAt", + "organizationId" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Unique identifier of the check result", + "description": "Definition identifier", "format": "uuid" }, - "timestamp": { - "type": "string", - "description": "Timestamp when the check was executed (ISO 8601)", - "format": "date-time" - }, - "region": { - "type": "string", - "description": "Region where the check was executed", - "example": "us-east" - }, - "responseTimeMs": { + "organizationId": { "type": "integer", - "description": "Response time in milliseconds", - "format": "int32", - "nullable": true, - "example": 123 - }, - "passed": { - "type": "boolean", - "description": "Whether the check passed", - "example": true + "description": "Organization this definition belongs to", + "format": "int32" }, - "failureReason": { + "name": { + "minLength": 1, "type": "string", - "description": "Reason for failure when passed=false", - "nullable": true + "description": "Human-readable name" }, - "severityHint": { + "slug": { + "minLength": 1, "type": "string", - "description": "Severity hint: 'down' for hard failures, 'degraded' for warn-only failures, null when passing", - "nullable": true + "description": "URL-safe slug unique within the organization" }, - "details": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/CheckResultDetailsDto" - } - ] + "createdAt": { + "type": "string", + "description": "When the definition was created", + "format": "date-time" }, - "checkId": { + "updatedAt": { "type": "string", - "description": "Unique execution trace ID for cross-service correlation", - "format": "uuid", - "nullable": true + "description": "When the definition was last updated", + "format": "date-time" } }, - "description": "A single check result from a monitor run" + "description": "Code-monitor definition" }, - "CheckTraceDto": { + "DefinitionHeadDto": { "required": [ - "checkId", - "evaluations", - "transitions" + "activatedAt", + "definitionId", + "environment", + "revision" ], "type": "object", "properties": { - "checkId": { + "definitionId": { "type": "string", - "description": "The check execution ID this trace is keyed by", + "description": "Definition this Head belongs to", "format": "uuid" }, - "evaluations": { - "type": "array", - "description": "All rule evaluations that ran for this check", - "items": { - "$ref": "#/components/schemas/RuleEvaluationDto" - } + "environment": { + "$ref": "#/components/schemas/EnvironmentDto" }, - "transitions": { - "type": "array", - "description": "State-machine transitions this check caused (may be empty if nothing fired)", - "items": { - "$ref": "#/components/schemas/IncidentStateTransitionDto" - } + "revision": { + "$ref": "#/components/schemas/RevisionDto" }, - "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" + "activatedAt": { + "type": "string", + "description": "When this Head last activated", + "format": "date-time" + }, + "activatedBy": { + "type": "string", + "description": "Who last activated this Head", + "nullable": true + }, + "reason": { + "type": "string", + "description": "Rollback reason when this Head was restored", + "nullable": true } }, - "oneOf": [ - { - "$ref": "#/components/schemas/Http" + "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" }, - { - "$ref": "#/components/schemas/Tcp" + "newDekVersion": { + "type": "integer", + "description": "DEK version after rotation", + "format": "int32" }, - { - "$ref": "#/components/schemas/Icmp" + "secretsReEncrypted": { + "type": "integer", + "description": "Number of secrets re-encrypted with the new DEK", + "format": "int32" }, - { - "$ref": "#/components/schemas/Dns" + "channelsReEncrypted": { + "type": "integer", + "description": "Number of alert channels re-encrypted with the new DEK", + "format": "int32" }, - { - "$ref": "#/components/schemas/McpServer" + "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" }, - { - "$ref": "#/components/schemas/Code" + "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" ] }, - "Code": { + "DeliveryAttemptDto": { + "required": [ + "attemptedAt", + "deliveryId", + "id", + "status", + "attemptNumber" + ], "type": "object", - "description": "Code check (browser / multi-step API) specific details", "properties": { - "check_type": { + "id": { "type": "string", - "enum": [ - "code" - ] + "format": "uuid" }, - "exitCode": { + "deliveryId": { + "type": "string", + "format": "uuid" + }, + "attemptNumber": { "type": "integer", - "description": "Container exit code (0 = pass)", + "description": "1-based attempt number", "format": "int32" }, - "stdoutSnippet": { + "status": { "type": "string", - "description": "Truncated stdout from the container", + "description": "Outcome: SUCCESS, FAILED, TIMEOUT, ERROR" + }, + "responseStatusCode": { + "type": "integer", + "description": "HTTP response status code from the external service", + "format": "int32", "nullable": true }, - "stderrSnippet": { + "requestPayload": { "type": "string", - "description": "Truncated stderr from the container", + "description": "JSON payload sent to the external service", "nullable": true }, - "steps": { - "type": "array", - "description": "Named steps extracted from Playwright test output", - "nullable": true, - "items": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/CodeCheckStep" - } - ] - } + "responseBody": { + "type": "string", + "description": "Response body from the external service (truncated)", + "nullable": true }, - "failureKind": { + "errorMessage": { "type": "string", - "description": "Failure classification: timeout, assertion, or error", + "description": "Error message if the attempt failed", "nullable": true }, - "timedOut": { - "type": "boolean", - "description": "Whether the run hit a step/total/run-budget timeout", + "responseTimeMs": { + "type": "integer", + "description": "Round-trip time in milliseconds", + "format": "int32", + "nullable": true + }, + "externalId": { + "type": "string", + "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" } }, - "required": [ - "check_type", - "exitCode" - ] + "description": "Single delivery attempt with request/response audit data" }, - "CodeCheckStep": { + "DeployLockDto": { "required": [ - "name", - "status" + "expiresAt", + "id", + "lockedAt", + "lockedBy" ], "type": "object", "properties": { - "name": { + "id": { "type": "string", - "description": "Step name from test.step() or test() call" + "description": "Unique lock identifier", + "format": "uuid" }, - "status": { + "lockedBy": { + "minLength": 1, "type": "string", - "description": "Step outcome: passed, failed, skipped, or timedOut" + "description": "Identity of the lock holder (e.g. CLI session ID, username)" }, - "durationMs": { - "type": "integer", - "description": "Step duration in milliseconds", - "format": "int32", - "nullable": true + "lockedAt": { + "type": "string", + "description": "Timestamp when the lock was acquired", + "format": "date-time" }, - "error": { + "expiresAt": { "type": "string", - "description": "Error message if the step failed", - "nullable": true + "description": "Timestamp when the lock automatically expires", + "format": "date-time" } }, - "description": "A single named step within a code check execution" + "description": "Represents an active deploy lock for a workspace" }, - "ComponentImpact": { + "DiscordChannelConfig": { "required": [ - "componentId", - "componentName", - "uptimePercentage", - "partialOutageSeconds", - "majorOutageSeconds" + "channelType", + "webhookUrl" ], "type": "object", "properties": { - "componentId": { + "channelType": { "type": "string", - "description": "Status page component UUID", - "format": "uuid" + "enum": [ + "discord" + ] }, - "componentName": { + "webhookUrl": { + "minLength": 1, "type": "string", - "description": "Component display name" + "description": "Discord webhook URL" }, - "groupName": { + "mentionRoleId": { "type": "string", - "description": "Parent group display name when the component belongs to a group", + "description": "Optional Discord role ID to mention in notifications", "nullable": true - }, - "uptimePercentage": { - "type": "number", - "description": "Computed uptime % for this component on this day", - "format": "double" - }, - "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" - ], + "Dns": { "type": "object", + "description": "DNS check-type-specific details", "properties": { - "componentId": { + "check_type": { "type": "string", - "description": "Component ID", - "format": "uuid" + "enum": [ + "dns" + ] }, - "displayOrder": { - "type": "integer", - "description": "New display order (0-based)", - "format": "int32" + "hostname": { + "type": "string", + "description": "Target hostname", + "nullable": true }, - "groupId": { + "requestedTypes": { + "type": "array", + "description": "Requested DNS record types", + "nullable": true, + "items": { + "type": "string", + "description": "Requested DNS record types", + "nullable": true + } + }, + "usedResolver": { "type": "string", - "description": "Target group ID, null for ungrouped", - "format": "uuid", + "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 + } + }, + "failureKind": { + "type": "string", + "description": "Kind of DNS failure, if any", "nullable": true } }, - "description": "A single component position" + "required": [ + "check_type" + ] }, - "ComponentSample": { + "DnsExpectedCnameAssertion": { "required": [ - "componentId", - "newStatus" + "type", + "value" ], "type": "object", "properties": { - "componentId": { + "type": { "type": "string", - "description": "Component ID", - "format": "uuid" + "enum": [ + "dns_expected_cname" + ] }, - "componentName": { + "value": { + "minLength": 1, "type": "string", - "description": "Component display name", - "nullable": true - }, - "oldStatus": { + "description": "Expected CNAME target the resolution must include" + } + } + }, + "DnsExpectedIpsAssertion": { + "required": [ + "type", + "ips" + ], + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Previous status before the flip", - "nullable": true + "enum": [ + "dns_expected_ips" + ] }, - "newStatus": { - "type": "string", - "description": "New status after the flip" + "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" + } } - }, - "description": "One component sample inside a transition rollup" + } }, - "ComponentsSummaryDto": { + "DnsMaxAnswersAssertion": { "required": [ - "groupComponentCounts", - "includedCount", - "totalCount" + "type", + "recordType", + "max" ], "type": "object", "properties": { - "totalCount": { - "type": "integer", - "description": "Total active components for this service across all groups", - "format": "int32" + "type": { + "type": "string", + "enum": [ + "dns_max_answers" + ] + }, + "recordType": { + "minLength": 1, + "type": "string", + "description": "DNS record type whose answer count is checked" }, - "includedCount": { + "max": { "type": "integer", - "description": "Number of components actually returned in the inline ``components`` list", + "description": "Maximum number of answers allowed for that record type", "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": { + "DnsMinAnswersAssertion": { "required": [ - "id", - "name", - "status" + "type", + "recordType", + "min" ], "type": "object", "properties": { - "id": { + "type": { "type": "string", - "description": "Component UUID" + "enum": [ + "dns_min_answers" + ] }, - "name": { + "recordType": { + "minLength": 1, "type": "string", - "description": "Human-readable component name" + "description": "DNS record type whose answer count is checked" }, - "status": { - "type": "string", - "description": "Current component status, e.g. operational, degraded_performance" + "min": { + "type": "integer", + "description": "Minimum number of answers required for that record type", + "format": "int32" } - }, - "description": "Current status of each active component" + } }, - "ComponentTransitionEventDto": { + "DnsMonitorConfig": { "required": [ - "componentSample", - "newStatus", - "componentCount" + "hostname" ], "type": "object", "properties": { - "newStatus": { + "hostname": { + "minLength": 1, "type": "string", - "description": "New status that defines this rollup bucket" + "description": "Domain name to resolve" }, - "componentCount": { - "type": "integer", - "description": "Total components in the 5-minute rollup bucket", - "format": "int32" + "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" + ] + } }, - "componentSample": { + "nameservers": { "type": "array", - "description": "Up to 5 sample components from the bucket", + "description": "Custom nameservers to query (uses system defaults if omitted)", + "nullable": true, "items": { - "$ref": "#/components/schemas/ComponentSample" + "type": "string", + "description": "Custom nameservers to query (uses system defaults if omitted)", + "nullable": true } + }, + "timeoutMs": { + "type": "integer", + "description": "Per-query timeout in milliseconds", + "format": "int32", + "nullable": true + }, + "totalTimeoutMs": { + "type": "integer", + "description": "Total timeout for all queries in milliseconds", + "format": "int32", + "nullable": true } - }, - "description": "Rolled-up component status transitions for a status-events rail row" + } }, - "ComponentUptimeDayDto": { + "DnsRecordContainsAssertion": { "required": [ - "date", - "partialOutageSeconds", - "majorOutageSeconds", - "degradedSeconds", - "uptimePercentage" + "type", + "recordType", + "substring" ], "type": "object", "properties": { - "date": { + "type": { "type": "string", - "description": "Start-of-day timestamp for this bucket (UTC midnight, ISO 8601)", - "format": "date-time" - }, - "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" - }, - "degradedSeconds": { - "type": "integer", - "description": "Seconds the component spent in degraded performance on this day", - "format": "int32" + "enum": [ + "dns_record_contains" + ] }, - "uptimePercentage": { - "type": "number", - "description": "Computed uptime percentage using the weighted formula (degraded does not lower it)", - "format": "double" + "recordType": { + "minLength": 1, + "type": "string", + "description": "DNS record type to assert on (A, AAAA, CNAME, MX, TXT)" }, - "incidents": { - "type": "array", - "description": "Incidents that overlapped this day, in display order", - "nullable": true, - "items": { - "$ref": "#/components/schemas/IncidentRef" - } + "substring": { + "minLength": 1, + "type": "string", + "description": "Substring that must appear in a matching record value" } - }, - "description": "Daily uptime data for a component" + } }, - "ComponentUptimeSummaryDto": { + "DnsRecordEqualsAssertion": { "required": [ - "source" + "type", + "recordType", + "value" ], "type": "object", "properties": { - "day": { - "type": "number", - "description": "Uptime percentage over the last 24 hours", - "format": "double", - "nullable": true, - "example": 99.95 - }, - "week": { - "type": "number", - "description": "Uptime percentage over the last 7 days", - "format": "double", - "nullable": true, - "example": 99.98 + "type": { + "type": "string", + "enum": [ + "dns_record_equals" + ] }, - "month": { - "type": "number", - "description": "Uptime percentage over the last 30 days", - "format": "double", - "nullable": true, - "example": 99.92 + "recordType": { + "minLength": 1, + "type": "string", + "description": "DNS record type to assert on (A, AAAA, CNAME, MX, TXT)" }, - "source": { + "value": { + "minLength": 1, "type": "string", - "description": "Data source: vendor_reported or incident_derived", - "example": "vendor_reported" + "description": "Expected DNS record value for an exact match" } - }, - "description": "Inline uptime percentages for 24h, 7d, 30d" + } }, - "ConfirmationPolicy": { + "DnsResolvesAssertion": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "dns_resolves" + ] + } + }, "required": [ - "type", - "minRegionsFailing", - "maxWaitSeconds" - ], + "type" + ] + }, + "DnsResponseTimeAssertion": { "type": "object", "properties": { "type": { "type": "string", - "description": "How incident confirmation is coordinated across regions", "enum": [ - "multi_region" + "dns_response_time" ] }, - "minRegionsFailing": { - "type": "integer", - "description": "Minimum failing regions required to confirm an incident", - "format": "int32" - }, - "maxWaitSeconds": { + "maxMs": { "type": "integer", - "description": "Maximum seconds to wait for enough regions to fail after first trigger", + "description": "Maximum allowed DNS resolution time in milliseconds", "format": "int32" } }, - "description": "Multi-region confirmation settings" - }, - "CreateAlertChannelRequest": { "required": [ - "config", - "name" - ], + "type", + "maxMs" + ] + }, + "DnsResponseTimeWarnAssertion": { "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, + "type": { "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" - } + "enum": [ + "dns_response_time_warn" ] }, - "managedBy": { + "warnMs": { + "type": "integer", + "description": "DNS resolution time in milliseconds that triggers a warning only", + "format": "int32" + } + }, + "required": [ + "type", + "warnMs" + ] + }, + "DnsTtlHighAssertion": { + "type": "object", + "properties": { + "type": { "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" + "dns_ttl_high" ] + }, + "maxTtl": { + "type": "integer", + "description": "Maximum TTL in seconds before a high-TTL warning is raised", + "format": "int32" } - } + }, + "required": [ + "type", + "maxTtl" + ] }, - "CreateApiKeyRequest": { + "DnsTtlLowAssertion": { "required": [ - "name" + "type", + "minTtl" ], "type": "object", "properties": { - "name": { - "maxLength": 200, - "minLength": 0, + "type": { "type": "string", - "description": "Human-readable name to identify this API key" + "enum": [ + "dns_ttl_low" + ] }, - "expiresAt": { - "type": "string", - "description": "Optional expiration timestamp in ISO 8601 format", - "format": "date-time", - "nullable": true + "minTtl": { + "type": "integer", + "description": "Minimum acceptable TTL in seconds before a warning is raised", + "format": "int32" } } }, - "CreateAssertionRequest": { + "DnsTxtContainsAssertion": { "required": [ - "config" + "type", + "substring" ], "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" - } - ] - }, - "severity": { + "type": { "type": "string", - "description": "Outcome severity: FAIL (fails the check) or WARN (warns without failing, default: FAIL)", - "nullable": true, "enum": [ - "fail", - "warn" + "dns_txt_contains" ] + }, + "substring": { + "minLength": 1, + "type": "string", + "description": "Substring that must appear in at least one TXT record" } - }, - "description": "Replace all assertions; null preserves current" + } }, - "CreateEnvironmentRequest": { + "EmailChannelConfig": { "required": [ - "name", - "slug" + "channelType", + "recipients" ], "type": "object", "properties": { - "name": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "Human-readable environment name" - }, - "slug": { - "maxLength": 100, - "minLength": 0, - "pattern": "^[a-z0-9][a-z0-9_-]*$", + "channelType": { "type": "string", - "description": "URL-safe identifier (lowercase alphanumeric, hyphens, underscores)" + "enum": [ + "email" + ] }, - "variables": { - "type": "object", - "additionalProperties": { + "recipients": { + "minItems": 1, + "type": "array", + "description": "Email addresses to send notifications to", + "items": { "type": "string", - "description": "Initial key-value variable pairs for this environment", - "nullable": true - }, - "description": "Initial key-value variable pairs for this environment", - "nullable": true - }, - "isDefault": { - "type": "boolean", - "description": "Whether this is the default environment for new monitors (default: false)", - "nullable": true + "description": "Email addresses to send notifications to", + "format": "email" + } } } }, - "CreateInviteRequest": { + "EntitlementDto": { "required": [ - "email", - "roleOffered" + "key", + "value", + "defaultValue", + "overridden" ], "type": "object", "properties": { - "email": { - "minLength": 1, + "key": { "type": "string", - "description": "Email address to invite", - "format": "email" + "description": "Entitlement key" }, - "roleOffered": { - "type": "string", - "description": "Role to assign on acceptance", - "enum": [ - "OWNER", - "ADMIN", - "MEMBER" - ] + "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 this entitlement has an org-level override" } }, - "description": "Invite a new member to the organization by email" + "description": "A single resolved entitlement for the organization" }, - "CreateMaintenanceWindowRequest": { + "EnvironmentDto": { "required": [ - "endsAt", - "startsAt" + "createdAt", + "id", + "name", + "slug", + "updatedAt", + "variables", + "orgId", + "monitorCount", + "isDefault" ], "type": "object", "properties": { - "monitorId": { + "id": { "type": "string", - "description": "Monitor to attach this maintenance window to; null for org-wide", - "format": "uuid", - "nullable": true + "description": "Unique environment identifier", + "format": "uuid" }, - "startsAt": { + "orgId": { + "type": "integer", + "description": "Organization this environment belongs to", + "format": "int32" + }, + "name": { + "minLength": 1, "type": "string", - "description": "Scheduled start of the maintenance window (ISO 8601)", - "format": "date-time" + "description": "Human-readable environment name" }, - "endsAt": { + "slug": { + "minLength": 1, "type": "string", - "description": "Scheduled end of the maintenance window (ISO 8601)", - "format": "date-time" + "description": "URL-safe identifier" }, - "repeatRule": { - "maxLength": 100, - "minLength": 0, + "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": "Reserved: iCal RRULE for recurring windows (stored but not yet honored)", - "nullable": true + "description": "Timestamp when the environment was created", + "format": "date-time" }, - "reason": { - "maxLength": 500, - "minLength": 0, + "updatedAt": { "type": "string", - "description": "Human-readable reason for the maintenance (max 500 chars)", - "nullable": true + "description": "Timestamp when the environment was last updated", + "format": "date-time" }, - "suppressAlerts": { + "monitorCount": { + "type": "integer", + "description": "Number of monitors using this environment", + "format": "int32" + }, + "isDefault": { "type": "boolean", - "description": "Whether to suppress alerts during this window (default: true)", - "nullable": true + "description": "Whether this is the default environment for new monitors" } - } + }, + "description": "Environment with variable substitutions for monitor configs" }, - "CreateManualIncidentRequest": { + "ErrorEntry": { "required": [ - "severity", - "title" + "code", + "message" ], "type": "object", "properties": { - "title": { + "code": { "minLength": 1, "type": "string", - "description": "Short summary of the incident" - }, - "severity": { - "type": "string", - "description": "Incident severity: DOWN, DEGRADED, or MAINTENANCE", - "enum": [ - "DOWN", - "DEGRADED", - "MAINTENANCE" - ] - }, - "monitorId": { - "type": "string", - "description": "Monitor to associate with this incident", - "format": "uuid", - "nullable": true - }, - "body": { - "type": "string", - "description": "Detailed description or context for the incident", - "nullable": true + "description": "Stable machine-readable code; see ValidationErrorCode for the registry", + "example": "MONITOR_HEARTBEAT_GRACE_EXCEEDS_INTERVAL" }, - "serviceId": { + "field": { "type": "string", - "description": "Vendor service to link; optional for Dependencies create CTA", - "format": "uuid", - "nullable": true + "description": "JSON-pointer-like path to the offending field, or null for request-wide errors", + "nullable": true, + "example": "config.gracePeriod" }, - "serviceIncidentId": { + "message": { + "minLength": 1, "type": "string", - "description": "Vendor incident to link; idempotent if an active org incident already links it", - "format": "uuid", - "nullable": true + "description": "Human-readable message; safe to surface to end users" } - } + }, + "description": "One structured validation rejection" }, - "CreateMonitorRequest": { + "ErrorResponse": { "required": [ - "config", - "name", - "type" + "code", + "message", + "status", + "timestamp" ], "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": [ - "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": { - "maximum": 86400, - "minimum": 10, + "status": { "type": "integer", - "description": "Check frequency in seconds (10–86400); null defaults to plan minimum (60s on most paid plans)", + "description": "HTTP status code (mirrors the response status line)", "format": "int32", - "nullable": true - }, - "enabled": { - "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." - } + "example": 404 }, - "managedBy": { + "code": { "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": "Coarse machine-readable error category (e.g. NOT_FOUND, RATE_LIMITED); stable per status", + "example": "NOT_FOUND" }, - "environmentId": { + "message": { "type": "string", - "description": "Environment to associate with this monitor", - "format": "uuid", - "nullable": true - }, - "assertions": { - "type": "array", - "description": "Assertions to evaluate against each check result", - "nullable": true, - "items": { - "$ref": "#/components/schemas/CreateAssertionRequest" - } + "description": "Human-readable error message; safe to surface to end users", + "example": "Monitor not found" }, - "auth": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/MonitorAuthConfig" - } - ] + "timestamp": { + "type": "integer", + "description": "Server time when the error was produced (epoch milliseconds)", + "format": "int64", + "example": 1737302400000 }, - "incidentPolicy": { + "requestId": { + "type": "string", + "description": "Opaque per-request id; same value as the X-Request-Id response header. Use in support tickets.", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/UpdateIncidentPolicyRequest" - } - ] + "example": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a" }, - "alertChannelIds": { + "errors": { "type": "array", - "description": "Alert channels to notify when this monitor triggers", + "description": "Structured per-field rejections; populated for validation errors, null otherwise", "nullable": true, "items": { - "type": "string", - "description": "Alert channels to notify when this monitor triggers", - "format": "uuid" + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/ErrorEntry" + } + ] } - }, - "tags": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/AddMonitorTagsRequest" - } - ] } + }, + "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" } }, - "CreateNotificationPolicyRequest": { + "EscalationChain": { "required": [ - "escalation", - "name" + "steps" ], "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 - }, - "matchRules": { + "steps": { + "minItems": 1, "type": "array", - "description": "Match rules to evaluate (all must pass; omit or empty for catch-all)", - "nullable": true, + "description": "Ordered escalation steps, evaluated in sequence", "items": { - "$ref": "#/components/schemas/MatchRule" + "$ref": "#/components/schemas/EscalationStep" } }, - "escalation": { - "$ref": "#/components/schemas/EscalationChain" - }, - "enabled": { - "type": "boolean", - "description": "Whether this policy is enabled (default true)", - "nullable": true, - "default": true + "onResolve": { + "type": "string", + "description": "Action when the incident resolves", + "nullable": true }, - "priority": { - "type": "integer", - "description": "Evaluation priority; higher value = evaluated first (default 0)", - "format": "int32", - "nullable": true, - "default": 0 + "onReopen": { + "type": "string", + "description": "Action when a resolved incident reopens", + "nullable": true } }, - "description": "Request body for creating a notification policy" + "description": "Escalation chain defining which channels to notify; null preserves current" }, - "CreateResourceGroupRequest": { + "EscalationStep": { "required": [ - "name" + "channelIds", + "delayMinutes" ], "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "description": "Human-readable name for this group" - }, - "description": { - "maxLength": 500, - "minLength": 0, - "type": "string", - "description": "Optional description (max 500)", - "nullable": true - }, - "alertPolicyId": { - "type": "string", - "description": "Optional notification policy to apply for this group", - "format": "uuid", - "nullable": true - }, - "defaultFrequency": { - "maximum": 86400, - "minimum": 30, + "delayMinutes": { + "minimum": 0, "type": "integer", - "description": "Default check frequency in seconds applied to members (30–86400)", - "format": "int32", - "nullable": true - }, - "defaultRegions": { - "type": "array", - "description": "Default regions applied to member monitors", - "nullable": true, - "items": { - "type": "string", - "description": "Default regions applied to member monitors" - } - }, - "defaultRetryStrategy": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/RetryStrategy" - } - ] + "description": "Minutes to wait before executing this step (0 = immediate)", + "format": "int32" }, - "defaultAlertChannels": { + "channelIds": { + "minItems": 1, "type": "array", - "description": "Default alert channel IDs applied to member monitors", - "nullable": true, + "description": "Alert channel IDs to notify in this step", "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": "Confirmation delay in seconds before group incident creation (0–600)", - "format": "int32", + "type": "string", + "description": "Alert channel IDs to notify in this step", + "format": "uuid" + } + }, + "requireAck": { + "type": "boolean", + "description": "Whether an acknowledgment is required before escalating", "nullable": true }, - "recoveryCooldownMinutes": { - "maximum": 60, - "minimum": 0, + "repeatIntervalSeconds": { + "minimum": 1, "type": "integer", - "description": "Recovery cooldown in minutes after group incident resolves (0–60)", + "description": "Repeat notification interval in seconds until acknowledged", "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, - "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" - ] } }, - "description": "Request body for creating a resource group" + "description": "Ordered escalation steps, evaluated in sequence" }, - "CreateSecretRequest": { + "FailureDetail": { "required": [ - "key", - "value" + "monitorId", + "reason" ], "type": "object", "properties": { - "key": { - "maxLength": 255, - "minLength": 0, + "monitorId": { "type": "string", - "description": "Unique secret key within the workspace (max 255 chars)" + "description": "Monitor ID that failed", + "format": "uuid" }, - "value": { - "maxLength": 32768, - "minLength": 0, + "reason": { "type": "string", - "description": "Secret value, stored encrypted (max 32KB)" + "description": "Human-readable reason for the failure" } - } + }, + "description": "Details about a single monitor that failed the bulk action" }, - "CreateStatusPageComponentGroupRequest": { + "GitLabChannelConfig": { "required": [ - "name" + "channelType", + "endpointUrl", + "authorizationKey" ], "type": "object", "properties": { - "name": { - "maxLength": 255, - "minLength": 0, + "channelType": { "type": "string", - "description": "Group display name" + "enum": [ + "gitlab" + ] }, - "description": { - "maxLength": 500, - "minLength": 0, + "endpointUrl": { + "minLength": 1, "type": "string", - "description": "Optional group description", - "nullable": true - }, - "displayOrder": { - "type": "integer", - "description": "Position in the group list", - "format": "int32", - "nullable": true + "description": "GitLab alert integration endpoint 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)", - "nullable": true + "authorizationKey": { + "minLength": 1, + "type": "string", + "description": "Authorization key from GitLab alert integration settings" } } }, - "CreateStatusPageComponentRequest": { + "GlobalStatusSummaryDto": { "required": [ - "name", - "type" + "servicesWithIssues", + "totalServices", + "operationalCount", + "degradedCount", + "partialOutageCount", + "majorOutageCount", + "maintenanceCount", + "unknownCount", + "activeIncidentCount" ], "type": "object", "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": { - "type": "string", - "description": "Component type: MONITOR, GROUP, STATIC, or DEPENDENCY", - "enum": [ - "MONITOR", - "GROUP", - "STATIC", - "DEPENDENCY" - ] + "totalServices": { + "type": "integer", + "description": "Total number of services in the catalog", + "format": "int32" }, - "monitorId": { - "type": "string", - "description": "Monitor ID (required when type=MONITOR)", - "format": "uuid", - "nullable": true + "operationalCount": { + "type": "integer", + "description": "Number of services currently fully operational", + "format": "int32" }, - "resourceGroupId": { - "type": "string", - "description": "Resource group ID (required when type=GROUP)", - "format": "uuid", - "nullable": true + "degradedCount": { + "type": "integer", + "description": "Number of services with degraded status", + "format": "int32" }, - "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 + "partialOutageCount": { + "type": "integer", + "description": "Number of services with partial outage", + "format": "int32" }, - "groupId": { - "type": "string", - "description": "Component group ID for visual grouping", - "format": "uuid", - "nullable": true + "majorOutageCount": { + "type": "integer", + "description": "Number of services with major outage", + "format": "int32" }, - "showUptime": { - "type": "boolean", - "description": "Whether to show the uptime bar (default: true; false for DEPENDENCY)", - "nullable": true + "maintenanceCount": { + "type": "integer", + "description": "Number of services currently under maintenance", + "format": "int32" }, - "displayOrder": { + "unknownCount": { "type": "integer", - "description": "Position in the component list", - "format": "int32", - "nullable": true + "description": "Number of services with unknown or null status", + "format": "int32" }, - "excludeFromOverall": { - "type": "boolean", - "description": "Exclude from overall status calculation (default: false; true for DEPENDENCY)", - "nullable": true + "activeIncidentCount": { + "type": "integer", + "description": "Total number of active incidents across all services", + "format": "int64" }, - "startDate": { - "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", - "nullable": true + "servicesWithIssues": { + "type": "array", + "description": "Services that are not fully operational", + "items": { + "$ref": "#/components/schemas/ServiceCatalogDto" + } } - } + }, + "description": "Global status summary across all subscribed vendor services" }, - "CreateStatusPageIncidentRequest": { + "GoogleChatChannelConfig": { "required": [ - "body", - "impact", - "title" + "channelType", + "webhookUrl" ], "type": "object", "properties": { - "title": { - "maxLength": 500, - "minLength": 0, - "type": "string", - "description": "Customer-facing incident title" - }, - "status": { - "type": "string", - "description": "Initial status (default: INVESTIGATING)", - "nullable": true, - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" - ] - }, - "impact": { + "channelType": { "type": "string", - "description": "Impact level: NONE, MINOR, MAJOR, or CRITICAL", "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" + "google_chat" ] }, - "body": { + "webhookUrl": { "minLength": 1, "type": "string", - "description": "Initial update body in markdown" + "description": "Google Chat space webhook URL" + } + } + }, + "GroupComponentOrder": { + "required": [ + "groupId", + "positions" + ], + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "Group these components belong to", + "format": "uuid" }, - "affectedComponents": { + "positions": { + "minItems": 1, "type": "array", - "description": "Component IDs affected by this incident", - "nullable": true, + "description": "Ordered component IDs with their within-group display order", "items": { - "$ref": "#/components/schemas/AffectedComponent" + "$ref": "#/components/schemas/ComponentPosition" } - }, - "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 } - } + }, + "description": "Component ordering within a single group" }, - "CreateStatusPageIncidentUpdateRequest": { + "HeaderAuthConfig": { "required": [ - "body", - "status" + "type", + "headerName" ], "type": "object", "properties": { - "status": { + "type": { "type": "string", - "description": "Incident status at this point in the timeline", "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" + "header" ] }, - "body": { + "headerName": { "minLength": 1, + "pattern": "^[A-Za-z0-9\\-_]+$", "type": "string", - "description": "Update body in markdown" + "description": "Custom HTTP header name for the secret value" }, - "notifySubscribers": { - "type": "boolean", - "description": "Whether to email confirmed subscribers about this update (default: true)", + "vaultSecretId": { + "type": "string", + "description": "Vault secret ID for the header value", + "format": "uuid", "nullable": true - }, - "affectedComponents": { - "type": "array", - "description": "Updated affected components; null preserves current", - "nullable": true, - "items": { - "$ref": "#/components/schemas/AffectedComponent" - } } } }, - "CreateStatusPageMaintenanceRequest": { + "HeaderValueAssertion": { "required": [ - "body", - "impact", - "scheduledFor", - "title" + "type", + "headerName", + "expected", + "operator" ], "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" + "header_value" ] }, - "body": { + "headerName": { "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" - } + "description": "HTTP header name to assert on" }, - "scheduledFor": { + "expected": { + "minLength": 1, "type": "string", - "description": "Maintenance start time", - "format": "date-time" + "description": "Expected value to compare against" }, - "scheduledUntil": { + "operator": { "type": "string", - "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": "Comparison operator (equals, contains, less_than, greater_than, etc.)", + "enum": [ + "equals", + "contains", + "less_than", + "greater_than", + "matches", + "range" + ] } } }, - "CreateStatusPageRequest": { + "HeartbeatIntervalDriftAssertion": { "required": [ - "name", - "slug" + "type", + "maxDeviationPercent" ], "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, + "type": { "type": "string", - "description": "Optional description shown below the page header", - "nullable": true - }, - "branding": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/StatusPageBranding" - } + "enum": [ + "heartbeat_interval_drift" ] }, - "visibility": { + "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": { "type": "string", - "description": "Page visibility: PUBLIC, PASSWORD, or IP_RESTRICTED (default: PUBLIC)", - "nullable": true, "enum": [ - "PUBLIC", - "PASSWORD", - "IP_RESTRICTED" + "heartbeat_max_interval" ] }, - "enabled": { - "type": "boolean", - "description": "Whether the page is enabled (default: true)", - "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" }, - "incidentMode": { + "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": { "type": "string", - "description": "Incident mode: MANUAL, REVIEW, or AUTOMATIC (default: AUTOMATIC)", - "nullable": true, "enum": [ - "MANUAL", - "REVIEW", - "AUTOMATIC" + "heartbeat_payload_contains" ] }, - "managedBy": { + "path": { + "minLength": 1, + "type": "string", + "description": "JSONPath expression into the heartbeat ping JSON payload" + }, + "value": { + "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": { "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" + "heartbeat_received" ] } - } - }, - "CreateTagRequest": { + }, "required": [ - "name" - ], + "type" + ] + }, + "Http": { "type": "object", + "description": "HTTP check-type-specific details", "properties": { - "name": { - "maxLength": 100, - "minLength": 0, + "check_type": { "type": "string", - "description": "Tag name, unique within the org" + "enum": [ + "http" + ] }, - "color": { - "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", - "type": "string", - "description": "Hex color code (defaults to #6B7280 if omitted)", + "timing": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/TimingPhasesDto" + } + ] + }, + "bodyTruncated": { + "type": "boolean", + "description": "Whether the response body was truncated before storage", "nullable": true } }, - "description": "Request body for creating a tag" + "required": [ + "check_type" + ] }, - "CreateWebhookEndpointRequest": { + "HttpMonitorConfig": { "required": [ - "subscribedEvents", + "method", "url" ], "type": "object", "properties": { "url": { - "maxLength": 2048, - "minLength": 0, + "minLength": 1, "type": "string", - "description": "HTTPS endpoint that receives webhook event payloads" + "description": "Target URL to send requests to" }, - "description": { - "maxLength": 255, - "minLength": 0, + "method": { "type": "string", - "description": "Optional human-readable description", - "nullable": true + "description": "HTTP method: GET, POST, PUT, PATCH, DELETE, or HEAD", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "HEAD" + ] }, - "subscribedEvents": { - "minItems": 1, - "type": "array", - "description": "Event types to deliver", - "items": { - "minLength": 1, + "customHeaders": { + "type": "object", + "additionalProperties": { "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": "Additional HTTP headers to include in requests", + "nullable": true + }, + "description": "Additional HTTP headers to include in requests", + "nullable": true + }, + "requestBody": { + "type": "string", + "description": "Request body content for POST/PUT/PATCH methods", + "nullable": true + }, + "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 } } }, - "CreateWorkspaceRequest": { + "Icmp": { "required": [ - "name" + "check_type", + "host" ], "type": "object", + "description": "ICMP (ping) check-type-specific details", "properties": { - "name": { - "minLength": 1, + "check_type": { "type": "string", - "description": "Workspace name" - } - }, - "description": "Create a new workspace within the organization" - }, - "CreditPolicy": { - "type": "object", - "properties": { - "summary": { + "enum": [ + "icmp" + ] + }, + "host": { "type": "string", - "description": "Brief summary of credit policy", - "nullable": true + "description": "Target host", + "example": "1.1.1.1" }, - "maxCreditPercent": { + "packetsSent": { "type": "integer", - "description": "Max credit as percent of monthly fee", + "description": "Number of ICMP packets sent", "format": "int32", "nullable": true }, - "claimWindowDays": { + "packetsReceived": { "type": "integer", - "description": "Days to submit a credit claim after eligibility", + "description": "Number of ICMP packets received", "format": "int32", "nullable": true }, - "creditApplicationDays": { - "type": "integer", - "description": "Days for credit to be applied after approval", - "format": "int32", + "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 }, - "tiers": { - "type": "array", - "description": "Credit tiers by uptime threshold", - "nullable": true, - "items": { - "$ref": "#/components/schemas/CreditTier" - } + "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 } - }, - "description": "Service credit policy for SLA violations" + } }, - "CreditTier": { + "IcmpMonitorConfig": { "required": [ - "uptimeRange" + "host" ], "type": "object", "properties": { - "uptimeRange": { + "host": { + "minLength": 1, "type": "string", - "description": "Uptime range, e.g. '99.1% – 99.98%'" + "description": "Target hostname or IP address to ping" }, - "creditPercent": { + "packetCount": { + "maximum": 20, + "minimum": 1, "type": "integer", - "description": "Credit percent of monthly fee", + "description": "Number of ICMP packets to send", "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", + "timeoutMs": { + "type": "integer", + "description": "Ping timeout in milliseconds", + "format": "int32", "nullable": true } - }, - "description": "Credit tiers by uptime threshold" + } }, - "CursorPageCheckResultDto": { + "IcmpPacketLossAssertion": { "required": [ - "data", - "hasMore" + "type", + "maxPercent" ], "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": [ + "icmp_packet_loss" + ] }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" + "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" } - }, - "description": "Cursor-paginated response for time-series and append-only data" + } }, - "CursorPageIncidentActivityEventDto": { - "required": [ - "data", - "hasMore" - ], + "IcmpReachableAssertion": { "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 - }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" + "enum": [ + "icmp_reachable" + ] } }, - "description": "Cursor-paginated response for time-series and append-only data" - }, - "CursorPageServiceCatalogDto": { "required": [ - "data", - "hasMore" - ], + "type" + ] + }, + "IcmpResponseTimeAssertion": { "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": [ + "icmp_response_time" + ] }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" + "maxMs": { + "type": "integer", + "description": "Maximum average ICMP round-trip time in milliseconds", + "format": "int32" } }, - "description": "Cursor-paginated response for time-series and append-only data" - }, - "CursorPageServicePollResultDto": { "required": [ - "data", - "hasMore" - ], + "type", + "maxMs" + ] + }, + "IcmpResponseTimeWarnAssertion": { "type": "object", "properties": { - "data": { - "type": "array", - "description": "Items on this page", - "items": { - "$ref": "#/components/schemas/ServicePollResultDto" - } - }, - "nextCursor": { + "type": { "type": "string", - "description": "Opaque cursor for the next page; null when there are no more results", - "nullable": true + "enum": [ + "icmp_response_time_warn" + ] }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" + "warnMs": { + "type": "integer", + "description": "ICMP round-trip time in milliseconds that triggers a warning only", + "format": "int32" } }, - "description": "Cursor-paginated response for time-series and append-only data" + "required": [ + "type", + "warnMs" + ] }, - "CursorPageStatusEventDto": { + "IncidentActivityEventDto": { "required": [ - "data", - "hasMore" + "at", + "id", + "kind", + "summary" ], "type": "object", "properties": { - "data": { - "type": "array", - "description": "Items on this page", - "items": { - "$ref": "#/components/schemas/StatusEventDto" - } + "id": { + "type": "string", + "description": "Stable event ID (source row ID)", + "format": "uuid" }, - "nextCursor": { + "at": { "type": "string", - "description": "Opaque cursor for the next page; null when there are no more results", + "description": "When the event occurred (ISO 8601)", + "format": "date-time" + }, + "kind": { + "type": "string", + "description": "Activity event kind in the merged incident activity stream", + "enum": [ + "update", + "dispatch", + "delivery", + "forensic_transition", + "status_page_update" + ] + }, + "actor": { + "type": "string", + "description": "Actor label when known (user email, system, etc.)", "nullable": true }, - "hasMore": { - "type": "boolean", - "description": "Whether more results exist beyond this page" - } - }, - "description": "Cursor-paginated response for time-series and append-only data" - }, - "DashboardOverviewDto": { - "required": [ - "incidents", - "monitors" - ], - "type": "object", - "properties": { - "monitors": { - "$ref": "#/components/schemas/MonitorsSummaryDto" + "summary": { + "type": "string", + "description": "Human-readable summary of the event" }, - "incidents": { - "$ref": "#/components/schemas/IncidentsSummaryDto" + "payload": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/IncidentActivityPayloadDto" + } + ] } }, - "description": "Combined dashboard overview for monitors and incidents" + "description": "Merged incident activity event (updates, dispatches, deliveries, forensics, SP updates)" }, - "DatadogChannelConfig": { - "required": [ - "channelType", - "apiKey" - ], + "IncidentActivityPayloadDto": { "type": "object", "properties": { - "channelType": { + "oldStatus": { "type": "string", - "enum": [ - "datadog" - ] + "description": "Previous incident status on an update", + "nullable": true }, - "apiKey": { - "minLength": 1, + "newStatus": { "type": "string", - "description": "Datadog API key" + "description": "New incident status on an update", + "nullable": true }, - "site": { + "body": { "type": "string", - "description": "Datadog site region (e.g. datadoghq.com, datadoghq.eu, us3.datadoghq.com)", + "description": "Update or status-page note body", "nullable": true }, - "tags": { + "createdBy": { "type": "string", - "description": "Comma-separated tags to attach to events", + "description": "Who created the update (SYSTEM, USER, …)", "nullable": true - } - } - }, - "DayIncident": { - "required": [ - "affectedComponentIds", - "affectedComponentNames", - "id", - "impact", - "status", - "title", - "scheduled" - ], - "type": "object", - "properties": { - "id": { + }, + "phase": { + "type": "string", + "description": "Dispatch lifecycle phase (fired, acked)", + "nullable": true + }, + "status": { + "type": "string", + "description": "Dispatch, delivery, or status-page status", + "nullable": true + }, + "policyId": { + "type": "string", + "description": "Notification policy id for a dispatch row", + "nullable": true + }, + "policyName": { + "type": "string", + "description": "Notification policy name when resolved", + "nullable": true + }, + "currentStep": { + "type": "integer", + "description": "Current escalation step (1-based)", + "format": "int32", + "nullable": true + }, + "dispatchId": { + "type": "string", + "description": "Notification dispatch id", + "nullable": true + }, + "acknowledgedBy": { + "type": "string", + "description": "Who acknowledged the dispatch", + "nullable": true + }, + "acknowledgedVia": { + "type": "string", + "description": "Ack channel (UI, Slack, …)", + "nullable": true + }, + "eventType": { + "type": "string", + "description": "Alert delivery event type", + "nullable": true + }, + "stepNumber": { + "type": "integer", + "description": "Escalation step that sent this delivery", + "format": "int32", + "nullable": true + }, + "fireCount": { + "type": "integer", + "description": "How many times this delivery has fired", + "format": "int32", + "nullable": true + }, + "channelId": { "type": "string", - "description": "Status page incident UUID", - "format": "uuid" + "description": "Alert channel id", + "nullable": true }, - "title": { + "channelName": { "type": "string", - "description": "Incident title" + "description": "Alert channel name", + "nullable": true }, - "status": { + "channelType": { "type": "string", - "description": "Lifecycle status (investigating, identified, monitoring, resolved, …)", - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" - ] + "description": "Alert channel type", + "nullable": true }, - "impact": { + "errorMessage": { "type": "string", - "description": "Severity bucket (none, minor, major, critical)", - "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" - ] + "description": "Delivery error message when the send failed", + "nullable": true }, - "scheduled": { - "type": "boolean", - "description": "True for a maintenance window; false for an incident" + "fromStatus": { + "type": "string", + "description": "Forensic from-status", + "nullable": true }, - "startedAt": { + "toStatus": { "type": "string", - "description": "Incident start timestamp", - "format": "date-time", + "description": "Forensic to-status", "nullable": true }, - "resolvedAt": { + "reason": { "type": "string", - "description": "Incident resolved timestamp; null while still active", - "format": "date-time", + "description": "Forensic transition reason", "nullable": true }, - "affectedComponentNames": { + "affectedRegions": { "type": "array", - "description": "Display names of components affected by this incident (deduplicated)", + "description": "Regions named on the forensic transition", + "nullable": true, "items": { "type": "string", - "description": "Display names of components affected by this incident (deduplicated)" + "description": "Regions named on the forensic transition" } }, - "affectedComponentIds": { - "type": "array", - "description": "UUIDs of components this incident affected", - "items": { - "type": "string", - "description": "UUIDs of components this incident affected", - "format": "uuid" - } + "statusPageIncidentId": { + "type": "string", + "description": "Linked status-page incident id", + "nullable": true } }, - "description": "Incident that overlapped the day" + "description": "Kind-specific activity fields; omitted keys are absent, not null" }, - "DekRotationResultDto": { + "IncidentDetailDto": { "required": [ - "rotatedAt", - "previousDekVersion", - "newDekVersion", - "secretsReEncrypted", - "channelsReEncrypted" + "incident", + "updates" ], "type": "object", "properties": { - "previousDekVersion": { - "type": "integer", - "description": "DEK version before rotation", - "format": "int32" - }, - "newDekVersion": { - "type": "integer", - "description": "DEK version after rotation", - "format": "int32" - }, - "secretsReEncrypted": { - "type": "integer", - "description": "Number of secrets re-encrypted with the new DEK", - "format": "int32" + "incident": { + "$ref": "#/components/schemas/IncidentDto" }, - "channelsReEncrypted": { - "type": "integer", - "description": "Number of alert channels re-encrypted with the new DEK", - "format": "int32" + "updates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IncidentUpdateDto" + } }, - "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" + "statusPageIncidents": { + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/LinkedStatusPageIncidentDto" + } }, - "disabledPolicies": { - "type": "integer", - "description": "Number of notification policies disabled because they had no remaining channels", - "format": "int32" + "trigger": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/IncidentTriggerDto" + } + ] } - }, - "description": "Summary of policies affected by channel deletion", - "required": [ - "affectedPolicies", - "disabledPolicies" - ] + } }, - "DeliveryAttemptDto": { + "IncidentDto": { "required": [ - "attemptedAt", - "deliveryId", + "affectedRegions", + "createdAt", "id", + "severity", + "source", "status", - "attemptNumber" + "updatedAt", + "organizationId", + "reopenCount", + "statusPageVisible", + "suppressDispatch" ], "type": "object", "properties": { "id": { "type": "string", + "description": "Unique incident identifier", "format": "uuid" }, - "deliveryId": { + "monitorId": { "type": "string", - "format": "uuid" + "description": "Monitor that triggered the incident; null for service or manual incidents", + "format": "uuid", + "nullable": true }, - "attemptNumber": { + "organizationId": { "type": "integer", - "description": "1-based attempt number", + "description": "Organization this incident belongs to", "format": "int32" }, - "status": { + "source": { "type": "string", - "description": "Outcome: SUCCESS, FAILED, TIMEOUT, ERROR" + "description": "Incident origin: MONITOR, SERVICE, or MANUAL", + "enum": [ + "AUTOMATIC", + "MANUAL", + "MONITORS", + "STATUS_DATA", + "RESOURCE_GROUP" + ] }, - "responseStatusCode": { - "type": "integer", - "description": "HTTP response status code from the external service", - "format": "int32", - "nullable": true + "status": { + "type": "string", + "description": "Current lifecycle status (OPEN, RESOLVED, etc.)", + "enum": [ + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" + ] }, - "requestPayload": { + "severity": { "type": "string", - "description": "JSON payload sent to the external service", - "nullable": true + "description": "Severity level: DOWN, DEGRADED, or MAINTENANCE", + "enum": [ + "DOWN", + "DEGRADED", + "MAINTENANCE" + ] }, - "responseBody": { + "title": { "type": "string", - "description": "Response body from the external service (truncated)", + "description": "Short summary of the incident; null for auto-generated incidents", "nullable": true }, - "errorMessage": { + "triggeredByRule": { "type": "string", - "description": "Error message if the attempt failed", + "description": "Human-readable description of the trigger rule that fired", "nullable": true }, - "responseTimeMs": { + "affectedRegions": { + "type": "array", + "description": "Probe regions that observed the failure", + "items": { + "type": "string", + "description": "Probe regions that observed the failure" + } + }, + "reopenCount": { "type": "integer", - "description": "Round-trip time in milliseconds", + "description": "Number of times this incident has been reopened", + "format": "int32" + }, + "createdByUserId": { + "type": "integer", + "description": "User who created the incident (manual incidents only)", "format": "int32", "nullable": true }, - "externalId": { + "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": { "type": "string", - "description": "External identifier (e.g. PagerDuty dedup_key, SES MessageId, webhook delivery UUID)", + "description": "Linked vendor service incident ID; null for monitor incidents", + "format": "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", + "serviceId": { + "type": "string", + "description": "Linked service catalog ID; null for monitor incidents", + "format": "uuid", "nullable": true }, - "attemptedAt": { - "type": "string", - "format": "date-time" - } - }, - "description": "Single delivery attempt with request/response audit data" - }, - "DeployLockDto": { - "required": [ - "expiresAt", - "id", - "lockedAt", - "lockedBy" - ], - "type": "object", - "properties": { - "id": { + "externalRef": { "type": "string", - "description": "Unique lock identifier", - "format": "uuid" + "description": "External reference ID (e.g. PagerDuty incident ID)", + "nullable": true }, - "lockedBy": { - "minLength": 1, - "type": "string", - "description": "Identity of the lock holder (e.g. CLI session ID, username)" + "affectedComponents": { + "type": "array", + "description": "Service components affected by this incident", + "nullable": true, + "items": { + "type": "string", + "description": "Service components affected by this incident" + } }, - "lockedAt": { + "shortlink": { "type": "string", - "description": "Timestamp when the lock was acquired", - "format": "date-time" + "description": "Short URL linking to the incident details", + "nullable": true }, - "expiresAt": { - "type": "string", - "description": "Timestamp when the lock automatically expires", - "format": "date-time" - } - }, - "description": "Represents an active deploy lock for a workspace" - }, - "DiscordChannelConfig": { - "required": [ - "channelType", - "webhookUrl" - ], - "type": "object", - "properties": { - "channelType": { + "resolutionReason": { "type": "string", + "description": "How the incident was resolved (AUTO_RECOVERED, MANUAL, etc.)", + "nullable": true, "enum": [ - "discord" + "MANUAL", + "AUTO_RECOVERED", + "AUTO_RESOLVED" ] }, - "webhookUrl": { - "minLength": 1, + "resolutionNote": { "type": "string", - "description": "Discord webhook URL" + "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 }, - "mentionRoleId": { + "startedAt": { "type": "string", - "description": "Optional Discord role ID to mention in notifications", + "description": "Timestamp when the incident was detected or created", + "format": "date-time", "nullable": true - } - } - }, - "Dns": { - "type": "object", - "description": "DNS check-type-specific details", - "properties": { - "check_type": { - "type": "string", - "enum": [ - "dns" - ] }, - "hostname": { + "confirmedAt": { "type": "string", - "description": "Target hostname", + "description": "Timestamp when the incident was confirmed (multi-region confirmation)", + "format": "date-time", "nullable": true }, - "requestedTypes": { - "type": "array", - "description": "Requested DNS record types", - "nullable": true, - "items": { - "type": "string", - "description": "Requested DNS record types", - "nullable": true - } - }, - "usedResolver": { + "resolvedAt": { "type": "string", - "description": "Resolver used for lookup", + "description": "Timestamp when the incident was resolved", + "format": "date-time", "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", + "cooldownUntil": { + "type": "string", + "description": "Cooldown window end; new incidents suppressed until this time", + "format": "date-time", "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 - } + "createdAt": { + "type": "string", + "description": "Timestamp when the incident record was created", + "format": "date-time" }, - "failureKind": { + "updatedAt": { "type": "string", - "description": "Kind of DNS failure, if any", - "nullable": true - } - }, - "required": [ - "check_type" - ] - }, - "DnsExpectedCnameAssertion": { - "required": [ - "type", - "value" - ], - "type": "object", - "properties": { - "type": { + "description": "Timestamp when the incident was last updated", + "format": "date-time" + }, + "monitorName": { "type": "string", - "enum": [ - "dns_expected_cname" - ] + "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": { - "minLength": 1, + "serviceName": { "type": "string", - "description": "Expected CNAME target the resolution must include" - } - } - }, - "DnsExpectedIpsAssertion": { - "required": [ - "type", - "ips" - ], - "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": [ - "dns_expected_ips" - ] + "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 }, - "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" - } - } - } - }, - "DnsMaxAnswersAssertion": { - "required": [ - "type", - "recordType", - "max" - ], - "type": "object", - "properties": { - "type": { + "monitorType": { "type": "string", - "enum": [ - "dns_max_answers" - ] + "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 }, - "recordType": { - "minLength": 1, + "resourceGroupId": { "type": "string", - "description": "DNS record type whose answer count is checked" + "description": "Resource group that owns this incident; null when not group-managed", + "format": "uuid", + "nullable": true }, - "max": { - "type": "integer", - "description": "Maximum number of answers allowed for that record type", - "format": "int32" - } - } - }, - "DnsMinAnswersAssertion": { - "required": [ - "type", - "recordType", - "min" - ], - "type": "object", - "properties": { - "type": { + "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 + }, + "triggeringCheckId": { "type": "string", - "enum": [ - "dns_min_answers" - ] + "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 }, - "recordType": { - "minLength": 1, + "triggeredByRuleSnapshotHashHex": { "type": "string", - "description": "DNS record type whose answer count is checked" + "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 }, - "min": { + "triggeredByRuleIndex": { "type": "integer", - "description": "Minimum number of answers required for that record type", - "format": "int32" - } - } - }, - "DnsMonitorConfig": { - "required": [ - "hostname" - ], - "type": "object", - "properties": { - "hostname": { - "minLength": 1, + "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 + }, + "engineVersion": { "type": "string", - "description": "Domain name to resolve" + "description": "Detection engine semver that evaluated the rule. Omitted from JSON when null, treat missing as null.", + "nullable": true }, - "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" - ] - } + "displayKey": { + "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 }, - "nameservers": { + "alertCollapsedByResourceGroupIds": { "type": "array", - "description": "Custom nameservers to query (uses system defaults if omitted)", + "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": "Custom nameservers to query (uses system defaults if omitted)", - "nullable": true + "description": "Sticky union of resource-group IDs that suppressed a paging dispatch for this member incident; null when never written / legacy", + "format": "uuid" } }, - "timeoutMs": { + "peakFailingMemberCount": { "type": "integer", - "description": "Per-query timeout in milliseconds", + "description": "Peak non-operational member count while this RESOURCE_GROUP incident was open; null otherwise", "format": "int32", "nullable": true }, - "totalTimeoutMs": { - "type": "integer", - "description": "Total timeout for all queries in milliseconds", - "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" }, - "DnsRecordContainsAssertion": { + "IncidentEventDto": { "required": [ - "type", - "recordType", - "substring" + "incidentId", + "title" ], "type": "object", "properties": { - "type": { + "incidentId": { "type": "string", - "enum": [ - "dns_record_contains" - ] + "description": "Vendor catalog incident ID", + "format": "uuid" }, - "recordType": { - "minLength": 1, + "externalId": { "type": "string", - "description": "DNS record type to assert on (A, AAAA, CNAME, MX, TXT)" + "description": "Vendor-supplied external incident ID", + "nullable": true }, - "substring": { - "minLength": 1, - "type": "string", - "description": "Substring that must appear in a matching record value" - } - } - }, - "DnsRecordEqualsAssertion": { - "required": [ - "type", - "recordType", - "value" - ], - "type": "object", - "properties": { - "type": { + "title": { "type": "string", - "enum": [ - "dns_record_equals" - ] + "description": "Incident title from the vendor status page" }, - "recordType": { - "minLength": 1, + "impact": { "type": "string", - "description": "DNS record type to assert on (A, AAAA, CNAME, MX, TXT)" + "description": "Vendor impact level (major, minor, none)", + "nullable": true }, - "value": { - "minLength": 1, - "type": "string", - "description": "Expected DNS record value for an exact match" - } - } - }, - "DnsResolvesAssertion": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "dns_resolves" - ] - } - }, - "required": [ - "type" - ] - }, - "DnsResponseTimeAssertion": { - "type": "object", - "properties": { - "type": { + "status": { "type": "string", - "enum": [ - "dns_response_time" - ] + "description": "Vendor lifecycle status (only set on incident.update rows)", + "nullable": true }, - "maxMs": { - "type": "integer", - "description": "Maximum allowed DNS resolution time in milliseconds", - "format": "int32" - } - }, - "required": [ - "type", - "maxMs" - ] - }, - "DnsResponseTimeWarnAssertion": { - "type": "object", - "properties": { - "type": { + "body": { "type": "string", - "enum": [ - "dns_response_time_warn" - ] + "description": "Update body text (only set on incident.update rows)", + "nullable": true }, - "warnMs": { - "type": "integer", - "description": "DNS resolution time in milliseconds that triggers a warning only", - "format": "int32" - } - }, - "required": [ - "type", - "warnMs" - ] - }, - "DnsTtlHighAssertion": { - "type": "object", - "properties": { - "type": { + "shortlink": { "type": "string", - "enum": [ - "dns_ttl_high" - ] + "description": "Short public URL for the vendor incident", + "nullable": true }, - "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": { + "startedAt": { "type": "string", - "enum": [ - "dns_ttl_low" - ] + "description": "When the vendor incident started", + "format": "date-time", + "nullable": true }, - "minTtl": { - "type": "integer", - "description": "Minimum acceptable TTL in seconds before a warning is raised", - "format": "int32" - } - }, - "required": [ - "type", - "minTtl" - ] - }, - "DnsTxtContainsAssertion": { - "required": [ - "type", - "substring" - ], - "type": "object", - "properties": { - "type": { + "resolvedAt": { "type": "string", - "enum": [ - "dns_txt_contains" - ] + "description": "When the vendor incident resolved", + "format": "date-time", + "nullable": true }, - "substring": { - "minLength": 1, + "detectedAt": { "type": "string", - "description": "Substring that must appear in at least one TXT record" - } - } - }, - "EmailChannelConfig": { - "required": [ - "channelType", - "recipients" - ], - "type": "object", - "properties": { - "channelType": { + "description": "When DevHelm first detected the incident", + "format": "date-time", + "nullable": true + }, + "vendorCreatedAt": { "type": "string", - "enum": [ - "email" - ] + "description": "Vendor-reported creation timestamp", + "format": "date-time", + "nullable": true }, - "recipients": { - "minItems": 1, + "durationSeconds": { + "type": "integer", + "description": "Total duration in seconds (set on incident.resolved)", + "format": "int64", + "nullable": true + }, + "affectedComponentIds": { "type": "array", - "description": "Email addresses to send notifications to", + "description": "Affected component IDs from the vendor incident join", + "nullable": true, "items": { "type": "string", - "description": "Email addresses to send notifications to", - "format": "email" + "description": "Affected component IDs from the vendor incident join", + "format": "uuid" } } - } + }, + "description": "Vendor incident fields for a status-events rail row" }, - "EntitlementDto": { + "IncidentFailingMemberSnapshotDto": { "required": [ - "key", - "value", - "defaultValue", - "overridden" + "memberType", + "name" ], "type": "object", "properties": { - "key": { + "memberType": { "type": "string", - "description": "Entitlement key" + "description": "Member type: monitor or service" }, - "value": { - "type": "integer", - "description": "Effective limit value (overrides applied)", - "format": "int64" + "monitorId": { + "type": "string", + "description": "Monitor ID when memberType is monitor", + "format": "uuid", + "nullable": true }, - "defaultValue": { - "type": "integer", - "description": "Plan-tier default value before overrides", - "format": "int64" + "serviceId": { + "type": "string", + "description": "Service ID when memberType is service", + "format": "uuid", + "nullable": true }, - "overridden": { - "type": "boolean", - "description": "Whether this entitlement has an org-level override" + "name": { + "minLength": 1, + "type": "string", + "description": "Frozen display name at snapshot time" + }, + "membershipId": { + "type": "string", + "description": "Membership row ID when available", + "format": "uuid", + "nullable": true } }, - "description": "A single resolved entitlement for the organization" + "description": "Frozen failing member identity at peak failing count for a resource-group incident" }, - "EnvironmentDto": { - "required": [ - "createdAt", - "id", - "name", - "slug", - "updatedAt", - "variables", - "orgId", - "monitorCount", - "isDefault" - ], + "IncidentFilterParams": { "type": "object", "properties": { - "id": { + "status": { "type": "string", - "description": "Unique environment identifier", - "format": "uuid" - }, - "orgId": { - "type": "integer", - "description": "Organization this environment belongs to", - "format": "int32" + "description": "Filter by incident lifecycle status; null returns every status", + "nullable": true, + "enum": [ + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" + ] }, - "name": { - "minLength": 1, + "severity": { "type": "string", - "description": "Human-readable environment name" + "description": "Filter by severity; null returns every severity", + "nullable": true, + "enum": [ + "DOWN", + "DEGRADED", + "MAINTENANCE" + ] }, - "slug": { - "minLength": 1, + "source": { "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" + "description": "Filter by where the incident originated (auto, manual, third-party)", + "nullable": true, + "enum": [ + "AUTOMATIC", + "MANUAL", + "MONITORS", + "STATUS_DATA", + "RESOURCE_GROUP" + ] }, - "createdAt": { + "monitorId": { "type": "string", - "description": "Timestamp when the environment was created", - "format": "date-time" + "description": "Only return incidents tied to this monitor ID", + "format": "uuid", + "nullable": true }, - "updatedAt": { + "serviceId": { "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" + "description": "Only return incidents tied to this service ID (third-party services)", + "format": "uuid", + "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, + "resourceGroupId": { "type": "string", - "description": "Stable machine-readable code; see ValidationErrorCode for the registry", - "example": "MONITOR_HEARTBEAT_GRACE_EXCEEDS_INTERVAL" + "description": "Only return incidents owned by this resource group (incidents.resource_group_id)", + "format": "uuid", + "nullable": true }, - "field": { + "tagId": { "type": "string", - "description": "JSON-pointer-like path to the offending field, or null for request-wide errors", - "nullable": true, - "example": "config.gracePeriod" + "description": "Only return incidents whose monitor carries this tag", + "format": "uuid", + "nullable": true }, - "message": { - "minLength": 1, + "environmentId": { "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": { - "type": "integer", - "description": "HTTP status code (mirrors the response status line)", - "format": "int32", - "example": 404 + "description": "Only return incidents whose monitor lives in this environment", + "format": "uuid", + "nullable": true }, - "code": { + "excludeId": { "type": "string", - "description": "Coarse machine-readable error category (e.g. NOT_FOUND, RATE_LIMITED); stable per status", - "example": "NOT_FOUND" + "description": "Exclude this incident ID from results (related-incident lists)", + "format": "uuid", + "nullable": true }, - "message": { + "startedFrom": { "type": "string", - "description": "Human-readable error message; safe to surface to end users", - "example": "Monitor not found" - }, - "timestamp": { - "type": "integer", - "description": "Server time when the error was produced (epoch milliseconds)", - "format": "int64", - "example": 1737302400000 + "description": "Earliest startedAt to include (inclusive, ISO 8601)", + "format": "date-time", + "nullable": true }, - "requestId": { + "startedTo": { "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": "Latest startedAt to include (inclusive, ISO 8601)", + "format": "date-time", + "nullable": true }, - "errors": { - "type": "array", - "description": "Structured per-field rejections; populated for validation errors, null otherwise", - "nullable": true, - "items": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/ErrorEntry" - } - ] - } + "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": "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" - } + "required": [ + "page", + "size" + ] }, - "EscalationChain": { + "IncidentIoChannelConfig": { "required": [ - "steps" + "channelType", + "apiKey" ], "type": "object", "properties": { - "steps": { - "minItems": 1, - "type": "array", - "description": "Ordered escalation steps, evaluated in sequence", - "items": { - "$ref": "#/components/schemas/EscalationStep" - } + "channelType": { + "type": "string", + "enum": [ + "incident_io" + ] }, - "onResolve": { + "apiKey": { + "minLength": 1, "type": "string", - "description": "Action when the incident resolves", + "description": "incident.io API key with 'Create incidents' permission" + }, + "severityId": { + "type": "string", + "description": "Severity ID for created incidents (from List Severities API)", "nullable": true }, - "onReopen": { + "visibility": { "type": "string", - "description": "Action when a resolved incident reopens", + "description": "Incident visibility: public or private (default: public)", "nullable": true } - }, - "description": "Escalation chain defining which channels to notify; null preserves current" + } }, - "EscalationStep": { + "IncidentPolicyDto": { "required": [ - "channelIds", - "delayMinutes" + "confirmation", + "createdAt", + "id", + "monitorId", + "recovery", + "triggerRules", + "updatedAt" ], "type": "object", "properties": { - "delayMinutes": { - "minimum": 0, - "type": "integer", - "description": "Minutes to wait before executing this step (0 = immediate)", - "format": "int32" + "id": { + "type": "string", + "description": "Unique incident policy identifier", + "format": "uuid" }, - "channelIds": { - "minItems": 1, + "monitorId": { + "type": "string", + "description": "Monitor this policy is attached to", + "format": "uuid" + }, + "triggerRules": { "type": "array", - "description": "Alert channel IDs to notify in this step", + "description": "Array of trigger rules defining when an incident should be raised", "items": { - "type": "string", - "description": "Alert channel IDs to notify in this step", - "format": "uuid" + "$ref": "#/components/schemas/TriggerRule" } }, - "requireAck": { - "type": "boolean", - "description": "Whether an acknowledgment is required before escalating", + "confirmation": { + "$ref": "#/components/schemas/ConfirmationPolicy" + }, + "recovery": { + "$ref": "#/components/schemas/RecoveryPolicy" + }, + "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" + }, + "monitorRegionCount": { + "type": "integer", + "description": "Number of regions configured on the monitor (only set in internal API responses)", + "format": "int32", "nullable": true }, - "repeatIntervalSeconds": { - "minimum": 1, + "checkFrequencySeconds": { "type": "integer", - "description": "Repeat notification interval in seconds until acknowledged", + "description": "Monitor check frequency in seconds (only set in internal API responses)", "format": "int32", "nullable": true } }, - "description": "Ordered escalation steps, evaluated in sequence" + "description": "Incident detection, confirmation, and recovery policy for a monitor" }, - "FailureDetail": { + "IncidentRef": { "required": [ - "monitorId", - "reason" + "id", + "impact", + "title" ], "type": "object", "properties": { - "monitorId": { + "id": { "type": "string", - "description": "Monitor ID that failed", + "description": "Internal incident ID — UUID for status-page incidents, service incident UUID for catalog", "format": "uuid" }, - "reason": { + "title": { "type": "string", - "description": "Human-readable reason for the failure" + "description": "Incident title at the time of the overlap" + }, + "impact": { + "type": "string", + "description": "Incident impact level (e.g. minor, major, critical for catalog; NONE/MINOR/MAJOR/CRITICAL for status pages)" } }, - "description": "Details about a single monitor that failed the bulk action" + "description": "Lightweight reference to an incident overlapping a given uptime day" }, - "GitLabChannelConfig": { - "required": [ - "channelType", - "endpointUrl", - "authorizationKey" - ], + "IncidentsSummaryDto": { "type": "object", "properties": { - "channelType": { - "type": "string", - "enum": [ - "gitlab" - ] + "active": { + "type": "integer", + "format": "int64" }, - "endpointUrl": { - "minLength": 1, - "type": "string", - "description": "GitLab alert integration endpoint URL" + "resolvedToday": { + "type": "integer", + "format": "int64" }, - "authorizationKey": { - "minLength": 1, - "type": "string", - "description": "Authorization key from GitLab alert integration settings" + "mttr30d": { + "type": "number", + "format": "double", + "nullable": true } - } + }, + "description": "Incident summary counters", + "required": [ + "active", + "resolvedToday" + ] }, - "GlobalStatusSummaryDto": { + "IncidentStateTransitionDto": { "required": [ - "servicesWithIssues", - "totalServices", - "operationalCount", - "degradedCount", - "partialOutageCount", - "majorOutageCount", - "maintenanceCount", - "unknownCount", - "activeIncidentCount" + "affectedRegions", + "checkId", + "details", + "engineVersion", + "fromStatus", + "id", + "monitorId", + "occurredAt", + "policySnapshotHashHex", + "reason", + "toStatus", + "triggeringEvaluationIds" ], "type": "object", "properties": { - "totalServices": { - "type": "integer", - "description": "Total number of services in the catalog", - "format": "int32" + "id": { + "type": "string", + "description": "Forensic row UUID", + "format": "uuid" }, - "operationalCount": { - "type": "integer", - "description": "Number of services currently fully operational", - "format": "int32" + "occurredAt": { + "type": "string", + "description": "When the state transition occurred", + "format": "date-time" }, - "degradedCount": { - "type": "integer", - "description": "Number of services with degraded status", - "format": "int32" + "monitorId": { + "type": "string", + "description": "Monitor this transition pertains to", + "format": "uuid" }, - "partialOutageCount": { - "type": "integer", - "description": "Number of services with partial outage", - "format": "int32" + "incidentId": { + "type": "string", + "description": "Incident this transition belongs to; null for pre-incident (auto-cleared) transitions", + "format": "uuid", + "nullable": true }, - "majorOutageCount": { - "type": "integer", - "description": "Number of services with major outage", - "format": "int32" + "fromStatus": { + "minLength": 1, + "type": "string", + "description": "Previous status (WATCHING | TRIGGERED | CONFIRMED | RESOLVED)" }, - "maintenanceCount": { - "type": "integer", - "description": "Number of services currently under maintenance", - "format": "int32" + "toStatus": { + "minLength": 1, + "type": "string", + "description": "New status (WATCHING | TRIGGERED | CONFIRMED | RESOLVED)" }, - "unknownCount": { - "type": "integer", - "description": "Number of services with unknown or null status", - "format": "int32" + "reason": { + "minLength": 1, + "type": "string", + "description": "Why the transition fired (trigger | confirm | resolve | auto_clear | reopen)" }, - "activeIncidentCount": { - "type": "integer", - "description": "Total number of active incidents across all services", - "format": "int64" + "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" + } }, - "servicesWithIssues": { + "affectedRegions": { "type": "array", - "description": "Services that are not fully operational", + "description": "Regions whose evaluations contributed to this transition", "items": { - "$ref": "#/components/schemas/ServiceCatalogDto" + "type": "string", + "description": "Regions whose evaluations contributed to this transition" } - } - }, - "description": "Global status summary across all subscribed vendor services" - }, - "GoogleChatChannelConfig": { - "required": [ - "channelType", - "webhookUrl" - ], - "type": "object", - "properties": { - "channelType": { + }, + "policySnapshotHashHex": { + "minLength": 1, "type": "string", - "enum": [ - "google_chat" - ] + "description": "Hex-encoded hash of the policy snapshot that governed this transition" }, - "webhookUrl": { + "engineVersion": { "minLength": 1, "type": "string", - "description": "Google Chat space webhook URL" + "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": "State-machine transitions this check caused (may be empty if nothing fired)" }, - "GroupComponentOrder": { + "IncidentTimelineDto": { "required": [ - "groupId", - "positions" + "transitions", + "triggeringEvaluations" ], "type": "object", "properties": { - "groupId": { - "type": "string", - "description": "Group these components belong to", - "format": "uuid" + "transitions": { + "type": "array", + "description": "State-machine transitions in chronological order", + "items": { + "$ref": "#/components/schemas/IncidentStateTransitionDto" + } }, - "positions": { - "minItems": 1, + "triggeringEvaluations": { "type": "array", - "description": "Ordered component IDs with their within-group display order", + "description": "Rule evaluations that caused any of the transitions above. Correlate via evaluation.triggeringTransitionId == transition.id", "items": { - "$ref": "#/components/schemas/ComponentPosition" + "$ref": "#/components/schemas/RuleEvaluationDto" } + }, + "policySnapshot": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/PolicySnapshotDto" + } + ] } - }, - "description": "Component ordering within a single group" + } }, - "HeaderAuthConfig": { + "IncidentTriggerDto": { "required": [ - "type", - "headerName" + "source" ], "type": "object", "properties": { - "type": { + "ruleType": { "type": "string", - "enum": [ - "header" - ] + "description": "Trigger rule type (consecutive_failures, failures_in_window, response_time); null when unknown", + "nullable": true }, - "headerName": { - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-_]+$", + "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 + }, + "threshold": { + "type": "integer", + "description": "Rule required count or threshold_ms from forensics; null when unavailable", + "format": "int32", + "nullable": true + }, + "lastError": { "type": "string", - "description": "Custom HTTP header name for the secret value" + "description": "failure_reason from the triggering check result; null when unavailable", + "nullable": true }, - "vaultSecretId": { + "firstFailedCheckAt": { "type": "string", - "description": "Vault secret ID for the header value", - "format": "uuid", + "description": "Earliest failing check timestamp in the confirm window when computable; null otherwise", + "format": "date-time", "nullable": true + }, + "source": { + "minLength": 1, + "type": "string", + "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" }, - "HeaderValueAssertion": { + "IncidentUpdateDto": { "required": [ - "type", - "headerName", - "expected", - "operator" + "createdAt", + "id", + "incidentId", + "notifySubscribers" ], "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "header_value" - ] - }, - "headerName": { - "minLength": 1, + "id": { "type": "string", - "description": "HTTP header name to assert on" + "format": "uuid" }, - "expected": { - "minLength": 1, + "incidentId": { "type": "string", - "description": "Expected value to compare against" + "format": "uuid" }, - "operator": { + "oldStatus": { "type": "string", - "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", + "nullable": true, "enum": [ - "equals", - "contains", - "less_than", - "greater_than", - "matches", - "range" + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" ] - } - } - }, - "HeartbeatIntervalDriftAssertion": { - "required": [ - "type", - "maxDeviationPercent" - ], - "type": "object", - "properties": { - "type": { + }, + "newStatus": { "type": "string", + "nullable": true, "enum": [ - "heartbeat_interval_drift" + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" ] }, - "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": { + "body": { + "type": "string", + "nullable": true + }, + "createdBy": { "type": "string", + "nullable": true, "enum": [ - "heartbeat_max_interval" + "SYSTEM", + "USER" ] }, - "maxSeconds": { - "minimum": 1, - "type": "integer", - "description": "Maximum allowed gap in seconds between consecutive heartbeat pings", - "format": "int32" + "notifySubscribers": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time" } } }, - "HeartbeatMonitorConfig": { + "IntegrationConfigSchemaDto": { "required": [ - "expectedInterval", - "gracePeriod" + "channelFields", + "connectionFields" ], "type": "object", "properties": { - "expectedInterval": { - "maximum": 86400, - "minimum": 1, - "type": "integer", - "description": "Expected heartbeat interval in seconds", - "format": "int32" + "connectionFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IntegrationFieldDto" + } }, - "gracePeriod": { - "minimum": 1, - "type": "integer", - "description": "Grace period in seconds before marking as down", - "format": "int32" + "channelFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IntegrationFieldDto" + } } } }, - "HeartbeatPayloadContainsAssertion": { + "IntegrationDto": { "required": [ - "type", - "path", - "value" + "authType", + "configSchema", + "description", + "lifecycle", + "logoUrl", + "name", + "setupGuideUrl", + "tierAvailability", + "type" ], "type": "object", "properties": { "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "logoUrl": { + "type": "string" + }, + "authType": { + "type": "string" + }, + "tierAvailability": { "type": "string", "enum": [ - "heartbeat_payload_contains" + "FREE", + "STARTER", + "PRO", + "TEAM", + "BUSINESS", + "ENTERPRISE" ] }, - "path": { - "minLength": 1, - "type": "string", - "description": "JSONPath expression into the heartbeat ping JSON payload" + "lifecycle": { + "type": "string" }, - "value": { - "type": "string", - "description": "Expected value to compare against at that path" + "setupGuideUrl": { + "type": "string" + }, + "configSchema": { + "$ref": "#/components/schemas/IntegrationConfigSchemaDto" } } }, - "HeartbeatPingResponse": { + "IntegrationFieldDto": { "required": [ - "ok" + "key", + "label", + "required", + "sensitive", + "type" ], "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": { + "key": { + "type": "string" + }, + "label": { + "type": "string" + }, "type": { + "type": "string" + }, + "required": { + "type": "boolean" + }, + "sensitive": { + "type": "boolean" + }, + "placeholder": { "type": "string", - "enum": [ - "heartbeat_received" - ] - } - }, - "required": [ - "type" - ] - }, - "Http": { - "type": "object", - "description": "HTTP check-type-specific details", - "properties": { - "check_type": { + "nullable": true + }, + "helpText": { "type": "string", - "enum": [ - "http" - ] + "nullable": true }, - "timing": { + "options": { + "type": "array", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/TimingPhasesDto" - } - ] + "items": { + "type": "string" + } }, - "bodyTruncated": { - "type": "boolean", - "description": "Whether the response body was truncated before storage", + "default": { + "type": "string", "nullable": true } - }, - "required": [ - "check_type" - ] + } }, - "HttpMonitorConfig": { + "InviteDto": { "required": [ - "method", - "url" + "createdAt", + "email", + "expiresAt", + "roleOffered", + "inviteId" ], "type": "object", "properties": { - "url": { - "minLength": 1, + "inviteId": { + "type": "integer", + "description": "Unique invite identifier", + "format": "int32" + }, + "email": { "type": "string", - "description": "Target URL to send requests to" + "description": "Email address the invite was sent to" }, - "method": { + "roleOffered": { "type": "string", - "description": "HTTP method: GET, POST, PUT, PATCH, DELETE, or HEAD", + "description": "Role that will be assigned to the invitee on acceptance", "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "HEAD" + "OWNER", + "ADMIN", + "MEMBER" ] }, - "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 + "createdAt": { + "type": "string", + "description": "Timestamp when the invite was created", + "format": "date-time" }, - "requestBody": { + "expiresAt": { "type": "string", - "description": "Request body content for POST/PUT/PATCH methods", - "nullable": true + "description": "Timestamp when the invite expires", + "format": "date-time" }, - "contentType": { + "consumedAt": { "type": "string", - "description": "Content-Type header value for the request body", + "description": "Timestamp when the invite was accepted; null if not yet used", + "format": "date-time", "nullable": true }, - "verifyTls": { - "type": "boolean", - "description": "Whether to verify TLS certificates (default: 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" }, - "Icmp": { + "JiraChannelConfig": { "required": [ - "check_type", - "host" + "channelType", + "domain", + "email", + "apiToken", + "projectKey" ], "type": "object", - "description": "ICMP (ping) check-type-specific details", "properties": { - "check_type": { + "channelType": { "type": "string", "enum": [ - "icmp" + "jira" ] }, - "host": { + "domain": { + "minLength": 1, "type": "string", - "description": "Target host", - "example": "1.1.1.1" - }, - "packetsSent": { - "type": "integer", - "description": "Number of ICMP packets sent", - "format": "int32", - "nullable": true - }, - "packetsReceived": { - "type": "integer", - "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 + "description": "Atlassian instance domain (e.g. yourteam.atlassian.net)" }, - "maxRttMs": { - "type": "number", - "description": "Maximum round-trip time in ms", - "format": "double", - "nullable": true + "email": { + "minLength": 1, + "type": "string", + "description": "Atlassian account email for API authentication" }, - "jitterMs": { - "type": "number", - "description": "Jitter in ms", - "format": "double", - "nullable": true - } - } - }, - "IcmpMonitorConfig": { - "required": [ - "host" - ], - "type": "object", - "properties": { - "host": { + "apiToken": { "minLength": 1, "type": "string", - "description": "Target hostname or IP address to ping" + "description": "Atlassian API token" }, - "packetCount": { - "maximum": 20, - "minimum": 1, - "type": "integer", - "description": "Number of ICMP packets to send", - "format": "int32", - "nullable": true + "projectKey": { + "minLength": 1, + "type": "string", + "description": "Jira project key where issues are created (e.g. OPS)" }, - "timeoutMs": { - "type": "integer", - "description": "Ping timeout in milliseconds", - "format": "int32", + "issueType": { + "type": "string", + "description": "Issue type name (e.g. Bug, Task, Incident)", "nullable": true } } }, - "IcmpPacketLossAssertion": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "icmp_packet_loss" - ] - }, - "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" - } - }, + "JsonPathAssertion": { "required": [ "type", - "maxPercent" - ] - }, - "IcmpReachableAssertion": { + "path", + "expected", + "operator" + ], "type": "object", "properties": { "type": { "type": "string", "enum": [ - "icmp_reachable" + "json_path" ] - } - }, - "required": [ - "type" - ] - }, - "IcmpResponseTimeAssertion": { - "type": "object", - "properties": { - "type": { + }, + "path": { + "minLength": 1, "type": "string", - "enum": [ - "icmp_response_time" - ] + "description": "JSONPath expression to extract a value from the response body" }, - "maxMs": { - "type": "integer", - "description": "Maximum average ICMP round-trip time in milliseconds", - "format": "int32" - } - }, - "required": [ - "type", - "maxMs" - ] - }, - "IcmpResponseTimeWarnAssertion": { - "type": "object", - "properties": { - "type": { + "expected": { + "minLength": 1, + "type": "string", + "description": "Expected value to compare against" + }, + "operator": { "type": "string", + "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", "enum": [ - "icmp_response_time_warn" + "equals", + "contains", + "less_than", + "greater_than", + "matches", + "range" ] - }, - "warnMs": { - "type": "integer", - "description": "ICMP round-trip time in milliseconds that triggers a warning only", - "format": "int32" } - }, - "required": [ - "type", - "warnMs" - ] + } }, - "IncidentActivityEventDto": { + "KeyInfo": { "required": [ - "at", - "id", - "kind", - "summary" + "createdAt", + "name", + "id" ], "type": "object", "properties": { "id": { + "type": "integer", + "description": "Key ID", + "format": "int32" + }, + "name": { "type": "string", - "description": "Stable event ID (source row ID)", - "format": "uuid" + "description": "Human-readable key name" }, - "at": { + "createdAt": { "type": "string", - "description": "When the event occurred (ISO 8601)", + "description": "When the key was created", "format": "date-time" }, - "kind": { + "expiresAt": { + "type": "string", + "description": "When the key expires (null = never)", + "format": "date-time", + "nullable": true + }, + "lastUsedAt": { + "type": "string", + "description": "Last time the key was used", + "format": "date-time", + "nullable": true + } + }, + "description": "API key metadata" + }, + "LinearChannelConfig": { + "required": [ + "channelType", + "apiKey", + "teamId" + ], + "type": "object", + "properties": { + "channelType": { "type": "string", - "description": "Activity event kind in the merged incident activity stream", "enum": [ - "update", - "dispatch", - "delivery", - "forensic_transition", - "status_page_update" + "linear" ] }, - "actor": { + "apiKey": { + "minLength": 1, "type": "string", - "description": "Actor label when known (user email, system, etc.)", - "nullable": true + "description": "Linear API key" }, - "summary": { + "teamId": { + "minLength": 1, "type": "string", - "description": "Human-readable summary of the event" + "description": "Team ID to create issues in" }, - "payload": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/IncidentActivityPayloadDto" - } - ] + "labelId": { + "type": "string", + "description": "Label ID to attach to created issues", + "nullable": true } - }, - "description": "Merged incident activity event (updates, dispatches, deliveries, forensics, SP updates)" + } }, - "IncidentActivityPayloadDto": { + "LinkedStatusPageIncidentDto": { + "required": [ + "connectionMode", + "id", + "impact", + "pageIncidentMode", + "spIncidentId", + "status", + "statusPageId", + "statusPageName", + "statusPageSlug", + "title", + "scheduled" + ], "type": "object", "properties": { - "oldStatus": { + "id": { "type": "string", - "description": "Previous incident status on an update", - "nullable": true + "description": "Status page incident ID (same value as spIncidentId; kept for backwards compatibility)", + "format": "uuid" }, - "newStatus": { + "spIncidentId": { "type": "string", - "description": "New incident status on an update", - "nullable": true + "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" }, - "body": { + "statusPageName": { "type": "string", - "description": "Update or status-page note body", - "nullable": true + "description": "Parent status page display name" }, - "createdBy": { + "statusPageSlug": { "type": "string", - "description": "Who created the update (SYSTEM, USER, …)", - "nullable": true + "description": "Parent status page URL slug" }, - "phase": { + "title": { "type": "string", - "description": "Dispatch lifecycle phase (fired, acked)", - "nullable": true + "description": "Customer-facing incident title" }, "status": { "type": "string", - "description": "Dispatch, delivery, or status-page status", - "nullable": true + "description": "Current lifecycle status (INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED)", + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" + ] }, - "policyId": { + "impact": { "type": "string", - "description": "Notification policy id for a dispatch row", - "nullable": true + "description": "Impact level (NONE, MINOR, MAJOR, CRITICAL)", + "enum": [ + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" + ] }, - "policyName": { - "type": "string", - "description": "Notification policy name when resolved", - "nullable": true + "scheduled": { + "type": "boolean", + "description": "Scheduled maintenance flag" }, - "currentStep": { - "type": "integer", - "description": "Current escalation step (1-based)", - "format": "int32", + "publishedAt": { + "type": "string", + "description": "Publish time; null while draft", + "format": "date-time", "nullable": true }, - "dispatchId": { + "connectionMode": { "type": "string", - "description": "Notification dispatch id", - "nullable": true + "description": "Whether the linked SPI was created by automation (AUTO) or by a human/API caller (MANUAL)", + "enum": [ + "AUTO", + "MANUAL" + ] }, - "acknowledgedBy": { + "pageIncidentMode": { "type": "string", - "description": "Who acknowledged the dispatch", - "nullable": true + "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": { + "type": "string", + "description": "Component identifier", + "format": "uuid" }, - "acknowledgedVia": { + "name": { "type": "string", - "description": "Ack channel (UI, Slack, …)", - "nullable": true + "description": "Component name" }, - "eventType": { + "status": { "type": "string", - "description": "Alert delivery event type", - "nullable": true + "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" }, - "stepNumber": { - "type": "integer", - "description": "Escalation step that sent this delivery", - "format": "int32", - "nullable": true + "externalId": { + "type": "string", + "description": "Vendor-supplied external maintenance ID" }, - "fireCount": { - "type": "integer", - "description": "How many times this delivery has fired", - "format": "int32", - "nullable": true + "title": { + "type": "string", + "description": "Maintenance title from the vendor status page" }, - "channelId": { + "status": { "type": "string", - "description": "Alert channel id", - "nullable": true + "description": "Lifecycle status: scheduled, in_progress, verifying, completed" }, - "channelName": { + "impact": { "type": "string", - "description": "Alert channel name", + "description": "Vendor impact level", "nullable": true }, - "channelType": { + "shortlink": { "type": "string", - "description": "Alert channel type", + "description": "Short public URL for the vendor maintenance", "nullable": true }, - "errorMessage": { + "scheduledFor": { "type": "string", - "description": "Delivery error message when the send failed", + "description": "Scheduled start; null for undated maintenance", + "format": "date-time", "nullable": true }, - "fromStatus": { + "scheduledUntil": { "type": "string", - "description": "Forensic from-status", + "description": "Scheduled end", + "format": "date-time", "nullable": true }, - "toStatus": { + "startedAt": { "type": "string", - "description": "Forensic to-status", + "description": "When maintenance actually started", + "format": "date-time", "nullable": true }, - "reason": { + "completedAt": { "type": "string", - "description": "Forensic transition reason", + "description": "When maintenance completed", + "format": "date-time", "nullable": true }, - "affectedRegions": { + "affectedComponentIds": { "type": "array", - "description": "Regions named on the forensic transition", + "description": "Affected component IDs", "nullable": true, "items": { "type": "string", - "description": "Regions named on the forensic transition" + "description": "Affected component IDs", + "format": "uuid" } - }, - "statusPageIncidentId": { - "type": "string", - "description": "Linked status-page incident id", - "nullable": true } }, - "description": "Kind-specific activity fields; omitted keys are absent, not null" + "description": "Vendor maintenance fields for a status-events rail row" }, - "IncidentDetailDto": { + "MaintenanceUpdateDto": { "required": [ - "incident", - "updates" + "id", + "status" ], "type": "object", "properties": { - "incident": { - "$ref": "#/components/schemas/IncidentDto" + "id": { + "type": "string", + "description": "Unique update identifier", + "format": "uuid" }, - "updates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IncidentUpdateDto" - } + "status": { + "type": "string", + "description": "Status at the time of this update" }, - "statusPageIncidents": { - "type": "array", - "nullable": true, - "items": { - "$ref": "#/components/schemas/LinkedStatusPageIncidentDto" - } + "body": { + "type": "string", + "description": "Update message from the vendor", + "nullable": true }, - "trigger": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/IncidentTriggerDto" - } - ] + "displayAt": { + "type": "string", + "description": "Timestamp when this update was posted", + "format": "date-time", + "nullable": true } - } + }, + "description": "A status update within a scheduled maintenance lifecycle" }, - "IncidentDto": { + "MaintenanceWindowDto": { "required": [ - "affectedRegions", "createdAt", + "endsAt", "id", - "severity", - "source", - "status", - "updatedAt", + "startsAt", "organizationId", - "reopenCount", - "statusPageVisible", - "suppressDispatch" + "suppressAlerts" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Unique incident identifier", + "description": "Unique maintenance window identifier", "format": "uuid" }, "monitorId": { "type": "string", - "description": "Monitor that triggered the incident; null for service or manual incidents", + "description": "Monitor this window applies to; null for org-wide windows", "format": "uuid", "nullable": true }, "organizationId": { "type": "integer", - "description": "Organization this incident belongs to", + "description": "Organization this maintenance window belongs to", "format": "int32" }, - "source": { - "type": "string", - "description": "Incident origin: MONITOR, SERVICE, or MANUAL", - "enum": [ - "AUTOMATIC", - "MANUAL", - "MONITORS", - "STATUS_DATA", - "RESOURCE_GROUP" - ] - }, - "status": { + "startsAt": { "type": "string", - "description": "Current lifecycle status (OPEN, RESOLVED, etc.)", - "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" - ] + "description": "Scheduled start of the maintenance window", + "format": "date-time" }, - "severity": { + "endsAt": { "type": "string", - "description": "Severity level: DOWN, DEGRADED, or MAINTENANCE", - "enum": [ - "DOWN", - "DEGRADED", - "MAINTENANCE" - ] + "description": "Scheduled end of the maintenance window", + "format": "date-time" }, - "title": { + "repeatRule": { "type": "string", - "description": "Short summary of the incident; null for auto-generated incidents", + "description": "Reserved: iCal RRULE for recurring windows (stored but not yet honored)", "nullable": true }, - "triggeredByRule": { + "reason": { "type": "string", - "description": "Human-readable description of the trigger rule that fired", - "nullable": true - }, - "affectedRegions": { - "type": "array", - "description": "Probe regions that observed the failure", - "items": { - "type": "string", - "description": "Probe regions that observed the failure" - } - }, - "reopenCount": { - "type": "integer", - "description": "Number of times this incident has been reopened", - "format": "int32" - }, - "createdByUserId": { - "type": "integer", - "description": "User who created the incident (manual incidents only)", - "format": "int32", + "description": "Human-readable reason for the maintenance", "nullable": true }, - "statusPageVisible": { - "type": "boolean", - "description": "Whether this incident is visible on the status page" - }, - "suppressDispatch": { + "suppressAlerts": { "type": "boolean", - "description": "When true, alert channels are suppressed (AWARENESS silent tracking); false means Alerted" + "description": "Whether alerts are suppressed during this window" }, - "serviceIncidentId": { + "createdAt": { "type": "string", - "description": "Linked vendor service incident ID; null for monitor incidents", - "format": "uuid", - "nullable": true - }, - "serviceId": { + "description": "Timestamp when the window was created", + "format": "date-time" + } + }, + "description": "Scheduled maintenance window for a monitor" + }, + "MatchRule": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Linked service catalog ID; null for monitor incidents", - "format": "uuid", - "nullable": true + "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" + ] }, - "externalRef": { + "value": { "type": "string", - "description": "External reference ID (e.g. PagerDuty incident ID)", + "description": "Comparison value for single-value rules like severity_gte", "nullable": true }, - "affectedComponents": { + "monitorIds": { "type": "array", - "description": "Service components affected by this incident", + "description": "Monitor UUIDs to match for monitor_id_in rules", "nullable": true, "items": { "type": "string", - "description": "Service components affected by this incident" + "description": "Monitor UUIDs to match for monitor_id_in rules", + "format": "uuid" } }, - "shortlink": { - "type": "string", - "description": "Short URL linking to the incident details", - "nullable": true + "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" + } }, - "resolutionReason": { - "type": "string", - "description": "How the incident was resolved (AUTO_RECOVERED, MANUAL, etc.)", + "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": "Match rules to evaluate (all must pass; omit or empty for catch-all)" + }, + "MattermostChannelConfig": { + "required": [ + "channelType", + "webhookUrl" + ], + "type": "object", + "properties": { + "channelType": { + "type": "string", "enum": [ - "MANUAL", - "AUTO_RECOVERED", - "AUTO_RESOLVED" + "mattermost" ] }, - "resolutionNote": { + "webhookUrl": { + "minLength": 1, "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 + "description": "Mattermost incoming webhook URL" }, - "startedAt": { + "channel": { "type": "string", - "description": "Timestamp when the incident was detected or created", - "format": "date-time", + "description": "Override channel (if webhook allows)", "nullable": true }, - "confirmedAt": { + "iconUrl": { "type": "string", - "description": "Timestamp when the incident was confirmed (multi-region confirmation)", - "format": "date-time", + "description": "Custom bot icon URL", "nullable": true - }, - "resolvedAt": { + } + } + }, + "McpConnectsAssertion": { + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Timestamp when the incident was resolved", - "format": "date-time", - "nullable": true - }, - "cooldownUntil": { + "enum": [ + "mcp_connects" + ] + } + }, + "required": [ + "type" + ] + }, + "McpHasCapabilityAssertion": { + "required": [ + "type", + "capability" + ], + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Cooldown window end; new incidents suppressed until this time", - "format": "date-time", - "nullable": true + "enum": [ + "mcp_has_capability" + ] }, - "createdAt": { + "capability": { + "minLength": 1, "type": "string", - "description": "Timestamp when the incident record was created", - "format": "date-time" - }, - "updatedAt": { + "description": "Capability name the server must advertise, e.g. tools or resources" + } + } + }, + "McpMinToolsAssertion": { + "required": [ + "type", + "min" + ], + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Timestamp when the incident was last updated", - "format": "date-time" + "enum": [ + "mcp_min_tools" + ] }, - "monitorName": { + "min": { + "type": "integer", + "description": "Minimum number of tools the server must expose", + "format": "int32" + } + } + }, + "McpProtocolVersionAssertion": { + "required": [ + "type", + "version" + ], + "type": "object", + "properties": { + "type": { "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 + "enum": [ + "mcp_protocol_version" + ] }, - "serviceName": { + "version": { + "minLength": 1, "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": "Expected MCP protocol version string from the server handshake" + } + } + }, + "McpResponseTimeAssertion": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp_response_time" + ] }, - "serviceSlug": { + "maxMs": { + "type": "integer", + "description": "Maximum allowed MCP check duration in milliseconds", + "format": "int32" + } + }, + "required": [ + "type", + "maxMs" + ] + }, + "McpResponseTimeWarnAssertion": { + "type": "object", + "properties": { + "type": { "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 + "enum": [ + "mcp_response_time_warn" + ] }, - "monitorType": { + "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", - "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 + "enum": [ + "mcp_server" + ] }, - "resourceGroupId": { + "url": { "type": "string", - "description": "Resource group that owns this incident; null when not group-managed", - "format": "uuid", + "description": "MCP server URL", "nullable": true }, - "resourceGroupName": { + "protocolVersion": { "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.", + "description": "MCP protocol version", "nullable": true }, - "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", + "serverInfo": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "MCP server info (name, version, etc.)", + "nullable": true + }, + "description": "MCP server info (name, version, etc.)", "nullable": true }, - "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.", + "toolCount": { + "type": "integer", + "description": "Number of tools exposed", + "format": "int32", "nullable": true }, - "triggeredByRuleIndex": { + "resourceCount": { "type": "integer", - "description": "Index of the fired rule inside the policy's trigger_rules array. Omitted from JSON when null, treat missing as null.", + "description": "Number of resources exposed", "format": "int32", "nullable": true }, - "engineVersion": { - "type": "string", - "description": "Detection engine semver that evaluated the rule. Omitted from JSON when null, treat missing as null.", + "promptCount": { + "type": "integer", + "description": "Number of prompts exposed", + "format": "int32", "nullable": true - }, - "displayKey": { + } + }, + "required": [ + "check_type" + ] + }, + "McpServerMonitorConfig": { + "required": [ + "command" + ], + "type": "object", + "properties": { + "command": { + "minLength": 1, "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 + "description": "Command to execute to start the MCP server" }, - "alertCollapsedByResourceGroupIds": { + "args": { "type": "array", - "description": "Sticky union of resource-group IDs that suppressed a paging dispatch for this member incident; null when never written / legacy", + "description": "Command-line arguments for the MCP server process", "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" + "description": "Command-line arguments for the MCP server process", + "nullable": true } }, - "peakFailingMemberCount": { - "type": "integer", - "description": "Peak non-operational member count while this RESOURCE_GROUP incident was open; null otherwise", - "format": "int32", + "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 - }, - "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": { + "McpToolAvailableAssertion": { "required": [ - "incidentId", - "title" + "type", + "toolName" ], "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 - }, - "body": { - "type": "string", - "description": "Update body text (only set on incident.update rows)", - "nullable": true - }, - "shortlink": { - "type": "string", - "description": "Short public URL for the vendor incident", - "nullable": true - }, - "startedAt": { - "type": "string", - "description": "When the vendor incident started", - "format": "date-time", - "nullable": true - }, - "resolvedAt": { + "type": { "type": "string", - "description": "When the vendor incident resolved", - "format": "date-time", - "nullable": true + "enum": [ + "mcp_tool_available" + ] }, - "detectedAt": { + "toolName": { + "minLength": 1, "type": "string", - "description": "When DevHelm first detected the incident", - "format": "date-time", - "nullable": true - }, - "vendorCreatedAt": { + "description": "MCP tool name that must appear in the server's tool list" + } + } + }, + "McpToolCountChangedAssertion": { + "required": [ + "type", + "expectedCount" + ], + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Vendor-reported creation timestamp", - "format": "date-time", - "nullable": true + "enum": [ + "mcp_tool_count_changed" + ] }, - "durationSeconds": { + "expectedCount": { "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": "Expected tool count; warns when the live count differs", + "format": "int32" } - }, - "description": "Vendor incident fields for a status-events rail row" + } }, - "IncidentFailingMemberSnapshotDto": { + "MemberDto": { "required": [ - "memberType", - "name" + "createdAt", + "email", + "orgRole", + "status", + "userId" ], "type": "object", "properties": { - "memberType": { + "userId": { + "type": "integer", + "description": "User identifier of the member", + "format": "int32" + }, + "email": { "type": "string", - "description": "Member type: monitor or service" + "description": "Member email address" }, - "monitorId": { + "name": { "type": "string", - "description": "Monitor ID when memberType is monitor", - "format": "uuid", + "description": "Member display name; null if not set", "nullable": true }, - "serviceId": { + "orgRole": { "type": "string", - "description": "Service ID when memberType is service", - "format": "uuid", - "nullable": true + "description": "Member role within this organization (OWNER, ADMIN, MEMBER)", + "enum": [ + "OWNER", + "ADMIN", + "MEMBER" + ] }, - "name": { - "minLength": 1, + "status": { "type": "string", - "description": "Frozen display name at snapshot time" + "description": "Membership status (ACTIVE, PENDING, SUSPENDED)", + "enum": [ + "INVITED", + "ACTIVE", + "SUSPENDED", + "LEFT", + "REMOVED", + "DECLINED" + ] }, - "membershipId": { + "createdAt": { "type": "string", - "description": "Membership row ID when available", - "format": "uuid", - "nullable": true + "description": "Timestamp when the member was added to the organization", + "format": "date-time" } }, - "description": "Frozen failing member identity at peak failing count for a resource-group incident" + "description": "Organization member with role and status" }, - "IncidentFilterParams": { + "MemberRoleChangedMetadata": { + "required": [ + "kind", + "oldRole", + "newRole" + ], "type": "object", + "description": "Role transition recorded when an organization member's role changes.", "properties": { - "status": { + "kind": { "type": "string", - "description": "Filter by incident lifecycle status; null returns every status", - "nullable": true, "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" + "member_role_changed" ] }, - "severity": { + "oldRole": { "type": "string", - "description": "Filter by severity; null returns every severity", - "nullable": true, + "description": "Role the member held before the change", "enum": [ - "DOWN", - "DEGRADED", - "MAINTENANCE" + "OWNER", + "ADMIN", + "MEMBER" ] }, - "source": { + "newRole": { "type": "string", - "description": "Filter by where the incident originated (auto, manual, third-party)", - "nullable": true, + "description": "Role the member holds after the change", "enum": [ - "AUTOMATIC", - "MANUAL", - "MONITORS", - "STATUS_DATA", - "RESOURCE_GROUP" + "OWNER", + "ADMIN", + "MEMBER" ] - }, - "monitorId": { - "type": "string", - "description": "Only return incidents tied to this monitor ID", - "format": "uuid", - "nullable": true - }, - "serviceId": { - "type": "string", - "description": "Only return incidents tied to this service ID (third-party services)", - "format": "uuid", - "nullable": true - }, - "resourceGroupId": { - "type": "string", - "description": "Only return incidents owned by this resource group (incidents.resource_group_id)", - "format": "uuid", - "nullable": true - }, - "tagId": { - "type": "string", - "description": "Only return incidents whose monitor carries this tag", - "format": "uuid", - "nullable": true - }, - "environmentId": { - "type": "string", - "description": "Only return incidents whose monitor lives in this environment", - "format": "uuid", - "nullable": true - }, - "excludeId": { + } + } + }, + "MonitorAssertionDto": { + "required": [ + "assertionType", + "config", + "id", + "monitorId", + "severity" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "Exclude this incident ID from results (related-incident lists)", - "format": "uuid", - "nullable": true + "format": "uuid" }, - "startedFrom": { + "monitorId": { "type": "string", - "description": "Earliest startedAt to include (inclusive, ISO 8601)", - "format": "date-time", - "nullable": true + "format": "uuid" }, - "startedTo": { + "assertionType": { "type": "string", - "description": "Latest startedAt to include (inclusive, ISO 8601)", - "format": "date-time", - "nullable": true + "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" + ] }, - "page": { - "minimum": 0, - "type": "integer", - "description": "Zero-based page index (default: 0)", - "format": "int32", - "example": 0 + "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" + } + ] }, - "size": { - "maximum": 200, - "minimum": 1, - "type": "integer", - "description": "Number of incidents per page (1–200, default: 10)", - "format": "int32", - "example": 10 - } - }, - "required": [ - "page", - "size" - ] - }, - "IncidentIoChannelConfig": { - "required": [ - "channelType", - "apiKey" - ], - "type": "object", - "properties": { - "channelType": { + "severity": { "type": "string", "enum": [ - "incident_io" + "fail", + "warn" ] + } + } + }, + "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" }, - "apiKey": { - "minLength": 1, - "type": "string", - "description": "incident.io API key with 'Create incidents' permission" + { + "$ref": "#/components/schemas/BasicAuthConfig" }, - "severityId": { - "type": "string", - "description": "Severity ID for created incidents (from List Severities API)", - "nullable": true + { + "$ref": "#/components/schemas/HeaderAuthConfig" }, - "visibility": { - "type": "string", - "description": "Incident visibility: public or private (default: public)", - "nullable": true + { + "$ref": "#/components/schemas/ApiKeyAuthConfig" } - } + ] }, - "IncidentPolicyDto": { + "MonitorAuthDto": { "required": [ - "confirmation", - "createdAt", + "authType", + "config", "id", - "monitorId", - "recovery", - "triggerRules", - "updatedAt" + "monitorId" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Unique incident policy identifier", "format": "uuid" }, "monitorId": { "type": "string", - "description": "Monitor this policy is attached to", "format": "uuid" }, - "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": "Timestamp when the policy was created", - "format": "date-time" - }, - "updatedAt": { + "authType": { "type": "string", - "description": "Timestamp when the policy was last updated", - "format": "date-time" - }, - "monitorRegionCount": { - "type": "integer", - "description": "Number of regions configured on the monitor (only set in internal API responses)", - "format": "int32", - "nullable": true + "enum": [ + "bearer", + "basic", + "header", + "api_key" + ] }, - "checkFrequencySeconds": { - "type": "integer", - "description": "Monitor check frequency in seconds (only set in internal API responses)", - "format": "int32", - "nullable": true + "config": { + "oneOf": [ + { + "$ref": "#/components/schemas/ApiKeyAuthConfig" + }, + { + "$ref": "#/components/schemas/BasicAuthConfig" + }, + { + "$ref": "#/components/schemas/BearerAuthConfig" + }, + { + "$ref": "#/components/schemas/HeaderAuthConfig" + } + ] } - }, - "description": "Incident detection, confirmation, and recovery policy for a monitor" + } }, - "IncidentRef": { + "MonitorDto": { "required": [ + "config", + "createdAt", "id", - "impact", - "title" + "managedBy", + "name", + "regions", + "type", + "updatedAt", + "organizationId", + "frequencySeconds", + "enabled", + "muted" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Internal incident ID — UUID for status-page incidents, service incident UUID for catalog", + "description": "Unique monitor identifier", "format": "uuid" }, - "title": { - "type": "string", - "description": "Incident title at the time of the overlap" - }, - "impact": { - "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": { + "organizationId": { "type": "integer", - "format": "int64" + "description": "Organization this monitor belongs to", + "format": "int32" }, - "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": { + "name": { + "minLength": 1, "type": "string", - "description": "Forensic row UUID", - "format": "uuid" + "description": "Human-readable name for this monitor" }, - "occurredAt": { + "type": { "type": "string", - "description": "When the state transition occurred", - "format": "date-time" + "enum": [ + "HTTP", + "DNS", + "MCP_SERVER", + "TCP", + "ICMP", + "HEARTBEAT", + "BROWSER", + "MULTI_STEP_API" + ] }, - "monitorId": { - "type": "string", - "description": "Monitor this transition pertains to", - "format": "uuid" + "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" + } + ] }, - "incidentId": { - "type": "string", - "description": "Incident this transition belongs to; null for pre-incident (auto-cleared) transitions", - "format": "uuid", - "nullable": true + "frequencySeconds": { + "type": "integer", + "description": "Check frequency in seconds (30–86400)", + "format": "int32" }, - "fromStatus": { - "minLength": 1, + "enabled": { + "type": "boolean", + "description": "Whether the monitor is active" + }, + "regions": { + "type": "array", + "description": "Probe regions where checks are executed", + "items": { + "type": "string", + "description": "Probe regions where checks are executed" + } + }, + "managedBy": { "type": "string", - "description": "Previous status (WATCHING | TRIGGERED | CONFIRMED | RESOLVED)" + "description": "Source that created/owns this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API", + "enum": [ + "DASHBOARD", + "CLI", + "TERRAFORM", + "MCP", + "API" + ] }, - "toStatus": { - "minLength": 1, + "createdAt": { "type": "string", - "description": "New status (WATCHING | TRIGGERED | CONFIRMED | RESOLVED)" + "description": "Timestamp when the monitor was created", + "format": "date-time" }, - "reason": { - "minLength": 1, + "updatedAt": { "type": "string", - "description": "Why the transition fired (trigger | confirm | resolve | auto_clear | reopen)" + "description": "Timestamp when the monitor was last updated", + "format": "date-time" }, - "triggeringEvaluationIds": { + "assertions": { "type": "array", - "description": "rule_evaluation ids that caused this transition (may be empty for timeout-driven edges)", + "description": "Assertions evaluated against each check result; null on list responses", + "nullable": true, "items": { - "type": "string", - "description": "rule_evaluation ids that caused this transition (may be empty for timeout-driven edges)", - "format": "uuid" + "$ref": "#/components/schemas/MonitorAssertionDto" } }, - "affectedRegions": { + "tags": { "type": "array", - "description": "Regions whose evaluations contributed to this transition", + "description": "Tags applied to this monitor", + "nullable": true, "items": { - "type": "string", - "description": "Regions whose evaluations contributed to this transition" + "$ref": "#/components/schemas/TagDto" } }, - "policySnapshotHashHex": { - "minLength": 1, + "pingUrl": { "type": "string", - "description": "Hex-encoded hash of the policy snapshot that governed this transition" + "description": "Heartbeat ping URL; populated for HEARTBEAT monitors only", + "nullable": true }, - "engineVersion": { - "minLength": 1, - "type": "string", - "description": "Detection engine version that emitted this transition" + "environment": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/Summary" + } + ] }, - "checkId": { - "type": "string", - "description": "Scheduler-minted check execution ID (V92) of the triggering result", - "format": "uuid" + "auth": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/MonitorAuthConfig" + } + ] }, - "details": { - "$ref": "#/components/schemas/StateTransitionDetails" - } - }, - "description": "State-machine transitions this check caused (may be empty if nothing fired)" - }, - "IncidentTimelineDto": { - "required": [ - "transitions", - "triggeringEvaluations" - ], - "type": "object", - "properties": { - "transitions": { - "type": "array", - "description": "State-machine transitions in chronological order", - "items": { - "$ref": "#/components/schemas/IncidentStateTransitionDto" - } + "incidentPolicy": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/IncidentPolicyDto" + } + ] }, - "triggeringEvaluations": { + "alertChannelIds": { "type": "array", - "description": "Rule evaluations that caused any of the transitions above. Correlate via evaluation.triggeringTransitionId == transition.id", + "description": "Alert channel IDs linked to this monitor; populated on single-monitor responses", + "nullable": true, "items": { - "$ref": "#/components/schemas/RuleEvaluationDto" + "type": "string", + "description": "Alert channel IDs linked to this monitor; populated on single-monitor responses", + "format": "uuid" } }, - "policySnapshot": { + "currentStatus": { + "type": "string", + "description": "Current operational state. One of UP, DOWN, DEGRADED, PAUSED, or UNKNOWN", + "nullable": true, + "enum": [ + "up", + "degraded", + "down", + "paused", + "unknown" + ] + }, + "definitionId": { + "type": "string", + "description": "Definition id for a browser or multi-step monitor. Null on probe monitors", + "format": "uuid", + "nullable": true + }, + "capturePolicy": { "nullable": true, "allOf": [ { - "$ref": "#/components/schemas/PolicySnapshotDto" + "$ref": "#/components/schemas/CapturePolicy" } ] - } - } - }, - "IncidentTriggerDto": { - "required": [ - "source" - ], - "type": "object", - "properties": { - "ruleType": { - "type": "string", - "description": "Trigger rule type (consecutive_failures, failures_in_window, response_time); null when unknown", - "nullable": true }, - "ruleIndex": { + "fastRetryMaxAttempts": { "type": "integer", - "description": "0-based index into the policy trigger_rules array; null when unknown", + "description": "Fast-retry max attempts; null/0 = off", "format": "int32", "nullable": true }, - "count": { - "type": "integer", - "description": "Observed failing_streak or failures_in_window from forensics; null when unavailable", - "format": "int32", - "nullable": true + "muted": { + "type": "boolean", + "description": "Whether alert delivery is muted" }, - "threshold": { - "type": "integer", - "description": "Rule required count or threshold_ms from forensics; null when unavailable", - "format": "int32", + "mutedUntil": { + "type": "string", + "description": "Mute expiry; null means indefinite while muted", + "format": "date-time", "nullable": true }, - "lastError": { + "muteReason": { "type": "string", - "description": "failure_reason from the triggering check result; null when unavailable", + "description": "Optional mute reason", "nullable": true }, - "firstFailedCheckAt": { + "pausedAt": { "type": "string", - "description": "Earliest failing check timestamp in the confirm window when computable; null otherwise", + "description": "When the monitor was paused", "format": "date-time", "nullable": true }, - "source": { - "minLength": 1, - "type": "string", - "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" - }, - "incidentId": { + "pauseReason": { "type": "string", - "format": "uuid" + "description": "Optional pause reason", + "nullable": true }, - "oldStatus": { + "pauseExpiresAt": { "type": "string", - "nullable": true, - "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" - ] + "description": "Pause expiry", + "format": "date-time", + "nullable": true }, - "newStatus": { + "quarantineOwnerId": { "type": "string", - "nullable": true, - "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" - ] + "description": "Quarantine person owner id", + "nullable": true }, - "body": { + "quarantineUntil": { "type": "string", + "description": "Quarantine expiry; non-null means quarantined", + "format": "date-time", "nullable": true }, - "createdBy": { + "quarantineReason": { "type": "string", + "description": "Quarantine reason", + "nullable": true + }, + "upload": { "nullable": true, - "enum": [ - "SYSTEM", - "USER" + "allOf": [ + { + "$ref": "#/components/schemas/PackageUploadDto" + } ] + } + }, + "description": "Full monitor representation" + }, + "MonitorOverlayRequest": { + "type": "object", + "properties": { + "reason": { + "maxLength": 280, + "minLength": 0, + "type": "string", + "description": "Optional human-readable reason (max 280)", + "nullable": true }, - "notifySubscribers": { - "type": "boolean" - }, - "createdAt": { + "expiresAt": { "type": "string", - "format": "date-time" + "description": "When this overlay expires", + "format": "date-time", + "nullable": true } } }, - "IntegrationConfigSchemaDto": { + "MonitorPackageSpec": { "required": [ - "channelFields", - "connectionFields" + "digest", + "entrypoint", + "files" ], "type": "object", "properties": { - "connectionFields": { + "digest": { + "maxLength": 64, + "minLength": 64, + "type": "string", + "description": "SHA-256 hex digest of the package zip (64 characters)" + }, + "entrypoint": { + "maxLength": 512, + "minLength": 0, + "type": "string", + "description": "Entrypoint path inside the zip, e.g. tests/login.spec.ts" + }, + "files": { + "maxItems": 256, + "minItems": 0, "type": "array", + "description": "Relative file paths included in the zip", "items": { - "$ref": "#/components/schemas/IntegrationFieldDto" + "maxLength": 512, + "minLength": 0, + "type": "string", + "description": "Relative file paths included in the zip" } }, - "channelFields": { + "keys": { + "maxItems": 64, + "minItems": 0, "type": "array", + "description": "Secret names the zip demanded. PUT: null preserves, [] clears", + "nullable": true, "items": { - "$ref": "#/components/schemas/IntegrationFieldDto" + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Secret names the zip demanded. PUT: null preserves, [] clears" } + }, + "gitSha": { + "maxLength": 64, + "minLength": 0, + "type": "string", + "description": "Commit SHA from the repo that produced this zip. Client-supplied provenance only", + "nullable": true + }, + "gitMessage": { + "maxLength": 1024, + "minLength": 0, + "type": "string", + "description": "Commit message from the repo that produced this zip", + "nullable": true + }, + "gitFile": { + "maxLength": 512, + "minLength": 0, + "type": "string", + "description": "Path of the declaring file in that repo", + "nullable": true + }, + "authoredBy": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "Author attribution supplied with the package", + "nullable": true } - } + }, + "description": "New package zip metadata for this environment" }, - "IntegrationDto": { + "MonitorReference": { "required": [ - "authType", - "configSchema", - "description", - "lifecycle", - "logoUrl", - "name", - "setupGuideUrl", - "tierAvailability", - "type" + "id", + "name" ], "type": "object", "properties": { - "type": { - "type": "string" + "id": { + "type": "string", + "description": "Monitor identifier", + "format": "uuid" }, "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "authType": { - "type": "string" - }, - "tierAvailability": { "type": "string", - "enum": [ - "FREE", - "STARTER", - "PRO", - "TEAM", - "BUSINESS", - "ENTERPRISE" - ] - }, - "lifecycle": { - "type": "string" - }, - "setupGuideUrl": { - "type": "string" - }, - "configSchema": { - "$ref": "#/components/schemas/IntegrationConfigSchemaDto" + "description": "Monitor name" } - } + }, + "description": "Monitors that reference this secret for authentication" }, - "IntegrationFieldDto": { - "required": [ - "key", - "label", - "required", - "sensitive", - "type" - ], + "MonitorRunListParams": { "type": "object", "properties": { - "key": { - "type": "string" - }, - "label": { - "type": "string" + "phase": { + "type": "string", + "description": "Filter by run phase; omit to return every phase", + "nullable": true }, - "type": { - "type": "string" + "outcome": { + "type": "string", + "description": "Filter by persist outcome; omit to return every outcome", + "nullable": true }, - "required": { - "type": "boolean" + "region": { + "type": "string", + "description": "Filter by probe region", + "nullable": true }, - "sensitive": { - "type": "boolean" + "source": { + "type": "string", + "description": "Filter by what triggered the run", + "nullable": true }, - "placeholder": { + "q": { "type": "string", + "description": "Substring match on headline", "nullable": true }, - "helpText": { + "cursor": { "type": "string", + "description": "Opaque cursor from a previous page", "nullable": true }, - "options": { + "limit": { + "maximum": 100, + "minimum": 1, + "type": "integer", + "description": "Page size (1–100, default 25)", + "format": "int32" + } + }, + "required": [ + "limit" + ] + }, + "MonitorSecretRequestsDto": { + "required": [ + "environment", + "requests" + ], + "type": "object", + "properties": { + "environment": { + "$ref": "#/components/schemas/EnvironmentDto" + }, + "requests": { "type": "array", - "nullable": true, + "description": "Secret keys this monitor requires and their resolve state", "items": { - "type": "string" + "$ref": "#/components/schemas/SecretRequestDto" } - }, - "default": { - "type": "string", - "nullable": true } - } + }, + "description": "Environment and secret keys this monitor requires" }, - "InviteDto": { + "MonitorSessionDto": { "required": [ - "createdAt", - "email", - "expiresAt", - "roleOffered", - "inviteId" + "cookieNames", + "lifecycle", + "reusePolicy", + "setupFile", + "storageKeys" ], "type": "object", "properties": { - "inviteId": { - "type": "integer", - "description": "Unique invite identifier", - "format": "int32" - }, - "email": { + "lifecycle": { "type": "string", - "description": "Email address the invite was sent to" + "description": "Current session cache state", + "enum": [ + "active", + "expired", + "failed", + "revoked" + ] }, - "roleOffered": { + "reusePolicy": { "type": "string", - "description": "Role that will be assigned to the invitee on acceptance", + "description": "When the cached session is reused across runs", "enum": [ - "OWNER", - "ADMIN", - "MEMBER" + "reuse", + "every_run", + "on_failure" ] }, - "createdAt": { + "setupFile": { "type": "string", - "description": "Timestamp when the invite was created", - "format": "date-time" + "description": "Setup file path inside the package zip" }, "expiresAt": { "type": "string", - "description": "Timestamp when the invite expires", - "format": "date-time" - }, - "consumedAt": { - "type": "string", - "description": "Timestamp when the invite was accepted; null if not yet used", + "description": "When the cached session expires", "format": "date-time", "nullable": true }, - "revokedAt": { + "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": "Timestamp when the invite was revoked; null if active", - "format": "date-time", + "description": "Run that last rejected this cache", + "format": "uuid", "nullable": true } }, - "description": "Organization invite sent to an email address" + "description": "Cached sign-in session for a monitor" }, - "JiraChannelConfig": { - "required": [ - "channelType", - "domain", - "email", - "apiToken", - "projectKey" - ], + "MonitorsSummaryDto": { "type": "object", "properties": { - "channelType": { - "type": "string", - "enum": [ - "jira" - ] + "total": { + "type": "integer", + "description": "Total number of monitors in the organization", + "format": "int64" }, - "domain": { - "minLength": 1, - "type": "string", - "description": "Atlassian instance domain (e.g. yourteam.atlassian.net)" + "up": { + "type": "integer", + "description": "Number of monitors currently passing", + "format": "int64" }, - "email": { - "minLength": 1, - "type": "string", - "description": "Atlassian account email for API authentication" + "down": { + "type": "integer", + "description": "Number of monitors currently failing (DOWN severity)", + "format": "int64" }, - "apiToken": { - "minLength": 1, - "type": "string", - "description": "Atlassian API token" + "degraded": { + "type": "integer", + "description": "Number of monitors with degraded status", + "format": "int64" }, - "projectKey": { - "minLength": 1, - "type": "string", - "description": "Jira project key where issues are created (e.g. OPS)" + "paused": { + "type": "integer", + "description": "Number of disabled monitors", + "format": "int64" }, - "issueType": { - "type": "string", - "description": "Issue type name (e.g. Bug, Task, Incident)", + "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": [ + "total", + "up", + "down", + "degraded", + "paused" + ] }, - "JsonPathAssertion": { + "MonitorTestRequest": { "required": [ - "type", - "path", - "expected", - "operator" + "config", + "type" ], "type": "object", "properties": { "type": { "type": "string", + "description": "Monitor protocol type to test", "enum": [ - "json_path" + "HTTP", + "DNS", + "MCP_SERVER", + "TCP", + "ICMP", + "HEARTBEAT", + "BROWSER", + "MULTI_STEP_API" ] }, - "path": { - "minLength": 1, - "type": "string", - "description": "JSONPath expression to extract a value from the response body" - }, - "expected": { - "minLength": 1, - "type": "string", - "description": "Expected value to compare against" - }, - "operator": { - "type": "string", - "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", - "enum": [ - "equals", - "contains", - "less_than", - "greater_than", - "matches", - "range" + "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" + } } } }, - "KeyInfo": { + "MonitorTestResultDto": { "required": [ - "createdAt", - "name", - "id" + "assertionResults", + "passed" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Key ID", - "format": "int32" + "passed": { + "type": "boolean" }, - "name": { + "error": { "type": "string", - "description": "Human-readable key name" + "nullable": true }, - "createdAt": { - "type": "string", - "description": "When the key was created", - "format": "date-time" + "statusCode": { + "type": "integer", + "format": "int32", + "nullable": true }, - "expiresAt": { - "type": "string", - "description": "When the key expires (null = never)", - "format": "date-time", + "responseTimeMs": { + "type": "integer", + "format": "int64", "nullable": true }, - "lastUsedAt": { - "type": "string", - "description": "Last time the key was used", - "format": "date-time", + "responseHeaders": { + "type": "object", + "additionalProperties": { + "type": "array", + "nullable": true, + "items": { + "type": "string", + "nullable": true + } + }, "nullable": true - } - }, - "description": "API key metadata" - }, - "LinearChannelConfig": { - "required": [ - "channelType", - "apiKey", - "teamId" - ], - "type": "object", - "properties": { - "channelType": { - "type": "string", - "enum": [ - "linear" - ] }, - "apiKey": { - "minLength": 1, + "bodyPreview": { "type": "string", - "description": "Linear API key" + "nullable": true }, - "teamId": { - "minLength": 1, - "type": "string", - "description": "Team ID to create issues in" + "responseSizeBytes": { + "type": "integer", + "format": "int64", + "nullable": true }, - "labelId": { + "redirectCount": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "finalUrl": { "type": "string", - "description": "Label ID to attach to created issues", "nullable": true + }, + "assertionResults": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssertionTestResultDto" + } + }, + "warnings": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } } } }, - "LinkedStatusPageIncidentDto": { + "MonitorVersionDto": { "required": [ - "connectionMode", + "changedVia", + "createdAt", "id", - "impact", - "pageIncidentMode", - "spIncidentId", - "status", - "statusPageId", - "statusPageName", - "statusPageSlug", - "title", - "scheduled" + "monitorId", + "snapshot", + "version" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "Status page incident ID (same value as spIncidentId; kept for backwards compatibility)", - "format": "uuid" - }, - "spIncidentId": { - "type": "string", - "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": { + "id": { "type": "string", - "description": "Customer-facing incident title" + "description": "Unique version record identifier", + "format": "uuid" }, - "status": { + "monitorId": { "type": "string", - "description": "Current lifecycle status (INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED)", - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" - ] + "description": "Monitor this version belongs to", + "format": "uuid" }, - "impact": { - "type": "string", - "description": "Impact level (NONE, MINOR, MAJOR, CRITICAL)", - "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" - ] + "version": { + "type": "integer", + "description": "Monotonically increasing version number", + "format": "int32" }, - "scheduled": { - "type": "boolean", - "description": "Scheduled maintenance flag" + "snapshot": { + "$ref": "#/components/schemas/MonitorDto" }, - "publishedAt": { - "type": "string", - "description": "Publish time; null while draft", - "format": "date-time", + "changedById": { + "type": "integer", + "description": "User ID who made the change; null for automated changes", + "format": "int32", "nullable": true }, - "connectionMode": { + "changedVia": { "type": "string", - "description": "Whether the linked SPI was created by automation (AUTO) or by a human/API caller (MANUAL)", + "description": "Change source (DASHBOARD, CLI, API)", "enum": [ - "AUTO", - "MANUAL" + "API", + "DASHBOARD", + "CLI", + "TERRAFORM" ] }, - "pageIncidentMode": { + "changeSummary": { "type": "string", - "description": "Incident mode of the parent status page at read time (MANUAL, REVIEW, AUTOMATIC)", - "enum": [ - "MANUAL", - "REVIEW", - "AUTOMATIC" - ] + "description": "Human-readable description of what changed", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "Timestamp when this version was recorded", + "format": "date-time" } - } + }, + "description": "A point-in-time version snapshot of a monitor configuration" }, - "MaintenanceComponentRef": { + "NewTagRequest": { "required": [ - "id", - "name", - "status" + "name" ], "type": "object", "properties": { - "id": { + "name": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "Component identifier", - "format": "uuid" + "description": "Tag name" }, - "name": { + "color": { + "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "type": "string", - "description": "Component name" + "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 }, - "status": { + "historicalClaim": { "type": "string", - "description": "Component status at the time of the maintenance update" + "description": "Non-binding historical uptime claim", + "nullable": true + }, + "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": "A component affected by a scheduled maintenance window" + "description": "Context for vendors with no public SLA" }, - "MaintenanceEventDto": { + "NotificationDispatchDto": { "required": [ - "externalId", - "maintenanceId", + "createdAt", + "deliveries", + "id", + "incidentId", + "policyId", "status", - "title" + "updatedAt", + "currentStep" ], "type": "object", "properties": { - "maintenanceId": { + "id": { "type": "string", - "description": "Vendor catalog maintenance ID", + "description": "Unique dispatch record identifier", "format": "uuid" }, - "externalId": { + "incidentId": { "type": "string", - "description": "Vendor-supplied external maintenance ID" + "description": "Incident this dispatch is for", + "format": "uuid" }, - "title": { + "incidentTitle": { "type": "string", - "description": "Maintenance title from the vendor status page" + "description": "Incident title at read time; null if untitled or missing", + "nullable": true }, - "status": { + "policyId": { "type": "string", - "description": "Lifecycle status: scheduled, in_progress, verifying, completed" + "description": "Notification policy that matched this incident", + "format": "uuid" }, - "impact": { + "policyName": { "type": "string", - "description": "Vendor impact level", + "description": "Human-readable name of the matched policy (null if policy has been deleted)", "nullable": true }, - "shortlink": { + "status": { "type": "string", - "description": "Short public URL for the vendor maintenance", - "nullable": true + "description": "Current dispatch state", + "enum": [ + "PENDING", + "DISPATCHING", + "DELIVERED", + "ESCALATING", + "ACKNOWLEDGED", + "COMPLETED" + ] }, - "scheduledFor": { + "completionReason": { "type": "string", - "description": "Scheduled start; null for undated maintenance", - "format": "date-time", + "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 }, - "scheduledUntil": { + "acknowledgedAt": { "type": "string", - "description": "Scheduled end", + "description": "Timestamp when this dispatch was acknowledged (null if not acknowledged)", "format": "date-time", "nullable": true }, - "startedAt": { + "acknowledgedBy": { "type": "string", - "description": "When maintenance actually started", - "format": "date-time", + "description": "Actor who acknowledged this dispatch (user email, api-key:, voice:, etc.); null if not acknowledged", "nullable": true }, - "completedAt": { + "acknowledgedVia": { "type": "string", - "description": "When maintenance completed", - "format": "date-time", + "description": "Channel used to acknowledge (DASHBOARD, API, PHONE_CALL, INTERNAL, etc.); null if not acknowledged", "nullable": true }, - "affectedComponentIds": { + "matchedRules": { "type": "array", - "description": "Affected component IDs", + "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": "Affected component IDs", - "format": "uuid" + "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": "Vendor maintenance fields for a status-events rail row" - }, - "MaintenanceUpdateDto": { - "required": [ - "id", - "status" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique update identifier", - "format": "uuid" - }, - "status": { - "type": "string", - "description": "Status at the time of this update" }, - "body": { + "nextEscalationAt": { "type": "string", - "description": "Update message from the vendor", + "description": "Timestamp when the next escalation step will fire (null if not scheduled)", + "format": "date-time", "nullable": true }, - "displayAt": { + "lastNotifiedAt": { "type": "string", - "description": "Timestamp when this update was posted", + "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": "A status update within a scheduled maintenance lifecycle" + "description": "Dispatch state for a single (incident, notification policy) pair, with delivery history" }, - "MaintenanceWindowDto": { + "NotificationDto": { "required": [ "createdAt", - "endsAt", + "title", + "type", "id", - "startsAt", - "organizationId", - "suppressAlerts" + "read" ], "type": "object", "properties": { "id": { - "type": "string", - "description": "Unique maintenance window identifier", - "format": "uuid" + "type": "integer", + "description": "Unique notification identifier", + "format": "int64" }, - "monitorId": { + "type": { "type": "string", - "description": "Monitor this window applies to; null for org-wide windows", - "format": "uuid", - "nullable": true - }, - "organizationId": { - "type": "integer", - "description": "Organization this maintenance window belongs to", - "format": "int32" + "description": "Notification category (e.g. incident, monitor, team)" }, - "startsAt": { + "title": { "type": "string", - "description": "Scheduled start of the maintenance window", - "format": "date-time" + "description": "Short notification title" }, - "endsAt": { + "body": { "type": "string", - "description": "Scheduled end of the maintenance window", - "format": "date-time" + "description": "Full notification body; null for title-only notifications", + "nullable": true }, - "repeatRule": { + "resourceType": { "type": "string", - "description": "Reserved: iCal RRULE for recurring windows (stored but not yet honored)", + "description": "Type of the resource this notification is about", "nullable": true }, - "reason": { + "resourceId": { "type": "string", - "description": "Human-readable reason for the maintenance", + "description": "ID of the resource this notification is about", "nullable": true }, - "suppressAlerts": { + "read": { "type": "boolean", - "description": "Whether alerts are suppressed during this window" + "description": "Whether the notification has been read" }, "createdAt": { "type": "string", - "description": "Timestamp when the window was created", + "description": "Timestamp when the notification was created", "format": "date-time" } }, - "description": "Scheduled maintenance window for a monitor" + "description": "In-app notification for the current user" }, - "MatchRule": { + "NotificationPolicyDto": { "required": [ - "type" + "createdAt", + "escalation", + "id", + "matchRules", + "name", + "updatedAt", + "organizationId", + "enabled", + "priority" ], "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": "Unique notification policy identifier", + "format": "uuid" }, - "value": { + "organizationId": { + "type": "integer", + "description": "Organization this policy belongs to", + "format": "int32" + }, + "name": { + "minLength": 1, "type": "string", - "description": "Comparison value for single-value rules like severity_gte", + "description": "Human-readable name for this policy" + }, + "description": { + "type": "string", + "description": "Optional note; null when unset", "nullable": true }, - "monitorIds": { + "matchRules": { "type": "array", - "description": "Monitor UUIDs to match for monitor_id_in rules", - "nullable": true, + "description": "Match rules (all must pass; empty = catch-all)", "items": { - "type": "string", - "description": "Monitor UUIDs to match for monitor_id_in rules", - "format": "uuid" + "$ref": "#/components/schemas/MatchRule" } }, - "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" - } + "escalation": { + "$ref": "#/components/schemas/EscalationChain" }, - "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": "Match rules to evaluate (all must pass; omit or empty for catch-all)" - }, - "MattermostChannelConfig": { - "required": [ - "channelType", - "webhookUrl" - ], - "type": "object", - "properties": { - "channelType": { - "type": "string", - "enum": [ - "mattermost" - ] + "enabled": { + "type": "boolean", + "description": "Whether this policy is active" }, - "webhookUrl": { - "minLength": 1, - "type": "string", - "description": "Mattermost incoming webhook URL" + "priority": { + "type": "integer", + "description": "Evaluation order; higher value = evaluated first", + "format": "int32" }, - "channel": { + "createdAt": { "type": "string", - "description": "Override channel (if webhook allows)", - "nullable": true + "description": "Timestamp when the policy was created", + "format": "date-time" }, - "iconUrl": { - "type": "string", - "description": "Custom bot icon URL", - "nullable": true - } - } - }, - "McpConnectsAssertion": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "mcp_connects" - ] - } - }, - "required": [ - "type" - ] - }, - "McpHasCapabilityAssertion": { - "required": [ - "type", - "capability" - ], - "type": "object", - "properties": { - "type": { + "updatedAt": { "type": "string", - "enum": [ - "mcp_has_capability" - ] + "description": "Timestamp when the policy was last updated", + "format": "date-time" }, - "capability": { - "minLength": 1, - "type": "string", - "description": "Capability name the server must advertise, e.g. tools or resources" - } - } - }, - "McpMinToolsAssertion": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "mcp_min_tools" + "stats7d": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/NotificationPolicyWindowStatsDto" + } ] }, - "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": { - "type": "string", - "enum": [ - "mcp_protocol_version" + "stats30d": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/NotificationPolicyWindowStatsDto" + } ] }, - "version": { - "minLength": 1, - "type": "string", - "description": "Expected MCP protocol version string from the server handshake" - } - } - }, - "McpResponseTimeAssertion": { - "type": "object", - "properties": { - "type": { + "lastFiredAt": { "type": "string", - "enum": [ - "mcp_response_time" - ] - }, - "maxMs": { - "type": "integer", - "description": "Maximum allowed MCP check duration in milliseconds", - "format": "int32" + "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 } }, - "required": [ - "type", - "maxMs" - ] + "description": "Org-level notification policy with match rules and escalation chain" }, - "McpResponseTimeWarnAssertion": { + "NotificationPolicyWindowStatsDto": { + "required": [ + "ackableFires", + "acknowledgements", + "expired", + "failedSends", + "fires", + "sends" + ], "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "mcp_response_time_warn" - ] + "fires": { + "type": "integer", + "description": "Dispatches created in the window", + "format": "int32" }, - "warnMs": { + "acknowledgements": { "type": "integer", - "description": "MCP check duration in milliseconds that triggers a warning only", + "description": "Fires in the window that were acknowledged", "format": "int32" - } - }, - "required": [ - "type", - "warnMs" - ] - }, - "McpServer": { - "type": "object", - "description": "MCP server check-type-specific details", - "properties": { - "check_type": { - "type": "string", - "enum": [ - "mcp_server" - ] }, - "url": { - "type": "string", - "description": "MCP server URL", - "nullable": true + "ackableFires": { + "type": "integer", + "description": "Ack ratio denominator: fires when the policy has an ack gate, else 0", + "format": "int32" }, - "protocolVersion": { - "type": "string", - "description": "MCP protocol version", - "nullable": true + "expired": { + "type": "integer", + "description": "Fires that exhausted escalation without acknowledgment", + "format": "int32" }, - "serverInfo": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "MCP server info (name, version, etc.)", - "nullable": true - }, - "description": "MCP server info (name, version, etc.)", - "nullable": true + "sends": { + "type": "integer", + "description": "Alert deliveries linked to fires in the window", + "format": "int32" }, - "toolCount": { + "failedSends": { "type": "integer", - "description": "Number of tools exposed", - "format": "int32", - "nullable": true + "description": "Linked deliveries with status FAILED", + "format": "int32" }, - "resourceCount": { + "medianAckSeconds": { "type": "integer", - "description": "Number of resources exposed", - "format": "int32", + "description": "Median seconds from fire to ack among acknowledged fires; null when none", + "format": "int64", "nullable": true }, - "promptCount": { + "deepestStepReached": { "type": "integer", - "description": "Number of prompts exposed", + "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 } }, - "required": [ - "check_type" - ] + "description": "Time-bounded notification policy activity aggregates" }, - "McpServerMonitorConfig": { - "required": [ - "command" - ], + "OfficialSla": { "type": "object", "properties": { - "command": { - "minLength": 1, + "percentage": { "type": "string", - "description": "Command to execute to start the MCP server" + "description": "Advertised uptime percentage, e.g. '99.99%'", + "nullable": true }, - "args": { + "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": "Command-line arguments for the MCP server process", + "description": "Plan names this SLA applies to, e.g. ['Enterprise']", "nullable": true, "items": { "type": "string", - "description": "Command-line arguments for the MCP server process", - "nullable": true + "description": "Plan names this SLA applies to, e.g. ['Enterprise']" } }, - "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", + "notCovered": { + "type": "string", + "description": "Services/components NOT covered by the SLA", "nullable": true } - } + }, + "description": "The vendor's officially advertised SLA commitment" }, - "McpToolAvailableAssertion": { + "OpsGenieChannelConfig": { "required": [ - "type", - "toolName" + "channelType", + "apiKey" ], "type": "object", "properties": { - "type": { + "channelType": { "type": "string", "enum": [ - "mcp_tool_available" + "opsgenie" ] }, - "toolName": { + "apiKey": { "minLength": 1, "type": "string", - "description": "MCP tool name that must appear in the server's tool list" - } - } - }, - "McpToolCountChangedAssertion": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "mcp_tool_count_changed" - ] + "description": "OpsGenie API key for alert creation" }, - "expectedCount": { - "type": "integer", - "description": "Expected tool count; warns when the live count differs", - "format": "int32" + "region": { + "type": "string", + "description": "OpsGenie API region: us or eu", + "nullable": true } - }, - "required": [ - "type", - "expectedCount" - ] + } }, - "MemberDto": { + "OrganizationDto": { "required": [ - "createdAt", "email", - "orgRole", - "status", - "userId" + "name", + "id" ], "type": "object", "properties": { - "userId": { + "id": { "type": "integer", - "description": "User identifier of the member", + "description": "Unique organization identifier", "format": "int32" }, - "email": { + "name": { "type": "string", - "description": "Member email address" + "description": "Organization name" }, - "name": { + "email": { "type": "string", - "description": "Member display name; null if not set", + "description": "Billing and contact email", "nullable": true }, - "orgRole": { + "size": { "type": "string", - "description": "Member role within this organization (OWNER, ADMIN, MEMBER)", - "enum": [ - "OWNER", - "ADMIN", - "MEMBER" - ] + "description": "Team size range (e.g. 1-10, 11-50)", + "nullable": true }, - "status": { + "industry": { "type": "string", - "description": "Membership status (ACTIVE, PENDING, SUSPENDED)", - "enum": [ - "INVITED", - "ACTIVE", - "SUSPENDED", - "LEFT", - "REMOVED", - "DECLINED" - ] + "description": "Industry vertical (e.g. SaaS, Fintech)", + "nullable": true }, - "createdAt": { + "websiteUrl": { "type": "string", - "description": "Timestamp when the member was added to the organization", - "format": "date-time" + "description": "Organization website URL", + "nullable": true } }, - "description": "Organization member with role and status" + "description": "Organization account details" }, - "MemberRoleChangedMetadata": { + "OrgIncidentAnnotationDto": { "required": [ - "kind", - "oldRole", - "newRole" + "incidentId", + "severity", + "status", + "alerted" ], "type": "object", - "description": "Role transition recorded when an organization member's role changes.", "properties": { - "kind": { + "incidentId": { "type": "string", - "enum": [ - "member_role_changed" - ] + "description": "Internal org incident ID", + "format": "uuid" }, - "oldRole": { + "displayKey": { "type": "string", - "description": "Role the member held before the change", + "description": "Human display key (e.g. DEV-42); null until platform INC codes ship", + "nullable": true + }, + "status": { + "type": "string", + "description": "Internal incident lifecycle status", "enum": [ - "OWNER", - "ADMIN", - "MEMBER" + "WATCHING", + "TRIGGERED", + "CONFIRMED", + "RESOLVED" ] }, - "newRole": { + "severity": { "type": "string", - "description": "Role the member holds after the change", + "description": "Internal incident severity", "enum": [ - "OWNER", - "ADMIN", - "MEMBER" + "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": "Linked internal incident annotation on a vendor status-event row" }, - "MonitorAssertionDto": { + "OrgInfo": { "required": [ - "assertionType", - "config", - "id", - "monitorId", - "severity" + "name", + "id" ], "type": "object", "properties": { "id": { - "type": "string", - "format": "uuid" - }, - "monitorId": { - "type": "string", - "format": "uuid" + "type": "integer", + "description": "Organization ID", + "format": "int32" }, - "assertionType": { + "name": { "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" - ] - }, - "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" - } - ] + "description": "Organization name" + } + }, + "description": "Organization the key belongs to" + }, + "PackageUploadDto": { + "required": [ + "expiresAt", + "putUrl", + "requiredHeaders" + ], + "type": "object", + "properties": { + "putUrl": { + "minLength": 1, + "type": "string", + "description": "Presigned PUT URL for the zip bytes" }, - "severity": { + "expiresAt": { "type": "string", - "enum": [ - "fail", - "warn" - ] - } - } - }, - "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" + "description": "When the signed URL expires", + "format": "date-time" + }, + "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: *" } }, - "oneOf": [ - { - "$ref": "#/components/schemas/BearerAuthConfig" - }, - { - "$ref": "#/components/schemas/BasicAuthConfig" + "description": "Signed package upload target" + }, + "Pageable": { + "type": "object", + "properties": { + "page": { + "minimum": 0, + "type": "integer", + "format": "int32" }, - { - "$ref": "#/components/schemas/HeaderAuthConfig" + "size": { + "minimum": 1, + "type": "integer", + "format": "int32" }, - { - "$ref": "#/components/schemas/ApiKeyAuthConfig" + "sort": { + "type": "array", + "items": { + "type": "string" + } } + }, + "required": [ + "page", + "size", + "sort" ] }, - "MonitorAuthDto": { + "PagerDutyChannelConfig": { "required": [ - "authType", - "config", - "id", - "monitorId" + "channelType", + "routingKey" ], "type": "object", "properties": { - "id": { + "channelType": { "type": "string", - "format": "uuid" + "enum": [ + "pagerduty" + ] }, - "monitorId": { + "routingKey": { + "minLength": 1, "type": "string", - "format": "uuid" + "description": "PagerDuty Events API v2 routing (integration) key" }, - "authType": { + "severityOverride": { "type": "string", - "enum": [ - "bearer", - "basic", - "header", - "api_key" - ] - }, - "config": { - "oneOf": [ - { - "$ref": "#/components/schemas/ApiKeyAuthConfig" - }, - { - "$ref": "#/components/schemas/BasicAuthConfig" - }, - { - "$ref": "#/components/schemas/BearerAuthConfig" - }, - { - "$ref": "#/components/schemas/HeaderAuthConfig" - } - ] + "description": "Override PagerDuty severity mapping", + "nullable": true } } }, - "MonitorDto": { - "required": [ - "config", - "createdAt", - "id", - "managedBy", - "name", - "regions", - "type", - "updatedAt", - "organizationId", - "frequencySeconds", - "enabled" - ], + "PageSection": { "type": "object", "properties": { - "id": { + "groupId": { "type": "string", - "description": "Unique monitor identifier", - "format": "uuid" - }, - "organizationId": { - "type": "integer", - "description": "Organization this monitor belongs to", - "format": "int32" + "description": "Group ID when this section is a group", + "format": "uuid", + "nullable": true }, - "name": { - "minLength": 1, + "componentId": { "type": "string", - "description": "Human-readable name for this monitor" + "description": "Component ID when this section is an ungrouped component", + "format": "uuid", + "nullable": true }, - "type": { + "pageOrder": { + "type": "integer", + "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": [ - "HTTP", - "DNS", - "MCP_SERVER", - "TCP", - "ICMP", - "HEARTBEAT", - "BROWSER", - "MULTI_STEP_API" + "phone_call" ] }, - "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" - } - ] + "phoneNumber": { + "type": "string", + "description": "Recipient phone number in E.164 format, e.g. +14155550123", + "nullable": true }, - "frequencySeconds": { + "verifiedPhoneNumberId": { "type": "integer", - "description": "Check frequency in seconds (30–86400)", - "format": "int32" - }, - "enabled": { - "type": "boolean", - "description": "Whether the monitor is active" + "description": "Id of an org verified_phone_number row; alternative to phoneNumber", + "format": "int64", + "nullable": true }, - "regions": { + "phoneNumbers": { "type": "array", - "description": "Probe regions where checks are executed", + "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", - "description": "Probe regions where checks are executed" + "description": "Deprecated: use phoneNumber. Accepted as a length-1 list for one release; ignored when phoneNumber or id is set", + "nullable": true } }, - "managedBy": { + "voiceLanguage": { "type": "string", - "description": "Source that created/owns this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API", + "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" + ] + }, + "PlanInfo": { + "required": [ + "entitlements", + "tier", + "usage", + "trialActive" + ], + "type": "object", + "properties": { + "tier": { + "type": "string", + "description": "Resolved plan tier", "enum": [ - "DASHBOARD", - "CLI", - "TERRAFORM", - "MCP", - "API" + "FREE", + "STARTER", + "PRO", + "TEAM", + "BUSINESS", + "ENTERPRISE" ] }, - "createdAt": { + "subscriptionStatus": { "type": "string", - "description": "Timestamp when the monitor was created", + "description": "Subscription status (null if no subscription)", + "nullable": true + }, + "trialActive": { + "type": "boolean", + "description": "Whether the org is on a trial" + }, + "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" + }, + "policy": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Canonical policy document (snake_case, sorted keys)" + }, + "description": "Canonical policy document (snake_case, sorted keys)" + }, + "engineVersion": { + "minLength": 1, + "type": "string", + "description": "Detection engine version that observed this policy" + }, + "firstSeenAt": { + "type": "string", + "description": "First time the detection engine evaluated against this policy bytes", "format": "date-time" }, - "updatedAt": { + "lastSeenAt": { "type": "string", - "description": "Timestamp when the monitor was last updated", + "description": "Most recent time the engine evaluated against this policy bytes", + "format": "date-time" + } + }, + "description": "Policy snapshot used during this check (all evaluations of a single check are against one policy)", + "nullable": true + }, + "PollChartBucketDto": { + "required": [ + "bucket", + "totalPolls" + ], + "type": "object", + "properties": { + "bucket": { + "type": "string", + "description": "Start of the time bucket (ISO 8601)", "format": "date-time" }, - "assertions": { - "type": "array", - "description": "Assertions evaluated against each check result; null on list responses", + "uptimePercent": { + "type": "number", + "description": "Uptime percentage for this bucket; null when no data", + "format": "double", "nullable": true, - "items": { - "$ref": "#/components/schemas/MonitorAssertionDto" - } + "example": 100 }, - "tags": { - "type": "array", - "description": "Tags applied to this monitor", + "avgResponseTimeMs": { + "type": "number", + "description": "Average response time in milliseconds for this bucket", + "format": "double", "nullable": true, - "items": { - "$ref": "#/components/schemas/TagDto" - } + "example": 245.3 }, - "pingUrl": { + "totalPolls": { + "type": "integer", + "description": "Total polls in this bucket", + "format": "int64", + "example": 60 + } + }, + "description": "Aggregated poll metrics for a time bucket" + }, + "PricingTier": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { "type": "string", - "description": "Heartbeat ping URL; populated for HEARTBEAT monitors only", + "description": "Tier name, e.g. 'Free', 'Pro', 'Enterprise'" + }, + "slaPercentage": { + "type": "string", + "description": "SLA percentage for this tier, e.g. '99.9%'", "nullable": true }, - "environment": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/Summary" - } - ] + "priceFrom": { + "type": "string", + "description": "Starting price, e.g. '$0', '$25/mo', 'Custom'", + "nullable": true + } + }, + "description": "Pricing tiers with associated SLA levels" + }, + "PublishRevisionRequest": { + "required": [ + "revisionId" + ], + "type": "object", + "properties": { + "revisionId": { + "type": "string", + "description": "Existing revision to activate as Head for this monitor's environment", + "format": "uuid" + } + } + }, + "PublishStatusPageIncidentRequest": { + "type": "object", + "properties": { + "title": { + "maxLength": 500, + "minLength": 0, + "type": "string", + "description": "Customer-facing title; null keeps draft value", + "nullable": true }, - "auth": { + "impact": { + "type": "string", + "description": "Impact level; null keeps draft value", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/MonitorAuthConfig" - } + "enum": [ + "NONE", + "MINOR", + "MAJOR", + "CRITICAL" ] }, - "incidentPolicy": { + "status": { + "type": "string", + "description": "Incident status; null keeps draft value (must be an active status)", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/IncidentPolicyDto" - } + "enum": [ + "INVESTIGATING", + "IDENTIFIED", + "MONITORING", + "RESOLVED" ] }, - "alertChannelIds": { + "body": { + "type": "string", + "description": "Initial update body; null keeps draft value", + "nullable": true + }, + "affectedComponents": { "type": "array", - "description": "Alert channel IDs linked to this monitor; populated on single-monitor responses", + "description": "Affected components; null keeps draft value", "nullable": true, "items": { - "type": "string", - "description": "Alert channel IDs linked to this monitor; populated on single-monitor responses", - "format": "uuid" + "$ref": "#/components/schemas/AffectedComponent" } }, - "currentStatus": { + "notifySubscribers": { + "type": "boolean", + "description": "Whether to notify subscribers (default: true)", + "nullable": true + } + } + }, + "PushbulletChannelConfig": { + "required": [ + "channelType", + "accessToken" + ], + "type": "object", + "properties": { + "channelType": { + "type": "string", + "enum": [ + "pushbullet" + ] + }, + "accessToken": { + "minLength": 1, + "type": "string", + "description": "Pushbullet access token" + }, + "deviceIden": { + "type": "string", + "description": "Target device identifier (broadcasts to all if empty)", + "nullable": true + } + } + }, + "PushoverChannelConfig": { + "required": [ + "channelType", + "userKey", + "appToken" + ], + "type": "object", + "properties": { + "channelType": { + "type": "string", + "enum": [ + "pushover" + ] + }, + "userKey": { + "minLength": 1, + "type": "string", + "description": "Pushover user or group key" + }, + "appToken": { + "minLength": 1, + "type": "string", + "description": "Pushover application API token" + }, + "priority": { + "type": "string", + "description": "Notification priority override (-2 to 2)", + "nullable": true + }, + "sound": { "type": "string", - "description": "Current operational state — UP, DOWN, DEGRADED, PAUSED, or UNKNOWN if no probe data yet", - "nullable": true, - "enum": [ - "up", - "degraded", - "down", - "paused", - "unknown" - ] + "description": "Notification sound override", + "nullable": true } - }, - "description": "Full monitor representation" + } }, - "MonitorReference": { + "QuarantineMonitorRequest": { "required": [ - "id", - "name" + "expiresAt", + "reason" ], "type": "object", "properties": { - "id": { + "reason": { + "maxLength": 280, + "minLength": 0, "type": "string", - "description": "Monitor identifier", - "format": "uuid" + "description": "Reason for this hold (max 280)" }, - "name": { + "expiresAt": { "type": "string", - "description": "Monitor name" + "description": "When the hold expires", + "format": "date-time" + }, + "fromRunId": { + "type": "string", + "description": "Run that prompted this hold", + "format": "uuid", + "nullable": true } - }, - "description": "Monitors that reference this secret; null on create/update responses" + } }, - "MonitorsSummaryDto": { + "RateLimitInfo": { "type": "object", "properties": { - "total": { + "requestsPerMinute": { "type": "integer", - "description": "Total number of monitors in the organization", + "description": "Maximum requests allowed per window", "format": "int64" }, - "up": { + "remaining": { "type": "integer", - "description": "Number of monitors currently passing", + "description": "Requests remaining in the current window", "format": "int64" }, - "down": { + "windowMs": { "type": "integer", - "description": "Number of monitors currently failing (DOWN severity)", + "description": "Sliding window size in milliseconds", "format": "int64" - }, - "degraded": { + } + }, + "description": "Rate-limit quota for the current sliding window", + "required": [ + "requestsPerMinute", + "remaining", + "windowMs" + ] + }, + "RecoveryPolicy": { + "type": "object", + "properties": { + "consecutiveSuccesses": { "type": "integer", - "description": "Number of monitors with degraded status", - "format": "int64" + "description": "Consecutive passing checks required to auto-resolve the incident", + "format": "int32" }, - "paused": { + "minRegionsPassing": { "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 + "description": "Minimum regions that must be passing before recovery can complete", + "format": "int32" }, - "avgUptime30d": { - "type": "number", - "description": "Average uptime percentage across all monitors over last 30 days", - "format": "double", - "nullable": true + "cooldownMinutes": { + "type": "integer", + "description": "Minutes after resolve before a new incident may open on the same monitor", + "format": "int32" } }, - "description": "Dashboard summary counters for monitors", + "description": "Auto-recovery settings", "required": [ - "total", - "up", - "down", - "degraded", - "paused" + "consecutiveSuccesses", + "minRegionsPassing", + "cooldownMinutes" ] }, - "MonitorTestRequest": { + "RedirectCountAssertion": { "required": [ - "config", - "type" + "type", + "maxCount" ], "type": "object", "properties": { "type": { "type": "string", - "description": "Monitor protocol type to test", "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" - } + "redirect_count" ] }, - "assertions": { - "type": "array", - "description": "Optional assertions to evaluate against the test result", - "nullable": true, - "items": { - "$ref": "#/components/schemas/CreateAssertionRequest" - } + "maxCount": { + "type": "integer", + "description": "Maximum number of HTTP redirects allowed before the check fails", + "format": "int32" } } }, - "MonitorTestResultDto": { + "RedirectTargetAssertion": { "required": [ - "assertionResults", - "passed" + "type", + "expected", + "operator" ], "type": "object", "properties": { - "passed": { - "type": "boolean" - }, - "error": { + "type": { "type": "string", - "nullable": true - }, - "statusCode": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "responseTimeMs": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "responseHeaders": { - "type": "object", - "additionalProperties": { - "type": "array", - "nullable": true, - "items": { - "type": "string", - "nullable": true - } - }, - "nullable": true + "enum": [ + "redirect_target" + ] }, - "bodyPreview": { + "expected": { + "minLength": 1, "type": "string", - "nullable": true - }, - "responseSizeBytes": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "redirectCount": { - "type": "integer", - "format": "int32", - "nullable": true + "description": "Expected final URL after following redirects" }, - "finalUrl": { + "operator": { "type": "string", - "nullable": true - }, - "assertionResults": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AssertionTestResultDto" - } - }, - "warnings": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } + "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", + "enum": [ + "equals", + "contains", + "less_than", + "greater_than", + "matches", + "range" + ] } } }, - "MonitorVersionDto": { + "RegexBodyAssertion": { "required": [ - "changedVia", - "createdAt", - "id", - "monitorId", - "snapshot", - "version" + "type", + "pattern" ], "type": "object", "properties": { - "id": { + "type": { "type": "string", - "description": "Unique version record identifier", - "format": "uuid" + "enum": [ + "regex_body" + ] }, - "monitorId": { + "pattern": { + "minLength": 1, "type": "string", - "description": "Monitor this version belongs to", - "format": "uuid" - }, - "version": { - "type": "integer", - "description": "Monotonically increasing version number", - "format": "int32" + "description": "Regular expression the response body must match" + } + } + }, + "RegionStatusDto": { + "required": [ + "region", + "timestamp", + "passed" + ], + "type": "object", + "properties": { + "region": { + "type": "string", + "description": "Region identifier", + "example": "us-east" }, - "snapshot": { - "$ref": "#/components/schemas/MonitorDto" + "passed": { + "type": "boolean", + "description": "Whether the last check in this region passed", + "example": true }, - "changedById": { + "responseTimeMs": { "type": "integer", - "description": "User ID who made the change; null for automated changes", + "description": "Response time in milliseconds for the last check", "format": "int32", - "nullable": true + "nullable": true, + "example": 95 }, - "changedVia": { + "timestamp": { "type": "string", - "description": "Change source (DASHBOARD, CLI, API)", - "enum": [ - "API", - "DASHBOARD", - "CLI", - "TERRAFORM" - ] + "description": "Timestamp of the last check in this region (ISO 8601)", + "format": "date-time" }, - "changeSummary": { + "severityHint": { "type": "string", - "description": "Human-readable description of what changed", + "description": "Severity hint: 'down' for hard failures, 'degraded' for warn-only failures, null when passing", "nullable": true - }, - "createdAt": { - "type": "string", - "description": "Timestamp when this version was recorded", - "format": "date-time" } }, - "description": "A point-in-time version snapshot of a monitor configuration" + "description": "Latest check result for a single region" }, - "NewTagRequest": { + "RelatedIncidentsResponse": { "required": [ - "name" + "data", + "total" ], "type": "object", "properties": { - "name": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "Tag name" + "data": { + "type": "array", + "description": "Related incident rows (newest first, capped by limit)", + "items": { + "$ref": "#/components/schemas/IncidentDto" + } }, - "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 + "total": { + "type": "integer", + "description": "Total matching incidents in the window, excluding the current incident", + "format": "int64" } }, - "description": "Inline tag creation — creates the tag if it does not already exist" + "description": "Related incidents sharing the same origin within a time window" }, - "NoSlaContext": { + "RemapSecretRequest": { "type": "object", "properties": { - "reason": { - "type": "string", - "description": "Reason no SLA is published", - "nullable": true - }, - "historicalClaim": { - "type": "string", - "description": "Non-binding historical uptime claim", - "nullable": true - }, - "supportSla": { - "type": "string", - "description": "Support response time SLA if different from uptime SLA", - "nullable": true - }, - "enterpriseNote": { + "secretId": { "type": "string", - "description": "Note about enterprise/custom SLA availability", + "description": "Secret to attach; null restores name-match", + "format": "uuid", "nullable": true } }, - "description": "Context for vendors with no public SLA" + "description": "Attach or clear a remapped secret" }, - "NotificationDispatchDto": { + "RemoveMonitorTagsRequest": { "required": [ - "createdAt", - "deliveries", - "id", - "incidentId", - "policyId", - "status", - "updatedAt", - "currentStep" + "tagIds" ], "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": { - "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": [ - "PENDING", - "DISPATCHING", - "DELIVERED", - "ESCALATING", - "ACKNOWLEDGED", - "COMPLETED" - ] - }, - "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": { + "tagIds": { + "minItems": 1, "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, + "description": "IDs of the tags to detach from the monitor", "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)\"]" + "description": "IDs of the tags to detach from the monitor", + "format": "uuid" } - }, - "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": { + } + }, + "description": "Request body for removing tags from a monitor" + }, + "ReorderComponentsRequest": { + "required": [ + "positions" + ], + "type": "object", + "properties": { + "positions": { + "minItems": 1, "type": "array", - "description": "Delivery records for all channels associated with this dispatch", + "description": "Ordered list of component IDs with their new positions", "items": { - "$ref": "#/components/schemas/AlertDeliveryDto" + "$ref": "#/components/schemas/ComponentPosition" + } + } + }, + "description": "Batch component reorder request" + }, + "ReorderPageLayoutRequest": { + "required": [ + "sections" + ], + "type": "object", + "properties": { + "sections": { + "minItems": 1, + "type": "array", + "description": "Top-level sections in their new order", + "items": { + "$ref": "#/components/schemas/PageSection" } }, - "createdAt": { - "type": "string", - "description": "Timestamp when the dispatch was created", - "format": "date-time" - }, - "updatedAt": { + "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": "Timestamp when the dispatch was last updated", - "format": "date-time" + "description": "Optional resolution message or post-mortem notes", + "nullable": true } - }, - "description": "Dispatch state for a single (incident, notification policy) pair, with delivery history" + } }, - "NotificationDto": { + "ResourceGroupDeleteBlockerDto": { "required": [ - "createdAt", - "title", - "type", - "id", - "read" + "componentId", + "componentName", + "statusPageId", + "statusPageName", + "statusPageSlug" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Unique notification identifier", - "format": "int64" - }, - "type": { + "statusPageId": { "type": "string", - "description": "Notification category (e.g. incident, monitor, team)" + "description": "Status page that owns the blocking component", + "format": "uuid" }, - "title": { + "statusPageName": { + "minLength": 1, "type": "string", - "description": "Short notification title" + "description": "Human-readable status page name" }, - "body": { + "statusPageSlug": { + "minLength": 1, "type": "string", - "description": "Full notification body; null for title-only notifications", - "nullable": true + "description": "URL-safe status page slug" }, - "resourceType": { + "componentId": { "type": "string", - "description": "Type of the resource this notification is about", - "nullable": true + "description": "Blocking GROUP-typed status page component ID", + "format": "uuid" }, - "resourceId": { + "componentName": { + "minLength": 1, "type": "string", - "description": "ID of the resource this notification is about", - "nullable": true - }, - "read": { - "type": "boolean", - "description": "Whether the notification has been read" + "description": "Blocking component display name" }, - "createdAt": { + "hostname": { "type": "string", - "description": "Timestamp when the notification was created", - "format": "date-time" + "description": "Public hostname when a custom domain is configured; null otherwise", + "nullable": true } }, - "description": "In-app notification for the current user" + "description": "Status-page component that references this resource group (blocks delete; public exposure)" }, - "NotificationPolicyDto": { + "ResourceGroupDto": { "required": [ "createdAt", - "escalation", + "health", "id", - "matchRules", "name", + "slug", "updatedAt", "organizationId", - "enabled", - "priority" + "suppressMemberAlerts" ], "type": "object", "properties": { "id": { "type": "string", - "description": "Unique notification policy identifier", + "description": "Unique resource group identifier", "format": "uuid" }, "organizationId": { "type": "integer", - "description": "Organization this policy belongs to", + "description": "Organization this group belongs to", "format": "int32" }, "name": { "minLength": 1, "type": "string", - "description": "Human-readable name for this policy" + "description": "Human-readable group name" + }, + "slug": { + "minLength": 1, + "type": "string", + "description": "URL-safe group identifier" }, "description": { "type": "string", - "description": "Optional note; null when unset", + "description": "Optional group description", "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": { + "alertPolicyId": { "type": "string", - "description": "Timestamp when the policy was created", - "format": "date-time" + "description": "Notification policy applied to this group", + "format": "uuid", + "nullable": true }, - "updatedAt": { - "type": "string", - "description": "Timestamp when the policy was last updated", - "format": "date-time" + "defaultFrequency": { + "type": "integer", + "description": "Default check frequency in seconds for member monitors", + "format": "int32", + "nullable": true }, - "stats7d": { + "defaultRegions": { + "type": "array", + "description": "Default regions for member monitors", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/NotificationPolicyWindowStatsDto" - } - ] + "items": { + "type": "string", + "description": "Default regions for member monitors" + } }, - "stats30d": { + "defaultRetryStrategy": { "nullable": true, "allOf": [ { - "$ref": "#/components/schemas/NotificationPolicyWindowStatsDto" + "$ref": "#/components/schemas/RetryStrategy" } ] }, - "lastFiredAt": { - "type": "string", - "description": "Created-at of the most recent dispatch for this policy; null if never fired", - "format": "date-time", - "nullable": true + "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" + } }, - "lastFiredIncidentId": { + "defaultEnvironmentId": { "type": "string", - "description": "Incident id of the most recent dispatch; null if never fired", + "description": "Default environment ID for member monitors", "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" + "healthThresholdType": { + "type": "string", + "description": "Health threshold type: COUNT or PERCENTAGE", + "nullable": true, + "enum": [ + "COUNT", + "PERCENTAGE" + ] }, - "sends": { - "type": "integer", - "description": "Alert deliveries linked to fires in the window", - "format": "int32" + "healthThresholdValue": { + "type": "number", + "description": "Health threshold value", + "nullable": true }, - "failedSends": { - "type": "integer", - "description": "Linked deliveries with status FAILED", - "format": "int32" + "suppressMemberAlerts": { + "type": "boolean", + "description": "When true, member-level incidents skip notification dispatch; only group alerts fire" }, - "medianAckSeconds": { + "confirmationDelaySeconds": { "type": "integer", - "description": "Median seconds from fire to ack among acknowledged fires; null when none", - "format": "int64", + "description": "Seconds to wait after health threshold breach before creating group incident", + "format": "int32", "nullable": true }, - "deepestStepReached": { + "recoveryCooldownMinutes": { "type": "integer", - "description": "Highest escalation step reached in the window; null when no fires", + "description": "Cooldown minutes after group incident resolves before a new one can open", "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 - }, - "measurement": { - "type": "string", - "description": "How the vendor measures uptime for SLA purposes", - "nullable": true + "health": { + "$ref": "#/components/schemas/ResourceGroupHealthDto" }, - "exclusions": { - "type": "string", - "description": "Summary of exclusions from SLA calculation", - "nullable": true + "members": { + "type": "array", + "description": "Member list with individual statuses; populated on detail GET only", + "nullable": true, + "items": { + "$ref": "#/components/schemas/ResourceGroupMemberDto" + } }, - "appliesToPlans": { + "deleteBlockedBy": { "type": "array", - "description": "Plan names this SLA applies to, e.g. ['Enterprise']", + "description": "Status-page GROUP components that reference this group (delete blockers / public exposure); populated on detail GET only — omitted on list", "nullable": true, "items": { - "type": "string", - "description": "Plan names this SLA applies to, e.g. ['Enterprise']" + "$ref": "#/components/schemas/ResourceGroupDeleteBlockerDto" } }, - "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", - "enum": [ - "opsgenie" + "openRegionIncident": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/IncidentDto" + } ] }, - "apiKey": { - "minLength": 1, - "type": "string", - "description": "OpsGenie API key for alert creation" - }, - "region": { - "type": "string", - "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" - }, - "name": { - "type": "string", - "description": "Organization name" - }, - "email": { - "type": "string", - "description": "Billing and contact email", - "nullable": true - }, - "size": { + "managedBy": { "type": "string", - "description": "Team size range (e.g. 1-10, 11-50)", - "nullable": true + "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" + ] }, - "industry": { + "createdAt": { "type": "string", - "description": "Industry vertical (e.g. SaaS, Fintech)", - "nullable": true + "description": "Timestamp when the group was created", + "format": "date-time" }, - "websiteUrl": { + "updatedAt": { "type": "string", - "description": "Organization website URL", - "nullable": true + "description": "Timestamp when the group was last updated", + "format": "date-time" } }, - "description": "Organization account details" + "description": "Resource group with health summary and optional member details" }, - "OrgIncidentAnnotationDto": { + "ResourceGroupHealthDto": { "required": [ - "incidentId", - "severity", "status", - "alerted" + "totalMembers", + "operationalCount", + "activeIncidents" ], "type": "object", "properties": { - "incidentId": { - "type": "string", - "description": "Internal org incident ID", - "format": "uuid" - }, - "displayKey": { - "type": "string", - "description": "Human display key (e.g. DEV-42); null until platform INC codes ship", - "nullable": true - }, "status": { "type": "string", - "description": "Internal incident lifecycle status", - "enum": [ - "WATCHING", - "TRIGGERED", - "CONFIRMED", - "RESOLVED" - ] - }, - "severity": { - "type": "string", - "description": "Internal incident severity", + "description": "Worst-of health status across all members", "enum": [ - "DOWN", - "DEGRADED", - "MAINTENANCE" + "operational", + "maintenance", + "degraded", + "down" ] }, - "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": "Linked internal incident annotation on a vendor status-event row" - }, - "OrgInfo": { - "required": [ - "name", - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Organization ID", - "format": "int32" - }, - "name": { - "type": "string", - "description": "Organization name" - } - }, - "description": "Organization the key belongs to" - }, - "Pageable": { - "type": "object", - "properties": { - "page": { - "minimum": 0, + "totalMembers": { "type": "integer", + "description": "Total number of members in the group", "format": "int32" }, - "size": { - "minimum": 1, + "operationalCount": { "type": "integer", + "description": "Number of members currently in operational status", "format": "int32" }, - "sort": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "page", - "size", - "sort" - ] - }, - "PagerDutyChannelConfig": { - "required": [ - "channelType", - "routingKey" - ], - "type": "object", - "properties": { - "channelType": { - "type": "string", - "enum": [ - "pagerduty" - ] - }, - "routingKey": { - "minLength": 1, - "type": "string", - "description": "PagerDuty Events API v2 routing (integration) key" - }, - "severityOverride": { - "type": "string", - "description": "Override PagerDuty severity mapping", - "nullable": true - } - } - }, - "PageSection": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "Group ID when this section is a group", - "format": "uuid", - "nullable": true - }, - "componentId": { - "type": "string", - "description": "Component ID when this section is an ungrouped component", - "format": "uuid", - "nullable": true - }, - "pageOrder": { - "type": "integer", - "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": { + "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, "enum": [ - "phone_call" + "healthy", + "degraded", + "down" ] }, - "phoneNumber": { - "type": "string", - "description": "Recipient phone number in E.164 format, e.g. +14155550123", - "nullable": true - }, - "verifiedPhoneNumberId": { + "failingCount": { "type": "integer", - "description": "Id of an org verified_phone_number row; alternative to phoneNumber", - "format": "int64", + "description": "Number of failing members at time of last evaluation; null when no threshold configured", + "format": "int32", "nullable": true }, - "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", - "description": "Deprecated: use phoneNumber. Accepted as a length-1 list for one release; ignored when phoneNumber or id is set", - "nullable": true - } - }, - "voiceLanguage": { + "healthBreachedSince": { "type": "string", - "description": "TTS voice language/locale (default: en-US). See VoiceLanguage for supported values", + "description": "When the health threshold was first breached in the current cycle; null when not breached", + "format": "date-time", "nullable": true }, - "preferredLanguage": { + "healthEvaluatedAt": { "type": "string", - "description": "Preferred language for TTS and notifications (BCP-47, e.g. en-US, de-DE). Alias for voiceLanguage", + "description": "When group health was last evaluated (threshold or stamp-only); null until first evaluation", + "format": "date-time", "nullable": true } }, - "required": [ - "channelType" - ] + "description": "Aggregated health summary for a resource group" }, - "PlanInfo": { + "ResourceGroupMemberDto": { "required": [ - "entitlements", - "tier", - "usage", - "trialActive" + "createdAt", + "groupId", + "id", + "memberType", + "status" ], "type": "object", "properties": { - "tier": { + "id": { "type": "string", - "description": "Resolved plan tier", - "enum": [ - "FREE", - "STARTER", - "PRO", - "TEAM", - "BUSINESS", - "ENTERPRISE" - ] + "description": "Unique group member record identifier", + "format": "uuid" }, - "subscriptionStatus": { + "groupId": { "type": "string", - "description": "Subscription status (null if no subscription)", - "nullable": true + "description": "Resource group this member belongs to", + "format": "uuid" }, - "trialActive": { - "type": "boolean", - "description": "Whether the org is on a trial" + "memberType": { + "type": "string", + "description": "Type of member: 'monitor' or 'service'" }, - "trialExpiresAt": { + "monitorId": { "type": "string", - "description": "Trial expiry (null if not trialing)", - "format": "date-time", + "description": "Monitor ID; set when memberType is 'monitor'", + "format": "uuid", "nullable": true }, - "entitlements": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/EntitlementDto" - }, - "description": "Entitlement limits keyed by entitlement name" + "serviceId": { + "type": "string", + "description": "Service ID; set when memberType is 'service'", + "format": "uuid", + "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, + "name": { "type": "string", - "description": "Hex-encoded SHA-256 of the canonical policy JSON" + "description": "Display name of the referenced monitor or service", + "nullable": true }, - "policy": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Canonical policy document (snake_case, sorted keys)" - }, - "description": "Canonical policy document (snake_case, sorted keys)" + "slug": { + "type": "string", + "description": "Slug identifier for the service (services only); used for icons and uptime API calls", + "nullable": true }, - "engineVersion": { - "minLength": 1, + "subscriptionId": { "type": "string", - "description": "Detection engine version that observed this policy" + "description": "Subscription ID for the service (services only); used to link to the dependency detail page", + "format": "uuid", + "nullable": true }, - "firstSeenAt": { + "status": { "type": "string", - "description": "First time the detection engine evaluated against this policy bytes", - "format": "date-time" + "description": "Computed health status for this member", + "enum": [ + "operational", + "maintenance", + "degraded", + "down" + ] }, - "lastSeenAt": { + "effectiveFrequency": { "type": "string", - "description": "Most recent time the engine evaluated against this policy bytes", - "format": "date-time" - } - }, - "description": "Policy snapshot used during this check (all evaluations of a single check are against one policy)", - "nullable": true - }, - "PollChartBucketDto": { - "required": [ - "bucket", - "totalPolls" - ], - "type": "object", - "properties": { - "bucket": { + "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 + }, + "createdAt": { "type": "string", - "description": "Start of the time bucket (ISO 8601)", + "description": "Timestamp when the member was added to the group", "format": "date-time" }, - "uptimePercent": { + "uptime24h": { "type": "number", - "description": "Uptime percentage for this bucket; null when no data", + "description": "24h uptime percentage; populated when includeMetrics=true", "format": "double", + "nullable": true + }, + "chartData": { + "type": "array", + "description": "Uptime tick values (0-100) for last-24h mini chart; populated when includeMetrics=true", "nullable": true, - "example": 100 + "items": { + "type": "number", + "description": "Uptime tick values (0-100) for last-24h mini chart; populated when includeMetrics=true", + "format": "double" + } }, - "avgResponseTimeMs": { + "avgLatencyMs": { "type": "number", - "description": "Average response time in milliseconds for this bucket", + "description": "Average latency in ms (monitors only); populated when includeMetrics=true", "format": "double", - "nullable": true, - "example": 245.3 + "nullable": true }, - "totalPolls": { - "type": "integer", - "description": "Total polls in this bucket", - "format": "int64", - "example": 60 - } - }, - "description": "Aggregated poll metrics for a time bucket" - }, - "PricingTier": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Tier name, e.g. 'Free', 'Pro', 'Enterprise'" + "p95LatencyMs": { + "type": "number", + "description": "P95 latency in ms (monitors only); populated when includeMetrics=true", + "format": "double", + "nullable": true }, - "slaPercentage": { + "lastCheckedAt": { "type": "string", - "description": "SLA percentage for this tier, e.g. '99.9%'", + "description": "Timestamp of the most recent health check; populated when includeMetrics=true", + "format": "date-time", "nullable": true }, - "priceFrom": { + "monitorType": { "type": "string", - "description": "Starting price, e.g. '$0', '$25/mo', 'Custom'", + "description": "Monitor type (HTTP, DNS, TCP, ICMP, HEARTBEAT, MCP); monitors only", "nullable": true - } - }, - "description": "Pricing tiers with associated SLA levels" - }, - "PublishStatusPageIncidentRequest": { - "type": "object", - "properties": { - "title": { - "maxLength": 500, - "minLength": 0, + }, + "environmentName": { "type": "string", - "description": "Customer-facing title; null keeps draft value", + "description": "Environment name; monitors only", "nullable": true }, - "impact": { - "type": "string", - "description": "Impact level; null keeps draft value", - "nullable": true, - "enum": [ - "NONE", - "MINOR", - "MAJOR", - "CRITICAL" - ] + "groupMembershipCount": { + "type": "integer", + "description": "Count of resource groups this monitor or service belongs to; detail GET only — omitted on list", + "format": "int32", + "nullable": true }, - "status": { + "failingSince": { "type": "string", - "description": "Incident status; null keeps draft value (must be an active status)", - "nullable": true, - "enum": [ - "INVESTIGATING", - "IDENTIFIED", - "MONITORING", - "RESOLVED" - ] + "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 }, - "body": { - "type": "string", - "description": "Initial update body; null keeps draft value", + "alertCollapsed": { + "type": "boolean", + "description": "True when an active member incident records this group among alertCollapsedByResourceGroupIds; detail GET only — omitted on list", "nullable": true }, - "affectedComponents": { + "incidentMarks": { "type": "array", - "description": "Affected components; null keeps draft value", + "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/AffectedComponent" + "$ref": "#/components/schemas/ResourceGroupMemberIncidentMarkDto" } - }, - "notifySubscribers": { - "type": "boolean", - "description": "Whether to notify subscribers (default: true)", - "nullable": true } - } + }, + "description": "A single member of a resource group with its computed health status" }, - "PushbulletChannelConfig": { + "ResourceGroupMemberIncidentMarkDto": { "required": [ - "channelType", - "accessToken" + "at" ], "type": "object", "properties": { - "channelType": { + "at": { "type": "string", - "enum": [ - "pushbullet" - ] + "description": "Incident startedAt (or first confirmed) within the trailing 24h window", + "format": "date-time" }, - "accessToken": { - "minLength": 1, + "incidentId": { "type": "string", - "description": "Pushbullet access token" + "description": "Incident ID for navigation; null when unknown", + "format": "uuid", + "nullable": true }, - "deviceIden": { + "severity": { "type": "string", - "description": "Target device identifier (broadcasts to all if empty)", + "description": "Optional severity display hint", "nullable": true } - } + }, + "description": "Member incident mark for the trailing 24h uptime strip" }, - "PushoverChannelConfig": { - "required": [ - "channelType", - "userKey", - "appToken" - ], + "ResponseSizeAssertion": { "type": "object", "properties": { - "channelType": { + "type": { "type": "string", "enum": [ - "pushover" + "response_size" ] }, - "userKey": { - "minLength": 1, - "type": "string", - "description": "Pushover user or group key" - }, - "appToken": { - "minLength": 1, - "type": "string", - "description": "Pushover application API token" - }, - "priority": { - "type": "string", - "description": "Notification priority override (-2 to 2)", - "nullable": true - }, - "sound": { - "type": "string", - "description": "Notification sound override", - "nullable": true - } - } - }, - "RateLimitInfo": { - "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" - }, - "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": { + "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" + }, + "RetryStrategy": { + "required": [ + "type", + "maxRetries", + "interval" + ], + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Comparison operator (equals, contains, less_than, greater_than, etc.)", - "enum": [ - "equals", - "contains", - "less_than", - "greater_than", - "matches", - "range" - ] + "description": "Retry strategy kind, e.g. fixed interval between attempts" + }, + "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" }, - "RegexBodyAssertion": { + "RevisionDiffDto": { + "required": [ + "hunks", + "left", + "right" + ], + "type": "object", + "properties": { + "left": { + "$ref": "#/components/schemas/RevisionDto" + }, + "right": { + "$ref": "#/components/schemas/RevisionDto" + }, + "hunks": { + "type": "array", + "description": "File and field-level hunks (bounded)", + "items": { + "$ref": "#/components/schemas/RevisionDiffHunkDto" + } + } + }, + "description": "Bounded comparison of two revisions" + }, + "RevisionDiffHunkDto": { "required": [ - "type", - "pattern" + "change", + "path" ], "type": "object", "properties": { - "type": { + "path": { + "minLength": 1, + "type": "string", + "description": "Path or field name (entrypoint, keys, or file path)" + }, + "change": { "type": "string", + "description": "Whether this path was added, removed, or changed", "enum": [ - "regex_body" + "added", + "removed", + "changed" ] }, - "pattern": { - "minLength": 1, + "left": { "type": "string", - "description": "Regular expression the response body must match" + "description": "Left value when present", + "nullable": true + }, + "right": { + "type": "string", + "description": "Right value when present", + "nullable": true } - } + }, + "description": "One bounded diff hunk between revisions" }, - "RegionStatusDto": { + "RevisionDto": { "required": [ - "region", - "timestamp", - "passed" + "createdAt", + "definitionId", + "digest", + "entrypoint", + "files", + "id", + "keys", + "number" ], "type": "object", "properties": { - "region": { + "id": { "type": "string", - "description": "Region identifier", - "example": "us-east" + "description": "Revision identifier", + "format": "uuid" }, - "passed": { - "type": "boolean", - "description": "Whether the last check in this region passed", - "example": true + "definitionId": { + "type": "string", + "description": "Parent definition", + "format": "uuid" }, - "responseTimeMs": { + "number": { "type": "integer", - "description": "Response time in milliseconds for the last check", - "format": "int32", - "nullable": true, - "example": 95 + "description": "Monotonic revision number within the definition", + "format": "int32" }, - "timestamp": { + "digest": { + "minLength": 1, "type": "string", - "description": "Timestamp of the last check in this region (ISO 8601)", - "format": "date-time" + "description": "SHA-256 hex digest of the zip" }, - "severityHint": { + "entrypoint": { + "minLength": 1, "type": "string", - "description": "Severity hint: 'down' for hard failures, 'degraded' for warn-only failures, null when passing", - "nullable": true - } - }, - "description": "Latest check result for a single region" - }, - "RelatedIncidentsResponse": { - "required": [ - "data", - "total" - ], - "type": "object", - "properties": { - "data": { + "description": "Entrypoint file that runs" + }, + "files": { "type": "array", - "description": "Related incident rows (newest first, capped by limit)", + "description": "Paths present in the zip", "items": { - "$ref": "#/components/schemas/IncidentDto" + "type": "string", + "description": "Paths present in the zip" } }, - "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" - }, - "RemoveMonitorTagsRequest": { - "required": [ - "tagIds" - ], - "type": "object", - "properties": { - "tagIds": { - "minItems": 1, + "keys": { "type": "array", - "description": "IDs of the tags to detach from the monitor", + "description": "Secret key names the code demands", "items": { "type": "string", - "description": "IDs of the tags to detach from the monitor", - "format": "uuid" + "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": { + "id": { + "type": "string", + "description": "Case identifier", + "format": "uuid" + }, + "organizationId": { + "type": "integer", + "description": "Organization this case belongs to", + "format": "int32" + }, + "runId": { + "type": "string", + "description": "Run this case belongs to", + "format": "uuid" + }, + "attempt": { + "type": "integer", + "description": "Playwright in-case attempt number", + "format": "int32" + }, + "index": { + "type": "integer", + "description": "Zero-based case index within the attempt", + "format": "int32" + }, + "title": { + "type": "string", + "description": "Case title" + }, + "file": { + "type": "string", + "description": "Spec path inside the package", + "nullable": true + }, "status": { "type": "string", - "description": "Worst-of health status across all members", + "description": "Case status", "enum": [ - "operational", - "maintenance", - "degraded", - "down" + "pending", + "running", + "passed", + "failed", + "timed_out", + "skipped", + "interrupted" ] }, - "totalMembers": { + "startedAt": { + "type": "string", + "description": "When the case started", + "format": "date-time", + "nullable": true + }, + "finishedAt": { + "type": "string", + "description": "When the case finished", + "format": "date-time", + "nullable": true + }, + "durationMs": { "type": "integer", - "description": "Total number of members in the group", - "format": "int32" + "description": "Reporter duration in milliseconds", + "format": "int32", + "nullable": true }, - "operationalCount": { + "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": "Number of members currently in operational status", - "format": "int32" + "description": "Only return cases for this Playwright attempt", + "format": "int32", + "nullable": true + } + } + }, + "RunDto": { + "required": [ + "attempts", + "bindingVersionSnapshot", + "bundleDigest", + "capturePolicySnapshot", + "enqueuedAt", + "evidence", + "id", + "monitorId", + "phase", + "region", + "revisionId", + "source", + "tabCounts", + "organizationId", + "cancelRequested", + "stream", + "attempt", + "attemptOf" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique run identifier", + "format": "uuid" }, - "activeIncidents": { + "organizationId": { "type": "integer", - "description": "Number of members currently non-operational (not an incident-row count)", + "description": "Organization this run belongs to", "format": "int32" }, - "thresholdStatus": { + "monitorId": { "type": "string", - "description": "Computed group health status based on threshold: 'healthy', 'degraded', or 'down'. Null when no health threshold is configured.", + "description": "Monitor this run belongs to", + "format": "uuid" + }, + "monitorName": { + "type": "string", + "description": "Monitor display name", + "nullable": true + }, + "monitorType": { + "type": "string", + "description": "Monitor type", "nullable": true, "enum": [ - "healthy", - "degraded", - "down" + "HTTP", + "DNS", + "MCP_SERVER", + "TCP", + "ICMP", + "HEARTBEAT", + "BROWSER", + "MULTI_STEP_API" ] }, - "failingCount": { - "type": "integer", - "description": "Number of failing members at time of last evaluation; null when no threshold configured", - "format": "int32", + "host": { + "type": "string", + "description": "Target host from the environment BASE_URL", "nullable": true }, - "healthBreachedSince": { + "environmentId": { "type": "string", - "description": "When the health threshold was first breached in the current cycle; null when not breached", - "format": "date-time", + "description": "Environment this run executed in", + "format": "uuid", "nullable": true }, - "healthEvaluatedAt": { + "environmentName": { "type": "string", - "description": "When group health was last evaluated (threshold or stamp-only); null until first evaluation", - "format": "date-time", + "description": "Environment display name", "nullable": true - } - }, - "description": "Aggregated health summary for a resource group" - }, - "ResourceGroupMemberDto": { - "required": [ - "createdAt", - "groupId", - "id", - "memberType", - "status" - ], - "type": "object", - "properties": { - "id": { + }, + "revisionId": { "type": "string", - "description": "Unique group member record identifier", + "description": "Revision this run executed", "format": "uuid" }, - "groupId": { + "region": { + "minLength": 1, "type": "string", - "description": "Resource group this member belongs to", - "format": "uuid" + "description": "Probe region for this run" }, - "memberType": { + "source": { "type": "string", - "description": "Type of member: 'monitor' or 'service'" + "description": "What triggered this run", + "enum": [ + "schedule", + "run_now", + "ci", + "fast_retry", + "remote_validation", + "deployment_validation", + "session_renew" + ] }, - "monitorId": { + "enqueuedAt": { "type": "string", - "description": "Monitor ID; set when memberType is 'monitor'", - "format": "uuid", - "nullable": true + "description": "When this run was enqueued", + "format": "date-time" }, - "serviceId": { + "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": { - "type": "string", - "enum": [ - "response_size" - ] - }, - "maxBytes": { + "after": { "type": "integer", - "description": "Maximum response body size in bytes before the check fails", - "format": "int32" + "description": "Replay events with seq greater than this value", + "format": "int64", + "nullable": true } - }, - "required": [ - "type", - "maxBytes" - ] + } }, - "ResponseTimeAssertion": { + "RunEvidenceDto": { + "required": [ + "kind", + "state" + ], "type": "object", "properties": { - "type": { + "kind": { "type": "string", + "description": "Evidence kind in SHOT → TRACE → VIDEO → NET order", "enum": [ - "response_time" + "screenshot", + "trace", + "video", + "network" ] }, - "thresholdMs": { - "type": "integer", - "description": "Maximum allowed response time in milliseconds before the check fails", - "format": "int32" - } - }, - "required": [ - "type", - "thresholdMs" - ] - }, - "ResponseTimeWarnAssertion": { - "type": "object", - "properties": { - "type": { + "state": { "type": "string", + "description": "Whether the artifact is usable", "enum": [ - "response_time_warn" + "present", + "bad", + "processing", + "expired" ] - }, - "warnMs": { - "type": "integer", - "description": "HTTP response time in milliseconds that triggers a warning only", - "format": "int32" } }, - "required": [ - "type", - "warnMs" - ] + "description": "List evidence chip" }, - "ResultSummaryDto": { - "required": [ - "chartData", - "currentStatus", - "latestPerRegion" - ], + "RunListParams": { "type": "object", "properties": { - "currentStatus": { + "phase": { "type": "string", - "description": "Derived current status across all regions", - "enum": [ - "up", - "degraded", - "down", - "paused", - "unknown" - ] + "description": "Filter by run phase; omit to return every phase", + "nullable": true }, - "latestPerRegion": { - "type": "array", - "description": "Latest check result per region", - "items": { - "$ref": "#/components/schemas/RegionStatusDto" - } + "outcome": { + "type": "string", + "description": "Filter by persist outcome; omit to return every outcome", + "nullable": true }, - "chartData": { - "type": "array", - "description": "Time-bucketed chart data for the requested window", - "items": { - "$ref": "#/components/schemas/ChartBucketDto" - } + "region": { + "type": "string", + "description": "Filter by probe region", + "nullable": true }, - "uptime24h": { - "type": "number", - "description": "Uptime percentage over the last 24 hours; null when no data", - "format": "double", - "nullable": true, - "example": 99.95 + "source": { + "type": "string", + "description": "Filter by what triggered the run", + "nullable": true }, - "uptimeWindow": { - "type": "number", - "description": "Uptime percentage for the selected chart window; null when no data", - "format": "double", - "nullable": true, - "example": 99.8 + "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": "Page size (1–100, default 50)", + "format": "int32" + }, + "page": { + "minimum": 0, + "type": "integer", + "description": "Zero-based page index (default 0)", + "format": "int32" } }, - "description": "Dashboard summary: current status, per-region latest results, and chart data" - }, - "RetryStrategy": { "required": [ - "type", - "maxRetries", - "interval" - ], + "size", + "page" + ] + }, + "RunLiveDto": { "type": "object", "properties": { - "type": { + "stepIndex": { + "type": "integer", + "description": "Current step index", + "format": "int32", + "nullable": true + }, + "stepTitle": { "type": "string", - "description": "Retry strategy kind, e.g. fixed interval between attempts" + "description": "Current step title", + "nullable": true }, - "maxRetries": { + "stepCount": { "type": "integer", - "description": "Maximum number of retries after a failed check", + "description": "Known step count for this attempt", "format": "int32" }, - "interval": { + "artifactsUploaded": { "type": "integer", - "description": "Delay between retry attempts in seconds", - "format": "int32" + "description": "Artifacts already available", + "format": "int32", + "nullable": true + }, + "artifactsExpected": { + "type": "integer", + "description": "Artifacts expected for this run", + "format": "int32", + "nullable": true } }, - "description": "Default retry strategy for member monitors; null clears" + "description": "Live run progress", + "required": [ + "stepCount" + ] }, - "RootlyChannelConfig": { + "RunnerLogLiveEvent": { "required": [ - "channelType", - "apiKey" + "line", + "ts" ], "type": "object", "properties": { - "channelType": { + "ts": { "type": "string", - "enum": [ - "rootly" - ] + "description": "Loki timestamp in nanoseconds" }, - "apiKey": { + "line": { "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 + "description": "One runner-log line" } - } + }, + "description": "Live runner-log line" }, - "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 +40765,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 +40855,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 +42073,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 +42265,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" @@ -36092,6 +42342,17 @@ } } }, + "SingleValueResponsePackageUploadDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PackageUploadDto" + } + } + }, "SingleValueResponsePolicySnapshotDto": { "required": [ "data" @@ -36147,6 +42408,61 @@ } } }, + "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" + } + } + }, + "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 +42474,17 @@ } } }, + "SingleValueResponseSecretUsageDto": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SecretUsageDto" + } + } + }, "SingleValueResponseServiceDayDetailDto": { "required": [ "data" @@ -36658,6 +42985,10 @@ } }, "SslExpiryAssertion": { + "required": [ + "type", + "minDaysRemaining" + ], "type": "object", "properties": { "type": { @@ -36671,11 +43002,7 @@ "description": "Minimum days before TLS certificate expiry; fails or warns below this threshold", "format": "int32" } - }, - "required": [ - "type", - "minDaysRemaining" - ] + } }, "StateTransitionDetails": { "required": [ @@ -37822,10 +44149,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -37858,10 +44181,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -37894,10 +44213,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -37930,10 +44245,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -37966,10 +44277,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38002,9 +44309,37 @@ "type": "integer", "format": "int32", "nullable": true + } + } + }, + "TableValueResultDefinitionDto": { + "required": [ + "data", + "hasNext", + "hasPrev" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DefinitionDto" + } + }, + "hasNext": { + "type": "boolean" + }, + "hasPrev": { + "type": "boolean" + }, + "totalElements": { + "type": "integer", + "format": "int64", + "nullable": true }, - "nextCursor": { - "type": "string", + "totalPages": { + "type": "integer", + "format": "int32", "nullable": true } } @@ -38038,10 +44373,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38074,10 +44405,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38110,10 +44437,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38146,10 +44469,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38182,10 +44501,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38218,10 +44533,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38254,10 +44565,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38290,10 +44597,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38326,10 +44629,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38362,10 +44661,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38398,10 +44693,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38434,10 +44725,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38470,10 +44757,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38506,9 +44789,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 +44853,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 +44899,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledMaintenanceDto" + "$ref": "#/components/schemas/RunCaseDto" } }, "hasNext": { @@ -38578,14 +44917,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 +44963,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SecretDto" + "$ref": "#/components/schemas/ScheduledMaintenanceDto" } }, "hasNext": { @@ -38614,9 +44981,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 +45045,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38686,10 +45077,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38722,10 +45109,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38758,10 +45141,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38794,10 +45173,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38830,10 +45205,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38866,10 +45237,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38902,10 +45269,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38938,10 +45301,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -38974,10 +45333,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39010,10 +45365,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39046,10 +45397,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39082,10 +45429,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39118,10 +45461,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39154,10 +45493,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39190,10 +45525,6 @@ "type": "integer", "format": "int32", "nullable": true - }, - "nextCursor": { - "type": "string", - "nullable": true } } }, @@ -39729,6 +46060,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 +46879,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 +46912,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 +46944,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 +46955,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 +46984,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 +46999,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 +47942,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", + "format": "date-time", + "nullable": true + } + } + }, "UptimeBucketDto": { "required": [ "timestamp", @@ -41594,6 +48057,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 +48435,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/src/devhelm/_generated.py b/src/devhelm/_generated.py index 1a01743..40f8d12 100644 --- a/src/devhelm/_generated.py +++ b/src/devhelm/_generated.py @@ -3,7 +3,7 @@ from __future__ import annotations from typing import Annotated, Any, Literal -from pydantic import ConfigDict, AwareDatetime, BaseModel, EmailStr, Field, RootModel +from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field, RootModel from enum import StrEnum from uuid import UUID from datetime import date as date_aliased @@ -465,6 +465,13 @@ class ApiKeyDto(BaseModel): ] = None +class ArtifactViewport(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + width: Annotated[int, Field(description="Viewport width in CSS pixels")] + height: Annotated[int, Field(description="Viewport height in CSS pixels")] + dpr: Annotated[int, Field(description="Device pixel ratio at capture")] + + class AssertionResultDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) type: Annotated[str, Field(description="Assertion type", examples=["status_code"])] @@ -538,6 +545,35 @@ class Action(StrEnum): remove_tag = "REMOVE_TAG" +class Screenshots(StrEnum): + always = "always" + on_failure = "on_failure" + off = "off" + + +class Trace(StrEnum): + always = "always" + on_failure = "on_failure" + off = "off" + + +class Video(StrEnum): + always = "always" + on_failure = "on_failure" + off = "off" + + +class CapturePolicy(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + screenshots: Annotated[ + Screenshots | None, Field(description="When to capture screenshots") + ] = None + trace: Annotated[ + Trace | None, Field(description="When to capture a Playwright trace") + ] = None + video: Annotated[Video | None, Field(description="When to capture video")] = None + + class CategoryDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) category: Annotated[ @@ -989,6 +1025,18 @@ class Type(StrEnum): multi_step_api = "MULTI_STEP_API" +class CreatePackageUploadRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + digest: Annotated[ + str, + Field( + description="SHA-256 hex digest of the package zip to upload (64 chars)", + max_length=64, + min_length=64, + ), + ] + + class HealthThresholdType(StrEnum): count = "COUNT" # type: ignore[assignment] percentage = "PERCENTAGE" @@ -1387,6 +1435,31 @@ class DayIncident(BaseModel): ] +class DefinitionDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[UUID, Field(description="Definition identifier")] + organization_id: Annotated[ + int, + Field( + alias="organizationId", + description="Organization this definition belongs to", + ), + ] + name: Annotated[str, Field(description="Human-readable name", min_length=1)] + slug: Annotated[ + str, + Field(description="URL-safe slug unique within the organization", min_length=1), + ] + created_at: Annotated[ + AwareDatetime, + Field(alias="createdAt", description="When the definition was created"), + ] + updated_at: Annotated[ + AwareDatetime, + Field(alias="updatedAt", description="When the definition was last updated"), + ] + + class DekRotationResultDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) previous_dek_version: Annotated[ @@ -3237,12 +3310,183 @@ class MonitorAuthDto(BaseModel): config: ApiKeyAuthConfig | BasicAuthConfig | BearerAuthConfig | HeaderAuthConfig +class MonitorOverlayRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + reason: Annotated[ + str | None, + Field( + description="Optional human-readable reason (max 280)", + max_length=280, + min_length=0, + ), + ] = None + expires_at: Annotated[ + AwareDatetime | None, + Field(alias="expiresAt", description="When this overlay expires"), + ] = None + + +class File(RootModel[str]): + root: Annotated[ + str, + Field( + description="Relative file paths included in the zip", + max_length=512, + min_length=0, + ), + ] + + +class Key(RootModel[str]): + root: Annotated[ + str, + Field( + description="Secret names the zip demanded. PUT: null preserves, [] clears", + max_length=255, + min_length=0, + ), + ] + + +class MonitorPackageSpec(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + digest: Annotated[ + str, + Field( + description="SHA-256 hex digest of the package zip (64 characters)", + max_length=64, + min_length=64, + ), + ] + entrypoint: Annotated[ + str, + Field( + description="Entrypoint path inside the zip, e.g. tests/login.spec.ts", + max_length=512, + min_length=0, + ), + ] + files: Annotated[ + list[File], + Field( + description="Relative file paths included in the zip", + max_length=256, + min_length=0, + ), + ] + keys: Annotated[ + list[Key] | None, + Field( + description="Secret names the zip demanded. PUT: null preserves, [] clears", + max_length=64, + min_length=0, + ), + ] = None + git_sha: Annotated[ + str | None, + Field( + alias="gitSha", + description="Commit SHA from the repo that produced this zip. Client-supplied provenance only", + max_length=64, + min_length=0, + ), + ] = None + git_message: Annotated[ + str | None, + Field( + alias="gitMessage", + description="Commit message from the repo that produced this zip", + max_length=1024, + min_length=0, + ), + ] = None + git_file: Annotated[ + str | None, + Field( + alias="gitFile", + description="Path of the declaring file in that repo", + max_length=512, + min_length=0, + ), + ] = None + authored_by: Annotated[ + str | None, + Field( + alias="authoredBy", + description="Author attribution supplied with the package", + max_length=255, + min_length=0, + ), + ] = None + + class MonitorReference(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) id: Annotated[UUID, Field(description="Monitor identifier")] name: Annotated[str, Field(description="Monitor name")] +class MonitorRunListParams(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + phase: Annotated[ + str | None, Field(description="Filter by run phase; omit to return every phase") + ] = None + outcome: Annotated[ + str | None, + Field(description="Filter by persist outcome; omit to return every outcome"), + ] = None + region: Annotated[str | None, Field(description="Filter by probe region")] = None + source: Annotated[ + str | None, Field(description="Filter by what triggered the run") + ] = None + q: Annotated[str | None, Field(description="Substring match on headline")] = None + cursor: Annotated[ + str | None, Field(description="Opaque cursor from a previous page") + ] = None + limit: Annotated[ + int, Field(description="Page size (1–100, default 25)", ge=1, le=100) + ] + + +class MonitorSessionDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + lifecycle: Annotated[str, Field(description="Current session cache state")] + reuse_policy: Annotated[ + str, + Field( + alias="reusePolicy", + description="When the cached session is reused across runs", + ), + ] + setup_file: Annotated[ + str, + Field(alias="setupFile", description="Setup file path inside the package zip"), + ] + expires_at: Annotated[ + AwareDatetime | None, + Field(alias="expiresAt", description="When the cached session expires"), + ] = None + cookie_names: Annotated[ + list[str], + Field(alias="cookieNames", description="Cookie names in the cached session"), + ] + storage_keys: Annotated[ + list[str], + Field( + alias="storageKeys", description="Storage key names in the cached session" + ), + ] + size_bytes: Annotated[ + int | None, Field(alias="sizeBytes", description="Cached session size in bytes") + ] = None + last_rejected_run_id: Annotated[ + UUID | None, + Field( + alias="lastRejectedRunId", description="Run that last rejected this cache" + ), + ] = None + + class MonitorsSummaryDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) total: Annotated[ @@ -3634,6 +3878,29 @@ class OrgInfo(BaseModel): name: Annotated[str, Field(description="Organization name")] +class PackageUploadDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + put_url: Annotated[ + str, + Field( + alias="putUrl", + description="Presigned PUT URL for the zip bytes", + min_length=1, + ), + ] + expires_at: Annotated[ + AwareDatetime, + Field(alias="expiresAt", description="When the signed URL expires"), + ] + required_headers: Annotated[ + dict[str, str], + Field( + alias="requiredHeaders", + description="Must send Content-Type: application/zip and If-None-Match: *", + ), + ] + + class Pageable(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) page: Annotated[int, Field(ge=0)] @@ -3848,6 +4115,17 @@ class PricingTier(BaseModel): ] = None +class PublishRevisionRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + revision_id: Annotated[ + UUID, + Field( + alias="revisionId", + description="Existing revision to activate as Head for this monitor's environment", + ), + ] + + class Status7(StrEnum): investigating = "INVESTIGATING" identified = "IDENTIFIED" @@ -3934,6 +4212,22 @@ class PushoverChannelConfig(BaseModel): ) +class QuarantineMonitorRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + reason: Annotated[ + str, + Field( + description="Reason for this hold (max 280)", max_length=280, min_length=0 + ), + ] + expires_at: Annotated[ + AwareDatetime, Field(alias="expiresAt", description="When the hold expires") + ] + from_run_id: Annotated[ + UUID | None, Field(alias="fromRunId", description="Run that prompted this hold") + ] = None + + class RateLimitInfo(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) requests_per_minute: Annotated[ @@ -4043,6 +4337,16 @@ class RegionStatusDto(BaseModel): ] = None +class RemapSecretRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + secret_id: Annotated[ + UUID | None, + Field( + alias="secretId", description="Secret to attach; null restores name-match" + ), + ] = None + + class RemoveMonitorTagsRequest(BaseModel): model_config = ConfigDict(extra="forbid", populate_by_name=True) tag_ids: Annotated[ @@ -4301,6 +4605,83 @@ class RetryStrategy(BaseModel): ] +class RevisionDiffHunkDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + path: Annotated[ + str, + Field( + description="Path or field name (entrypoint, keys, or file path)", + min_length=1, + ), + ] + change: Annotated[ + str, Field(description="Whether this path was added, removed, or changed") + ] + left: Annotated[str | None, Field(description="Left value when present")] = None + right: Annotated[str | None, Field(description="Right value when present")] = None + + +class RevisionDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[UUID, Field(description="Revision identifier")] + definition_id: Annotated[ + UUID, Field(alias="definitionId", description="Parent definition") + ] + number: Annotated[ + int, Field(description="Monotonic revision number within the definition") + ] + digest: Annotated[ + str, Field(description="SHA-256 hex digest of the zip", min_length=1) + ] + entrypoint: Annotated[ + str, Field(description="Entrypoint file that runs", min_length=1) + ] + files: Annotated[list[str], Field(description="Paths present in the zip")] + keys: Annotated[list[str], Field(description="Secret key names the code demands")] + download_until: Annotated[ + AwareDatetime | None, + Field( + alias="downloadUntil", description="When package bytes expire for download" + ), + ] = None + git_sha: Annotated[ + str | None, + Field(alias="gitSha", description="Git commit SHA when sourced from Git"), + ] = None + git_message: Annotated[ + str | None, Field(alias="gitMessage", description="Git commit message") + ] = None + git_file: Annotated[ + str | None, Field(alias="gitFile", description="Declaring Git file path") + ] = None + authored_by: Annotated[ + str | None, Field(alias="authoredBy", description="Who authored this package") + ] = None + created_at: Annotated[ + AwareDatetime, + Field(alias="createdAt", description="When the revision was minted"), + ] + + +class RollbackRevisionRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + revision_id: Annotated[ + UUID, + Field( + alias="revisionId", + description="Existing revision to restore as Head for this monitor's environment", + ), + ] + reason: Annotated[ + str, + Field( + description="Why this rollback was performed (1–280 chars)", + max_length=280, + min_length=0, + ), + ] + + class RootlyChannelConfig(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) channel_type: Annotated[Literal["rootly"], Field(alias="channelType")] = "rootly" @@ -4410,42 +4791,229 @@ class RuleEvaluationDto(BaseModel): ] = None -class ScheduledMaintenanceDto(BaseModel): +class RunAttemptDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) - id: Annotated[UUID, Field(description="Unique maintenance record identifier")] - external_id: Annotated[ - str, - Field(alias="externalId", description="Vendor-assigned maintenance identifier"), - ] - title: Annotated[ - str, Field(description="Maintenance title as reported by the vendor") - ] - status: Annotated[ - str, - Field( - description="Current maintenance status (scheduled, in_progress, completed)" - ), - ] - impact: Annotated[str | None, Field(description="Reported impact level")] = None - shortlink: Annotated[ - str | None, - Field(description="Vendor-provided short URL to the maintenance page"), + attempt: Annotated[int, Field(description="1-based attempt number")] + outcome: Annotated[ + str | None, Field(description="Attempt outcome; null while the case is open") ] = None - scheduled_for: Annotated[ + started_at: Annotated[ AwareDatetime | None, - Field( - alias="scheduledFor", - description="Timestamp when the maintenance is scheduled to begin", - ), + Field(alias="startedAt", description="When this attempt started"), ] = None - scheduled_until: Annotated[ + finished_at: Annotated[ AwareDatetime | None, - Field( - alias="scheduledUntil", - description="Timestamp when the maintenance is scheduled to end", - ), + Field(alias="finishedAt", description="When this attempt finished"), ] = None - started_at: Annotated[ + + +class RunCaseListParams(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + attempt: Annotated[ + int | None, Field(description="Only return cases for this Playwright attempt") + ] = None + + +class RunEventDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[UUID, Field(description="Event identifier")] + organization_id: Annotated[ + int, + Field(alias="organizationId", description="Organization this event belongs to"), + ] + run_id: Annotated[ + UUID, Field(alias="runId", description="Run this event belongs to") + ] + seq: Annotated[int, Field(description="Supervisor-monotonic sequence, starts at 1")] + type: Annotated[str, Field(description="Control event type")] + case_id: Annotated[ + UUID | None, Field(alias="caseId", description="Case this event refers to") + ] = None + step_id: Annotated[ + UUID | None, Field(alias="stepId", description="Step this event refers to") + ] = None + artifact_id: Annotated[ + UUID | None, + Field(alias="artifactId", description="Artifact this event refers to"), + ] = None + payload: Annotated[ + dict[str, dict[str, Any]], + Field(description="Small typed payload for this event"), + ] + created_at: Annotated[ + AwareDatetime, + Field(alias="createdAt", description="When the event was persisted"), + ] + + +class RunEventParams(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + after: Annotated[ + int | None, Field(description="Replay events with seq greater than this value") + ] = None + + +class RunEvidenceDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + kind: Annotated[ + str, Field(description="Evidence kind in SHOT → TRACE → VIDEO → NET order") + ] + state: Annotated[str, Field(description="Whether the artifact is usable")] + + +class RunListParams(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + phase: Annotated[ + str | None, Field(description="Filter by run phase; omit to return every phase") + ] = None + outcome: Annotated[ + str | None, + Field(description="Filter by persist outcome; omit to return every outcome"), + ] = None + region: Annotated[str | None, Field(description="Filter by probe region")] = None + source: Annotated[ + str | None, Field(description="Filter by what triggered the run") + ] = None + environment_id: Annotated[ + UUID | None, + Field( + alias="environmentId", + description="Only return runs whose monitor lives in this environment", + ), + ] = None + from_: Annotated[ + AwareDatetime | None, + Field( + alias="from", + description="Inclusive lower bound on enqueued_at (default now-30m)", + ), + ] = None + to: Annotated[ + AwareDatetime | None, + Field(description="Inclusive upper bound on enqueued_at (default now)"), + ] = None + q: Annotated[ + str | None, Field(description="Substring match on monitor name or headline") + ] = None + size: Annotated[ + int, Field(description="Page size (1–100, default 50)", ge=1, le=100) + ] + page: Annotated[int, Field(description="Zero-based page index (default 0)", ge=0)] + + +class RunLiveDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + step_index: Annotated[ + int | None, Field(alias="stepIndex", description="Current step index") + ] = None + step_title: Annotated[ + str | None, Field(alias="stepTitle", description="Current step title") + ] = None + step_count: Annotated[ + int, Field(alias="stepCount", description="Known step count for this attempt") + ] + artifacts_uploaded: Annotated[ + int | None, + Field(alias="artifactsUploaded", description="Artifacts already available"), + ] = None + artifacts_expected: Annotated[ + int | None, + Field(alias="artifactsExpected", description="Artifacts expected for this run"), + ] = None + + +class RunnerLogLiveEvent(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + ts: Annotated[str, Field(description="Loki timestamp in nanoseconds")] + line: Annotated[str, Field(description="One runner-log line", min_length=1)] + + +class RunStepDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[UUID, Field(description="Step identifier")] + organization_id: Annotated[ + int, + Field(alias="organizationId", description="Organization this step belongs to"), + ] + run_id: Annotated[ + UUID, Field(alias="runId", description="Run this step belongs to") + ] + case_id: Annotated[ + UUID, Field(alias="caseId", description="Case this step belongs to") + ] + attempt: Annotated[int, Field(description="Playwright in-case attempt number")] + index: Annotated[int, Field(description="Zero-based index within the case attempt")] + title: Annotated[str, Field(description="Step title")] + category: Annotated[str, Field(description="Step category")] + status: Annotated[str, Field(description="Step status")] + started_at: Annotated[ + AwareDatetime | None, + Field(alias="startedAt", description="When the step started"), + ] = None + finished_at: Annotated[ + AwareDatetime | None, + Field(alias="finishedAt", description="When the step finished"), + ] = None + duration_ms: Annotated[ + int | None, + Field(alias="durationMs", description="Reporter duration in milliseconds"), + ] = None + error: Annotated[str | None, Field(description="Error when the step failed")] = None + assertion: Annotated[ + dict[str, dict[str, Any]] | None, + Field(description="Assertion payload when this step is an assertion"), + ] = None + + +class RunTabCountsDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + steps: Annotated[int, Field(description="Step rows for the selected attempt")] + assets: Annotated[ + int, + Field(description="Items across asset kinds, excluding dead no-browser rows"), + ] + diff: Annotated[ + int, + Field(description="1 when a diff baseline exists or this run passed on retry"), + ] + + +class ScheduledMaintenanceDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[UUID, Field(description="Unique maintenance record identifier")] + external_id: Annotated[ + str, + Field(alias="externalId", description="Vendor-assigned maintenance identifier"), + ] + title: Annotated[ + str, Field(description="Maintenance title as reported by the vendor") + ] + status: Annotated[ + str, + Field( + description="Current maintenance status (scheduled, in_progress, completed)" + ), + ] + impact: Annotated[str | None, Field(description="Reported impact level")] = None + shortlink: Annotated[ + str | None, + Field(description="Vendor-provided short URL to the maintenance page"), + ] = None + scheduled_for: Annotated[ + AwareDatetime | None, + Field( + alias="scheduledFor", + description="Timestamp when the maintenance is scheduled to begin", + ), + ] = None + scheduled_until: Annotated[ + AwareDatetime | None, + Field( + alias="scheduledUntil", + description="Timestamp when the maintenance is scheduled to end", + ), + ] = None + started_at: Annotated[ AwareDatetime | None, Field( alias="startedAt", @@ -4475,20 +5043,30 @@ class ScheduledMaintenanceDto(BaseModel): class ScriptMonitorConfig(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) script: Annotated[ - str, + str | None, Field( - description="Playwright test script source code", + description="Legacy inline script on existing rows", max_length=65536, - min_length=1, + min_length=0, ), - ] + ] = None timeout_seconds: Annotated[ int | None, Field( alias="timeoutSeconds", - description="Maximum execution time in seconds (5–120)", + description="Maximum execution time in seconds (5–240)", ge=5, - le=120, + le=240, + ), + ] = None + runtime_id: Annotated[ + str | None, + Field( + alias="runtimeId", + description="Runtime pin YYYY.MM; omit uses workspace default then sole available", + max_length=32, + min_length=0, + pattern="^$|^[A-Za-z0-9._-]+$", ), ] = None @@ -4526,7 +5104,23 @@ class SecretDto(BaseModel): list[MonitorReference] | None, Field( alias="usedByMonitors", - description="Monitors that reference this secret; null on create/update responses", + description="Monitors that reference this secret for authentication", + ), + ] = None + + +class SecretRequestDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + key: Annotated[str, Field(description="Secret key this monitor requires")] + secret: SecretDto | None = None + readiness: Annotated[ + str, Field(description="Whether this key is resolved or missing") + ] + fulfilled_by: Annotated[ + str | None, + Field( + alias="fulfilledBy", + description="Fulfilled from environment variables or a secret", ), ] = None @@ -5084,6 +5678,11 @@ class SingleValueResponseMonitorAuthDto(BaseModel): data: MonitorAuthDto +class SingleValueResponseMonitorSessionDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: MonitorSessionDto + + class SingleValueResponseMonitorTestResultDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) data: MonitorTestResultDto @@ -5099,6 +5698,11 @@ class SingleValueResponseOrganizationDto(BaseModel): data: OrganizationDto +class SingleValueResponsePackageUploadDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: PackageUploadDto + + class SingleValueResponsePolicySnapshotDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) data: PolicySnapshotDto @@ -5114,6 +5718,11 @@ class SingleValueResponseResultSummaryDto(BaseModel): data: ResultSummaryDto +class SingleValueResponseRevisionDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: RevisionDto + + class SingleValueResponseSecretDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) data: SecretDto @@ -5766,7 +6375,6 @@ class TableValueResultAlertChannelDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultAlertDeliveryDto(BaseModel): @@ -5776,7 +6384,6 @@ class TableValueResultAlertDeliveryDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultApiKeyDto(BaseModel): @@ -5786,7 +6393,6 @@ class TableValueResultApiKeyDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultCategoryDto(BaseModel): @@ -5796,7 +6402,15 @@ class TableValueResultCategoryDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None + + +class TableValueResultDefinitionDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: list[DefinitionDto] + has_next: Annotated[bool, Field(alias="hasNext")] + has_prev: Annotated[bool, Field(alias="hasPrev")] + total_elements: Annotated[int | None, Field(alias="totalElements")] = None + total_pages: Annotated[int | None, Field(alias="totalPages")] = None class TableValueResultDeliveryAttemptDto(BaseModel): @@ -5806,7 +6420,6 @@ class TableValueResultDeliveryAttemptDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultEnvironmentDto(BaseModel): @@ -5816,7 +6429,6 @@ class TableValueResultEnvironmentDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultInviteDto(BaseModel): @@ -5826,7 +6438,6 @@ class TableValueResultInviteDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultMaintenanceWindowDto(BaseModel): @@ -5836,7 +6447,6 @@ class TableValueResultMaintenanceWindowDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultMemberDto(BaseModel): @@ -5846,7 +6456,6 @@ class TableValueResultMemberDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultNotificationDispatchDto(BaseModel): @@ -5856,7 +6465,6 @@ class TableValueResultNotificationDispatchDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultNotificationDto(BaseModel): @@ -5866,7 +6474,15 @@ class TableValueResultNotificationDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None + + +class TableValueResultRevisionDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: list[RevisionDto] + has_next: Annotated[bool, Field(alias="hasNext")] + has_prev: Annotated[bool, Field(alias="hasPrev")] + total_elements: Annotated[int | None, Field(alias="totalElements")] = None + total_pages: Annotated[int | None, Field(alias="totalPages")] = None class TableValueResultRuleEvaluationDto(BaseModel): @@ -5876,7 +6492,6 @@ class TableValueResultRuleEvaluationDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultScheduledMaintenanceDto(BaseModel): @@ -5886,7 +6501,6 @@ class TableValueResultScheduledMaintenanceDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultSecretDto(BaseModel): @@ -5896,7 +6510,6 @@ class TableValueResultSecretDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultServiceComponentDto(BaseModel): @@ -5906,7 +6519,6 @@ class TableValueResultServiceComponentDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultServiceIncidentDto(BaseModel): @@ -5916,7 +6528,6 @@ class TableValueResultServiceIncidentDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultServiceSubscriptionDto(BaseModel): @@ -5926,7 +6537,6 @@ class TableValueResultServiceSubscriptionDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultStatusPageComponentDto(BaseModel): @@ -5936,7 +6546,6 @@ class TableValueResultStatusPageComponentDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultStatusPageComponentGroupDto(BaseModel): @@ -5946,7 +6555,6 @@ class TableValueResultStatusPageComponentGroupDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultStatusPageCustomDomainDto(BaseModel): @@ -5956,7 +6564,6 @@ class TableValueResultStatusPageCustomDomainDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultStatusPageNotificationDeliveryDto(BaseModel): @@ -5966,7 +6573,6 @@ class TableValueResultStatusPageNotificationDeliveryDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultStatusPageSubscriberDto(BaseModel): @@ -5976,7 +6582,6 @@ class TableValueResultStatusPageSubscriberDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TagDto(BaseModel): @@ -6293,6 +6898,44 @@ class TlsInfoDto(BaseModel): ] = None +class Id(StrEnum): + failing_action = "failing_action" + failing_step = "failing_step" + first_failed_request = "first_failed_request" + case_start = "case_start" + + +class TraceEntryPoint(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[Id, Field(description="Doorway id")] + action_index: Annotated[ + int, Field(alias="actionIndex", description="Action index this doorway opens") + ] + label: Annotated[str, Field(description="Label shown on the doorway", min_length=1)] + note: Annotated[ + str, Field(description="Short note for why this doorway exists", min_length=1) + ] + + +class TraceNearbyAction(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + action_index: Annotated[ + int, + Field(alias="actionIndex", description="Action index in the Playwright trace"), + ] + kind: Annotated[str, Field(description="Playwright action kind", min_length=1)] + title: Annotated[ + str, Field(description="Human title for this action", min_length=1) + ] + duration_ms: Annotated[ + int | None, + Field(alias="durationMs", description="Action duration in milliseconds"), + ] = None + is_teardown: Annotated[ + bool, Field(alias="isTeardown", description="Whether this action is teardown") + ] + + class Type4(StrEnum): consecutive_failures = "consecutive_failures" failures_in_window = "failures_in_window" @@ -7400,6 +8043,35 @@ class UpdateZapierChannelConfig(BaseModel): ] = None +class ReusePolicy(StrEnum): + reuse = "reuse" + every_run = "every_run" + on_failure = "on_failure" + + +class UpsertMonitorSessionRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + reuse_policy: Annotated[ + ReusePolicy, + Field( + alias="reusePolicy", + description="When to reuse the cached session across runs", + ), + ] + setup_file: Annotated[ + str, + Field( + alias="setupFile", + description="Setup file path inside the package zip", + min_length=1, + ), + ] + expires_at: Annotated[ + AwareDatetime | None, + Field(alias="expiresAt", description="When the cached session expires"), + ] = None + + class UptimeBucketDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) timestamp: Annotated[ @@ -7487,6 +8159,46 @@ class UptimeDto(BaseModel): ] +class UserDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[int, Field(description="Unique user identifier")] + email: Annotated[str, Field(description="User email address")] + email_verified: Annotated[ + bool, + Field( + alias="emailVerified", + description="Whether the email address has been verified", + ), + ] + name: Annotated[str | None, Field(description="Display name; null if not set")] = ( + None + ) + user_role: Annotated[ + str, Field(alias="userRole", description="Platform role: USER or SUPERADMIN") + ] + onboarding_stage: Annotated[ + str | None, + Field( + alias="onboardingStage", + description="Current onboarding progress stage; null when completed", + ), + ] = None + image_url: Annotated[ + str | None, + Field(alias="imageUrl", description="Profile image URL; null if not set"), + ] = None + created_at: Annotated[ + AwareDatetime, + Field(alias="createdAt", description="Timestamp when the account was created"), + ] + updated_at: Annotated[ + AwareDatetime, + Field( + alias="updatedAt", description="Timestamp when the account was last updated" + ), + ] + + class VoiceLanguageDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) code: Annotated[ @@ -7654,6 +8366,16 @@ class WorkspaceDto(BaseModel): ] +class WriteSecretEnvironmentValueRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) + value: Annotated[ + str, + Field( + description="Plaintext value to encrypt for this environment", min_length=1 + ), + ] + + class ZapierChannelConfig(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) channel_type: Annotated[Literal["zapier"], Field(alias="channelType")] = "zapier" @@ -7696,6 +8418,30 @@ class AddMonitorTagsRequest(BaseModel): ] = None +class ArtifactTraceMeta(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + action_count: Annotated[ + int | None, Field(alias="actionCount", description="Action count in the trace") + ] = None + snapshot_count: Annotated[ + int | None, + Field(alias="snapshotCount", description="Snapshot count in the trace"), + ] = None + nearby_actions: Annotated[ + list[TraceNearbyAction] | None, + Field( + alias="nearbyActions", + description="Actions around the failure, teardown labelled", + ), + ] = None + entry_points: Annotated[ + list[TraceEntryPoint] | None, + Field( + alias="entryPoints", description="Four doorways into the downloaded file" + ), + ] = None + + class AuditMetadata(RootModel[MemberRoleChangedMetadata | None]): root: Annotated[ MemberRoleChangedMetadata | None, @@ -7952,12 +8698,13 @@ class CreateMonitorRequest(BaseModel): | McpServerMonitorConfig | ScriptMonitorConfig | TcpMonitorConfig - ) + | None + ) = None frequency_seconds: Annotated[ int | None, Field( alias="frequencySeconds", - description="Check frequency in seconds (10–86400); null defaults to plan minimum (60s on most paid plans)", + description="Check frequency in seconds (10–86400). Null defaults to the plan minimum", ge=10, le=86400, ), @@ -7968,21 +8715,21 @@ class CreateMonitorRequest(BaseModel): regions: Annotated[ list[str] | None, Field( - description="Probe regions to run checks from. Allowed values are deployment-dependent; production: us-east, us-west, eu-west, ap-south." + description="Probe regions to run checks from. Allowed values are deployment-dependent. Production: us-east, us-west, eu-west, ap-south" ), ] = None managed_by: Annotated[ ManagedBy | None, Field( alias="managedBy", - 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.", + description="Source that created this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API", ), ] = None environment_id: Annotated[ UUID | None, Field( alias="environmentId", - description="Environment to associate with this monitor", + description="Environment to associate with this monitor. Required for browser and multi-step monitors", ), ] = None assertions: Annotated[ @@ -8001,10 +8748,28 @@ class CreateMonitorRequest(BaseModel): ), ] = None tags: AddMonitorTagsRequest | None = None - - -class CreateResourceGroupRequest(BaseModel): - model_config = ConfigDict(extra="forbid", populate_by_name=True) + capture_policy: Annotated[CapturePolicy | None, Field(alias="capturePolicy")] = None + fast_retry_max_attempts: Annotated[ + int | None, + Field( + alias="fastRetryMaxAttempts", + description="Fast-retry attempts after failure. Null or 0 disables", + ge=0, + le=10, + ), + ] = None + definition_id: Annotated[ + UUID | None, + Field( + alias="definitionId", + description="Existing definition to reuse for a sibling monitor", + ), + ] = None + package: MonitorPackageSpec | None = None + + +class CreateResourceGroupRequest(BaseModel): + model_config = ConfigDict(extra="forbid", populate_by_name=True) name: Annotated[ str, Field( @@ -8192,6 +8957,26 @@ class CreditPolicy(BaseModel): ] = None +class CursorPageNotificationDispatchDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: Annotated[ + list[NotificationDispatchDto], Field(description="Items on this page") + ] + next_cursor: Annotated[ + str | None, + Field( + alias="nextCursor", + description="Opaque cursor for the next page; null when there are no more results", + ), + ] = None + has_more: Annotated[ + bool, + Field( + alias="hasMore", description="Whether more results exist beyond this page" + ), + ] + + class CursorPageServiceCatalogDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) data: Annotated[list[ServiceCatalogDto], Field(description="Items on this page")] @@ -8252,6 +9037,26 @@ class DashboardOverviewDto(BaseModel): incidents: IncidentsSummaryDto +class DefinitionHeadDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + definition_id: Annotated[ + UUID, Field(alias="definitionId", description="Definition this Head belongs to") + ] + environment: EnvironmentDto + revision: RevisionDto + activated_at: Annotated[ + AwareDatetime, + Field(alias="activatedAt", description="When this Head last activated"), + ] + activated_by: Annotated[ + str | None, + Field(alias="activatedBy", description="Who last activated this Head"), + ] = None + reason: Annotated[ + str | None, Field(description="Rollback reason when this Head was restored") + ] = None + + class EscalationChain(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) steps: Annotated[ @@ -8922,9 +9727,69 @@ class MonitorDto(BaseModel): str | None, Field( alias="currentStatus", - description="Current operational state — UP, DOWN, DEGRADED, PAUSED, or UNKNOWN if no probe data yet", + description="Current operational state. One of UP, DOWN, DEGRADED, PAUSED, or UNKNOWN", + ), + ] = None + definition_id: Annotated[ + UUID | None, + Field( + alias="definitionId", + description="Definition id for a browser or multi-step monitor. Null on probe monitors", ), ] = None + capture_policy: Annotated[CapturePolicy | None, Field(alias="capturePolicy")] = None + fast_retry_max_attempts: Annotated[ + int | None, + Field( + alias="fastRetryMaxAttempts", + description="Fast-retry max attempts; null/0 = off", + ), + ] = None + muted: Annotated[bool, Field(description="Whether alert delivery is muted")] + muted_until: Annotated[ + AwareDatetime | None, + Field( + alias="mutedUntil", + description="Mute expiry; null means indefinite while muted", + ), + ] = None + mute_reason: Annotated[ + str | None, Field(alias="muteReason", description="Optional mute reason") + ] = None + paused_at: Annotated[ + AwareDatetime | None, + Field(alias="pausedAt", description="When the monitor was paused"), + ] = None + pause_reason: Annotated[ + str | None, Field(alias="pauseReason", description="Optional pause reason") + ] = None + pause_expires_at: Annotated[ + AwareDatetime | None, Field(alias="pauseExpiresAt", description="Pause expiry") + ] = None + quarantine_owner_id: Annotated[ + str | None, + Field(alias="quarantineOwnerId", description="Quarantine person owner id"), + ] = None + quarantine_until: Annotated[ + AwareDatetime | None, + Field( + alias="quarantineUntil", + description="Quarantine expiry; non-null means quarantined", + ), + ] = None + quarantine_reason: Annotated[ + str | None, Field(alias="quarantineReason", description="Quarantine reason") + ] = None + upload: PackageUploadDto | None = None + + +class MonitorSecretRequestsDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + environment: EnvironmentDto + requests: Annotated[ + list[SecretRequestDto], + Field(description="Secret keys this monitor requires and their resolve state"), + ] class MonitorTestRequest(BaseModel): @@ -9180,6 +10045,295 @@ class ResourceGroupMemberDto(BaseModel): ] = None +class RevisionDiffDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + left: RevisionDto + right: RevisionDto + hunks: Annotated[ + list[RevisionDiffHunkDto], + Field(description="File and field-level hunks (bounded)"), + ] + + +class RollbackPreviewDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + target: RevisionDto + current: DefinitionHeadDto | None = None + affected_monitors: Annotated[ + list[MonitorDto], + Field( + alias="affectedMonitors", + description="Monitors sharing this definition and environment", + ), + ] + + +class RunArtifactDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[UUID, Field(description="Unique artifact identifier")] + organization_id: Annotated[ + int, + Field( + alias="organizationId", description="Organization this artifact belongs to" + ), + ] + run_id: Annotated[ + UUID, Field(alias="runId", description="Run this artifact belongs to") + ] + step_id: Annotated[ + UUID | None, + Field( + alias="stepId", + description="Step this screenshot belongs to; null for whole-run kinds", + ), + ] = None + kind: Annotated[str, Field(description="File kind")] + lifecycle: Annotated[ + str, Field(description="Whether bytes are available, processing, or gone") + ] + capture_reason: Annotated[ + str | None, + Field(alias="captureReason", description="Why this file was captured"), + ] = None + byte_size: Annotated[ + int | None, Field(alias="byteSize", description="Stored size in bytes") + ] = None + content_type: Annotated[ + str | None, + Field(alias="contentType", description="MIME type of the stored file"), + ] = None + duration_ms: Annotated[ + int | None, + Field(alias="durationMs", description="Video duration in milliseconds"), + ] = None + viewport: ArtifactViewport | None = None + expires_at: Annotated[ + AwareDatetime | None, + Field(alias="expiresAt", description="When stored bytes expire"), + ] = None + expected_byte_size: Annotated[ + int | None, + Field( + alias="expectedByteSize", + description="Expected size while a video is encoding", + ), + ] = None + encode_eta_ms: Annotated[ + int | None, + Field( + alias="encodeEtaMs", + description="Estimated remaining encode time in milliseconds", + ), + ] = None + trace_meta: Annotated[ArtifactTraceMeta | None, Field(alias="traceMeta")] = None + created_at: Annotated[ + AwareDatetime, + Field(alias="createdAt", description="When this file row was created"), + ] + + +class RunCaseDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[UUID, Field(description="Case identifier")] + organization_id: Annotated[ + int, + Field(alias="organizationId", description="Organization this case belongs to"), + ] + run_id: Annotated[ + UUID, Field(alias="runId", description="Run this case belongs to") + ] + attempt: Annotated[int, Field(description="Playwright in-case attempt number")] + index: Annotated[int, Field(description="Zero-based case index within the attempt")] + title: Annotated[str, Field(description="Case title")] + file: Annotated[str | None, Field(description="Spec path inside the package")] = ( + None + ) + status: Annotated[str, Field(description="Case status")] + started_at: Annotated[ + AwareDatetime | None, + Field(alias="startedAt", description="When the case started"), + ] = None + finished_at: Annotated[ + AwareDatetime | None, + Field(alias="finishedAt", description="When the case finished"), + ] = None + duration_ms: Annotated[ + int | None, + Field(alias="durationMs", description="Reporter duration in milliseconds"), + ] = None + steps: Annotated[list[RunStepDto], Field(description="Steps on this case")] + + +class RunDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + id: Annotated[UUID, Field(description="Unique run identifier")] + organization_id: Annotated[ + int, + Field(alias="organizationId", description="Organization this run belongs to"), + ] + monitor_id: Annotated[ + UUID, Field(alias="monitorId", description="Monitor this run belongs to") + ] + monitor_name: Annotated[ + str | None, Field(alias="monitorName", description="Monitor display name") + ] = None + monitor_type: Annotated[ + str | None, Field(alias="monitorType", description="Monitor type") + ] = None + host: Annotated[ + str | None, Field(description="Target host from the environment BASE_URL") + ] = None + environment_id: Annotated[ + UUID | None, + Field(alias="environmentId", description="Environment this run executed in"), + ] = None + environment_name: Annotated[ + str | None, + Field(alias="environmentName", description="Environment display name"), + ] = None + revision_id: Annotated[ + UUID, Field(alias="revisionId", description="Revision this run executed") + ] + region: Annotated[str, Field(description="Probe region for this run", min_length=1)] + source: Annotated[str, Field(description="What triggered this run")] + enqueued_at: Annotated[ + AwareDatetime, + Field(alias="enqueuedAt", description="When this run was enqueued"), + ] + evaluation_cycle_id: Annotated[ + UUID | None, + Field( + alias="evaluationCycleId", + description="Evaluation cycle grouping this run with retries", + ), + ] = None + retry_of_run_id: Annotated[ + UUID | None, + Field(alias="retryOfRunId", description="Parent run when this is a fast retry"), + ] = None + retried_from_run_id: Annotated[ + UUID | None, + Field(alias="retriedFromRunId", description="Fast-retry parent run"), + ] = None + phase: Annotated[str, Field(description="Current run phase")] + cancel_requested: Annotated[ + bool, Field(alias="cancelRequested", description="Whether cancel was requested") + ] + outcome: Annotated[ + str | None, Field(description="Outcome; null until the run is finished") + ] = None + headline: Annotated[str | None, Field(description="Last control headline")] = None + execution_line: Annotated[ + str | None, Field(alias="executionLine", description="Live execution one-liner") + ] = None + meta_line: Annotated[ + str | None, + Field(alias="metaLine", description="Server-composed header meta line"), + ] = None + bundle_digest: Annotated[ + str, + Field( + alias="bundleDigest", + description="Package digest frozen at create", + min_length=1, + ), + ] + started_at: Annotated[ + AwareDatetime | None, + Field(alias="startedAt", description="When execution claimed a seat"), + ] = None + finished_at: Annotated[ + AwareDatetime | None, + Field(alias="finishedAt", description="When the run finished"), + ] = None + updated_at: Annotated[ + AwareDatetime | None, + Field(alias="updatedAt", description="When the run row last changed"), + ] = None + last_heartbeat_at: Annotated[ + AwareDatetime | None, + Field(alias="lastHeartbeatAt", description="Last supervisor heartbeat"), + ] = None + cancelled_by: Annotated[ + str | None, Field(alias="cancelledBy", description="Who requested cancel") + ] = None + artifacts_expired_at: Annotated[ + AwareDatetime | None, + Field(alias="artifactsExpiredAt", description="When artifact bytes expired"), + ] = None + capture_policy_snapshot: Annotated[ + dict[str, dict[str, Any]], + Field( + alias="capturePolicySnapshot", + description="Capture settings frozen at create", + ), + ] + binding_version_snapshot: Annotated[ + dict[str, dict[str, Any]], + Field( + alias="bindingVersionSnapshot", + description="Resolved secret key names frozen at create", + ), + ] + duration_ms: Annotated[ + int | None, + Field(alias="durationMs", description="Wall time from claim to finish"), + ] = None + queue_wait_ms: Annotated[ + int | None, + Field(alias="queueWaitMs", description="Time spent waiting for a seat"), + ] = None + queue_position: Annotated[ + int | None, + Field( + alias="queuePosition", + description="Live queue position; null when not queued", + ), + ] = None + heartbeat_age_ms: Annotated[ + int | None, + Field( + alias="heartbeatAgeMs", + description="Milliseconds since the last supervisor heartbeat", + ), + ] = None + stream: Annotated[ + bool, + Field(description="True while the run is still live and clients may stream"), + ] + evidence: Annotated[ + list[RunEvidenceDto], + Field(description="List evidence chips in SHOT → TRACE → VIDEO → NET order"), + ] + tab_counts: Annotated[RunTabCountsDto, Field(alias="tabCounts")] + live: RunLiveDto | None = None + attempt: Annotated[int, Field(description="Selected in-check attempt (1-based)")] + attempt_of: Annotated[ + int, Field(alias="attemptOf", description="In-check attempt count") + ] + attempts: Annotated[list[RunAttemptDto], Field(description="In-check attempts")] + incident_id: Annotated[ + UUID | None, + Field(alias="incidentId", description="Open incident for this monitor"), + ] = None + + +class SecretAuditDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + updated_at: Annotated[ + AwareDatetime | None, + Field(alias="updatedAt", description="When this secret was last updated"), + ] = None + updated_by: Annotated[UserDto | None, Field(alias="updatedBy")] = None + + +class SecretUsageDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + monitors: Annotated[ + list[MonitorDto], Field(description="Monitors that reference this secret") + ] + + class ServiceIncidentDetailDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) id: UUID @@ -9244,6 +10398,11 @@ class SingleValueResponseDashboardOverviewDto(BaseModel): data: DashboardOverviewDto +class SingleValueResponseDefinitionHeadDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: DefinitionHeadDto + + class SingleValueResponseGlobalStatusSummaryDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) data: GlobalStatusSummaryDto @@ -9269,6 +10428,11 @@ class SingleValueResponseMonitorDto(BaseModel): data: MonitorDto +class SingleValueResponseMonitorSecretRequestsDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: MonitorSecretRequestsDto + + class SingleValueResponseMonitorVersionDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) data: MonitorVersionDto @@ -9284,6 +10448,31 @@ class SingleValueResponseResourceGroupMemberDto(BaseModel): data: ResourceGroupMemberDto +class SingleValueResponseRevisionDiffDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: RevisionDiffDto + + +class SingleValueResponseRollbackPreviewDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: RollbackPreviewDto + + +class SingleValueResponseRunDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: RunDto + + +class SingleValueResponseSecretAuditDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: SecretAuditDto + + +class SingleValueResponseSecretUsageDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: SecretUsageDto + + class SingleValueResponseServiceIncidentDetailDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) data: ServiceIncidentDetailDto @@ -9503,7 +10692,6 @@ class TableValueResultComponentUptimeDayDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultIncidentDto(BaseModel): @@ -9513,7 +10701,6 @@ class TableValueResultIncidentDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultIncidentStateTransitionDto(BaseModel): @@ -9523,7 +10710,6 @@ class TableValueResultIncidentStateTransitionDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultIntegrationDto(BaseModel): @@ -9533,7 +10719,6 @@ class TableValueResultIntegrationDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultMonitorDto(BaseModel): @@ -9543,7 +10728,6 @@ class TableValueResultMonitorDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultMonitorVersionDto(BaseModel): @@ -9553,7 +10737,6 @@ class TableValueResultMonitorVersionDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultNotificationPolicyDto(BaseModel): @@ -9563,7 +10746,33 @@ class TableValueResultNotificationPolicyDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None + + +class TableValueResultRunArtifactDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: list[RunArtifactDto] + has_next: Annotated[bool, Field(alias="hasNext")] + has_prev: Annotated[bool, Field(alias="hasPrev")] + total_elements: Annotated[int | None, Field(alias="totalElements")] = None + total_pages: Annotated[int | None, Field(alias="totalPages")] = None + + +class TableValueResultRunCaseDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: list[RunCaseDto] + has_next: Annotated[bool, Field(alias="hasNext")] + has_prev: Annotated[bool, Field(alias="hasPrev")] + total_elements: Annotated[int | None, Field(alias="totalElements")] = None + total_pages: Annotated[int | None, Field(alias="totalPages")] = None + + +class TableValueResultRunDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: list[RunDto] + has_next: Annotated[bool, Field(alias="hasNext")] + has_prev: Annotated[bool, Field(alias="hasPrev")] + total_elements: Annotated[int | None, Field(alias="totalElements")] = None + total_pages: Annotated[int | None, Field(alias="totalPages")] = None class TableValueResultStatusPageDto(BaseModel): @@ -9573,7 +10782,6 @@ class TableValueResultStatusPageDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultStatusPageIncidentDto(BaseModel): @@ -9583,7 +10791,6 @@ class TableValueResultStatusPageIncidentDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultTagDto(BaseModel): @@ -9593,7 +10800,6 @@ class TableValueResultTagDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultTestChannelResult(BaseModel): @@ -9603,7 +10809,6 @@ class TableValueResultTestChannelResult(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultVoiceLanguageDto(BaseModel): @@ -9613,7 +10818,6 @@ class TableValueResultVoiceLanguageDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultWebhookDeliveryDto(BaseModel): @@ -9623,7 +10827,6 @@ class TableValueResultWebhookDeliveryDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultWebhookEndpointDto(BaseModel): @@ -9633,7 +10836,6 @@ class TableValueResultWebhookEndpointDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultWorkspaceDto(BaseModel): @@ -9643,7 +10845,6 @@ class TableValueResultWorkspaceDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TestAlertChannelRequest(BaseModel): @@ -9730,7 +10931,7 @@ class UpdateMonitorRequest(BaseModel): name: Annotated[ str | None, Field( - description="New monitor name; null preserves current", + description="New monitor name. Null preserves current", max_length=255, min_length=0, ), @@ -9749,33 +10950,34 @@ class UpdateMonitorRequest(BaseModel): int | None, Field( alias="frequencySeconds", - description="New check frequency in seconds (10–86400); null preserves current", + description="New check frequency in seconds (10–86400). Null preserves current", ge=10, le=86400, ), ] = None enabled: Annotated[ bool | None, - Field(description="Enable or disable the monitor; null preserves current"), + Field( + description="Enable or disable the monitor (pause or resume). Null preserves current" + ), ] = None regions: Annotated[ list[str] | None, Field( - description="New probe regions; null preserves current. Allowed values are deployment-dependent." + description="New probe regions. Null preserves current. Allowed values are deployment-dependent" ), ] = None managed_by: Annotated[ ManagedBy | None, Field( alias="managedBy", - 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", ), ] = None environment_id: Annotated[ UUID | None, Field( - alias="environmentId", - description="New environment ID; null preserves current (use clearEnvironmentId to unset)", + alias="environmentId", description="New environment; null preserves current" ), ] = None clear_environment_id: Annotated[ @@ -9787,7 +10989,7 @@ class UpdateMonitorRequest(BaseModel): ] = None assertions: Annotated[ list[CreateAssertionRequest] | None, - Field(description="Replace all assertions; null preserves current"), + Field(description="Replace all assertions. Null preserves current"), ] = None auth: MonitorAuthConfig | None = None clear_auth: Annotated[ @@ -9801,10 +11003,24 @@ class UpdateMonitorRequest(BaseModel): list[UUID] | None, Field( alias="alertChannelIds", - description="Replace alert channel list; null preserves current", + description="Replace alert channel list. Null preserves current", ), ] = None tags: AddMonitorTagsRequest | None = None + capture_policy: Annotated[CapturePolicy | None, Field(alias="capturePolicy")] = None + fast_retry_max_attempts: Annotated[ + int | None, + Field( + alias="fastRetryMaxAttempts", + description="Fast-retry attempts after failure. Null preserves current. 0 disables", + ge=0, + le=10, + ), + ] = None + package: MonitorPackageSpec | None = None + status: Annotated[ + str | None, Field(description="Not writable; use pause or resume") + ] = None class UpdateNotificationPolicyRequest(BaseModel): @@ -9990,6 +11206,32 @@ class CursorPageIncidentActivityEventDto(BaseModel): ] +class CursorPageRunDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: Annotated[list[RunDto], Field(description="Items on this page")] + next_cursor: Annotated[ + str | None, + Field( + alias="nextCursor", + description="Opaque cursor for the next page; null when there are no more results", + ), + ] = None + has_more: Annotated[ + bool, + Field( + alias="hasMore", description="Whether more results exist beyond this page" + ), + ] + + +class DefinitionDetailDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + definition: DefinitionDto + heads: Annotated[ + list[DefinitionHeadDto], Field(description="Active Heads per environment") + ] + + class IncidentDetailDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) incident: IncidentDto @@ -10177,6 +11419,11 @@ class SingleValueResponseCheckTraceDto(BaseModel): data: CheckTraceDto +class SingleValueResponseDefinitionDetailDto(BaseModel): + model_config = ConfigDict(extra="ignore", populate_by_name=True) + data: DefinitionDetailDto + + class SingleValueResponseIncidentDetailDto(BaseModel): model_config = ConfigDict(extra="ignore", populate_by_name=True) data: IncidentDetailDto @@ -10214,7 +11461,6 @@ class TableValueResultAuditEventDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class TableValueResultResourceGroupDto(BaseModel): @@ -10224,7 +11470,6 @@ class TableValueResultResourceGroupDto(BaseModel): has_prev: Annotated[bool, Field(alias="hasPrev")] total_elements: Annotated[int | None, Field(alias="totalElements")] = None total_pages: Annotated[int | None, Field(alias="totalPages")] = None - next_cursor: Annotated[str | None, Field(alias="nextCursor")] = None class CheckResultDetailsDto(BaseModel):