{ "openapi": "3.1.0", "info": { "title": "Incido", "description": "This API allows to interact with the Incido service.\n\nThe API uses the HTTP Bearer authentication scheme: send the header `Authorization: Bearer ` on each request, unless the operation explicitly declares no security (see that operation's `security` in this document).", "contact": { "name": "", "url": "", "email": "" }, "license": { "name": "", "url": "" }, "version": "1.0.0" }, "servers": [ { "url": "https://api.incido.app", "description": "Incido" } ], "paths": { "/organizations/{organization_id}/components": { "get": { "operationId": "list_components", "tags": [ "Components" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "components collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/components" } } }, "application/ld+json": { "schema": { "type": "object", "description": "components.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/components.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Components", "description": "Retrieves a list of components for the organization.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_component", "tags": [ "Components" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "components resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/components" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/components.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Component", "description": "Creates a new component scoped to the organization. The key must be unique among components in that organization.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new components resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/components.CreateComponentData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/components.CreateComponentData" } } }, "required": true } } }, "/organizations/{organization_id}/components/{id}": { "get": { "operationId": "get_component", "tags": [ "Components" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "components resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/components" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/components.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Component", "description": "Retrieves a single component by public identifier within the organization.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Component identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^cmp_[0-9a-f]{32}$", "description": "Component identifier.", "example": "cmp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_component", "tags": [ "Components" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "components resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Component", "description": "Deletes a component when it is not referenced by status pages or monitors.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Component identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^cmp_[0-9a-f]{32}$", "description": "Component identifier.", "example": "cmp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_component", "tags": [ "Components" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "components resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/components" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/components.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Component", "description": "Partially updates a component. Omitted fields are left unchanged.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Component identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^cmp_[0-9a-f]{32}$", "description": "Component identifier.", "example": "cmp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated components resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/components.UpdateComponentData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/incident-status-transitions": { "get": { "operationId": "list_incident_status_transitions", "tags": [ "Incident Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incident-status-transitions collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/incident-status-transitions" } } }, "application/ld+json": { "schema": { "type": "object", "description": "incident-status-transitions.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/incident-status-transitions.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Incident Status Transitions", "description": "Retrieves a list of incident status transitions.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "transition_key", "in": "query", "description": "incident-status-transitions transition_key", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "from_status_id", "in": "query", "description": "incident-status-transitions from_status_id", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "to_status_id", "in": "query", "description": "incident-status-transitions to_status_id", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "is_enabled", "in": "query", "description": "incident-status-transitions is_enabled", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "is_primary", "in": "query", "description": "incident-status-transitions is_primary", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_incident_status_transition", "tags": [ "Incident Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "incident-status-transitions resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Incident Status Transition", "description": "Creates a new incident status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new incident-status-transitions resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions.CreateIncidentStatusTransitionData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions.CreateIncidentStatusTransitionData" } } }, "required": true } } }, "/organizations/{organization_id}/incident-status-transitions/{id}": { "get": { "operationId": "get_incident_status_transition", "tags": [ "Incident Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incident-status-transitions resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Incident Status Transition", "description": "Retrieves an incident status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident status transition identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^itr_[0-9a-f]{32}$", "description": "Incident status transition identifier.", "example": "itr_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_incident_status_transition", "tags": [ "Incident Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "incident-status-transitions resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Incident Status Transition", "description": "Deletes an incident status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident status transition identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^itr_[0-9a-f]{32}$", "description": "Incident status transition identifier.", "example": "itr_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_incident_status_transition", "tags": [ "Incident Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incident-status-transitions resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Incident Status Transition", "description": "Updates an incident status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident status transition identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^itr_[0-9a-f]{32}$", "description": "Incident status transition identifier.", "example": "itr_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated incident-status-transitions resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/incident-status-transitions.UpdateIncidentStatusTransitionData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/incident-statuses": { "get": { "operationId": "list_incident_statuses", "tags": [ "Incident Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incident-statuses collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/incident-statuses" } } }, "application/ld+json": { "schema": { "type": "object", "description": "incident-statuses.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/incident-statuses.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Incident Statuses", "description": "Retrieves a list of incident statuses.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "status_key", "in": "query", "description": "incident-statuses status_key", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "stage", "in": "query", "description": "incident-statuses stage", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_incident_status", "tags": [ "Incident Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "incident-statuses resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incident-statuses" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incident-statuses.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Incident Status", "description": "Creates a new incident status.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new incident-statuses resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incident-statuses.CreateIncidentStatusData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incident-statuses.CreateIncidentStatusData" } } }, "required": true } } }, "/organizations/{organization_id}/incident-statuses/{id}": { "get": { "operationId": "get_incident_status", "tags": [ "Incident Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incident-statuses resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incident-statuses" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incident-statuses.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Incident Status", "description": "Retrieves an incident status.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident status identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^ist_[0-9a-f]{32}$", "description": "Incident status identifier.", "example": "ist_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_incident_status", "tags": [ "Incident Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "incident-statuses resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Incident Status", "description": "Deletes an incident status.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident status identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^ist_[0-9a-f]{32}$", "description": "Incident status identifier.", "example": "ist_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_incident_status", "tags": [ "Incident Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incident-statuses resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incident-statuses" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incident-statuses.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Incident Status", "description": "Updates an incident status.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident status identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^ist_[0-9a-f]{32}$", "description": "Incident status identifier.", "example": "ist_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated incident-statuses resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/incident-statuses.UpdateIncidentStatusData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/incidents": { "get": { "operationId": "list_incidents", "tags": [ "Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incidents collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/incidents" } } }, "application/ld+json": { "schema": { "type": "object", "description": "incidents.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/incidents.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Incidents", "description": "Retrieves a list of incidents.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "status_id", "in": "query", "description": "incidents status_id", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_incident", "tags": [ "Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "incidents resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidents" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incidents.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Incident", "description": "Creates a new incident.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new incidents resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidents.CreateIncidentData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incidents.CreateIncidentData" } } }, "required": true } } }, "/organizations/{organization_id}/incidents/{id}": { "get": { "operationId": "get_incident", "tags": [ "Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incidents resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidents" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incidents.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Incident", "description": "Retrieves an incident.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^inc_[0-9a-f]{32}$", "description": "Incident identifier.", "example": "inc_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_incident", "tags": [ "Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "incidents resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidents" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incidents.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Incident", "description": "Updates an incident.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^inc_[0-9a-f]{32}$", "description": "Incident identifier.", "example": "inc_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated incidents resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/incidents.UpdateIncidentData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/incidents/{id}/updates": { "post": { "operationId": "create_incident_update", "tags": [ "Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "incidents resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidents" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incidents.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Incident Update", "description": "Creates an incident update with optional status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Incident identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^inc_[0-9a-f]{32}$", "description": "Incident identifier.", "example": "inc_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new incidents resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidents.CreateIncidentUpdateData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/incidents.CreateIncidentUpdateData" } } }, "required": true } } }, "/organizations/{organization_id}/maintenance-status-transitions": { "get": { "operationId": "list_maintenance_status_transitions", "tags": [ "Maintenance Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenance-status-transitions collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/maintenance-status-transitions" } } }, "application/ld+json": { "schema": { "type": "object", "description": "maintenance-status-transitions.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/maintenance-status-transitions.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Maintenance Status Transitions", "description": "Retrieves a list of maintenance status transitions.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "transition_key", "in": "query", "description": "maintenance-status-transitions transition_key", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "from_status_id", "in": "query", "description": "maintenance-status-transitions from_status_id", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "to_status_id", "in": "query", "description": "maintenance-status-transitions to_status_id", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "is_enabled", "in": "query", "description": "maintenance-status-transitions is_enabled", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "is_primary", "in": "query", "description": "maintenance-status-transitions is_primary", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_maintenance_status_transition", "tags": [ "Maintenance Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "maintenance-status-transitions resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Maintenance Status Transition", "description": "Creates a new maintenance status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new maintenance-status-transitions resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions.CreateMaintenanceStatusTransitionData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions.CreateMaintenanceStatusTransitionData" } } }, "required": true } } }, "/organizations/{organization_id}/maintenance-status-transitions/{id}": { "get": { "operationId": "get_maintenance_status_transition", "tags": [ "Maintenance Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenance-status-transitions resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Maintenance Status Transition", "description": "Retrieves a maintenance status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance status transition identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mtr_[0-9a-f]{32}$", "description": "Maintenance status transition identifier.", "example": "mtr_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_maintenance_status_transition", "tags": [ "Maintenance Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "maintenance-status-transitions resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Maintenance Status Transition", "description": "Deletes a maintenance status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance status transition identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mtr_[0-9a-f]{32}$", "description": "Maintenance status transition identifier.", "example": "mtr_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_maintenance_status_transition", "tags": [ "Maintenance Status Transitions" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenance-status-transitions resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Maintenance Status Transition", "description": "Updates a maintenance status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance status transition identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mtr_[0-9a-f]{32}$", "description": "Maintenance status transition identifier.", "example": "mtr_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated maintenance-status-transitions resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/maintenance-status-transitions.UpdateMaintenanceStatusTransitionData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/maintenance-statuses": { "get": { "operationId": "list_maintenance_statuses", "tags": [ "Maintenance Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenance-statuses collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/maintenance-statuses" } } }, "application/ld+json": { "schema": { "type": "object", "description": "maintenance-statuses.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/maintenance-statuses.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Maintenance Statuses", "description": "Retrieves a list of maintenance statuses.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "status_key", "in": "query", "description": "maintenance-statuses status_key", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "stage", "in": "query", "description": "maintenance-statuses stage", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_maintenance_status", "tags": [ "Maintenance Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "maintenance-statuses resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Maintenance Status", "description": "Creates a new maintenance status.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new maintenance-statuses resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses.CreateMaintenanceStatusData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses.CreateMaintenanceStatusData" } } }, "required": true } } }, "/organizations/{organization_id}/maintenance-statuses/{id}": { "get": { "operationId": "get_maintenance_status", "tags": [ "Maintenance Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenance-statuses resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Maintenance Status", "description": "Retrieves a maintenance status.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance status identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mst_[0-9a-f]{32}$", "description": "Maintenance status identifier.", "example": "mst_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_maintenance_status", "tags": [ "Maintenance Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "maintenance-statuses resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Maintenance Status", "description": "Deletes a maintenance status.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance status identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mst_[0-9a-f]{32}$", "description": "Maintenance status identifier.", "example": "mst_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_maintenance_status", "tags": [ "Maintenance Statuses" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenance-statuses resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Maintenance Status", "description": "Updates a maintenance status.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance status identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mst_[0-9a-f]{32}$", "description": "Maintenance status identifier.", "example": "mst_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated maintenance-statuses resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/maintenance-statuses.UpdateMaintenanceStatusData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/maintenances": { "get": { "operationId": "list_maintenances", "tags": [ "Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenances collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/maintenances" } } }, "application/ld+json": { "schema": { "type": "object", "description": "maintenances.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/maintenances.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Maintenances", "description": "Retrieves a list of maintenances.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "status_id", "in": "query", "description": "maintenances status_id", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_maintenance", "tags": [ "Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "maintenances resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenances.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Maintenance", "description": "Creates a new maintenance.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new maintenances resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenances.CreateMaintenanceData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenances.CreateMaintenanceData" } } }, "required": true } } }, "/organizations/{organization_id}/maintenances/{id}": { "get": { "operationId": "get_maintenance", "tags": [ "Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenances resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenances.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Maintenance", "description": "Retrieves a maintenance.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mnt_[0-9a-f]{32}$", "description": "Maintenance identifier.", "example": "mnt_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_maintenance", "tags": [ "Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "maintenances resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenances.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Maintenance", "description": "Updates a maintenance.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mnt_[0-9a-f]{32}$", "description": "Maintenance identifier.", "example": "mnt_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated maintenances resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/maintenances.UpdateMaintenanceData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/maintenances/{id}/affected-components": { "post": { "operationId": "update_maintenance_affected_component", "tags": [ "Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "maintenances resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenances.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Maintenance Affected Component", "description": "Updates one affected component of a maintenance.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mnt_[0-9a-f]{32}$", "description": "Maintenance identifier.", "example": "mnt_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new maintenances resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenances.UpdateMaintenanceAffectedComponentData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenances.UpdateMaintenanceAffectedComponentData" } } }, "required": true } } }, "/organizations/{organization_id}/maintenances/{id}/updates": { "post": { "operationId": "create_maintenance_update", "tags": [ "Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "maintenances resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenances.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Maintenance Update", "description": "Creates a maintenance update with optional status transition.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Maintenance identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mnt_[0-9a-f]{32}$", "description": "Maintenance identifier.", "example": "mnt_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new maintenances resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/maintenances.CreateMaintenanceStatusUpdateData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/maintenances.CreateMaintenanceStatusUpdateData" } } }, "required": true } } }, "/organizations/{organization_id}/monitor-correlation-groups": { "get": { "operationId": "list_monitor_correlation_groups", "tags": [ "Monitor Correlation Groups" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "monitor-correlation-groups collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/monitor-correlation-groups" } } }, "application/ld+json": { "schema": { "type": "object", "description": "monitor-correlation-groups.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/monitor-correlation-groups.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Monitor Correlation Groups", "description": "Retrieves a list of monitor correlation groups.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "is_enabled", "in": "query", "description": "monitor-correlation-groups is_enabled", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_monitor_correlation_group", "tags": [ "Monitor Correlation Groups" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "monitor-correlation-groups resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Monitor Correlation Group", "description": "Creates a new monitor correlation group.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new monitor-correlation-groups resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups.CreateMonitorCorrelationGroupData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups.CreateMonitorCorrelationGroupData" } } }, "required": true } } }, "/organizations/{organization_id}/monitor-correlation-groups/{id}": { "get": { "operationId": "get_monitor_correlation_group", "tags": [ "Monitor Correlation Groups" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "monitor-correlation-groups resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Monitor Correlation Group", "description": "Retrieves a monitor correlation group.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Monitor correlation group identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mcg_[0-9a-f]{32}$", "description": "Monitor correlation group identifier.", "example": "mcg_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_monitor_correlation_group", "tags": [ "Monitor Correlation Groups" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "monitor-correlation-groups resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Monitor Correlation Group", "description": "Deletes a monitor correlation group.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Monitor correlation group identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mcg_[0-9a-f]{32}$", "description": "Monitor correlation group identifier.", "example": "mcg_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_monitor_correlation_group", "tags": [ "Monitor Correlation Groups" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "monitor-correlation-groups resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Monitor Correlation Group", "description": "Updates a monitor correlation group.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Monitor correlation group identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mcg_[0-9a-f]{32}$", "description": "Monitor correlation group identifier.", "example": "mcg_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated monitor-correlation-groups resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/monitor-correlation-groups.UpdateMonitorCorrelationGroupData.jsonMergePatch" } } }, "required": true } } }, "/monitor-types": { "get": { "operationId": "list_monitor_types", "tags": [ "Monitor Types" ], "responses": { "200": { "description": "monitor-types collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/monitor-types" } } }, "application/ld+json": { "schema": { "type": "object", "description": "monitor-types.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/monitor-types.jsonld" } } } } ] } } } } }, "summary": "List Monitor Types", "description": "Retrieves a list of monitor types.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false } ], "security": [] } }, "/monitor-types/{id}": { "get": { "operationId": "get_monitor_type", "tags": [ "Monitor Types" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "monitor-types resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor-types" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitor-types.jsonld" } } } } }, "summary": "Get Monitor Type", "description": "Retrieves a monitor type.", "parameters": [ { "name": "id", "in": "path", "description": "Monitor type identifier (stable key).", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "description": "Monitor type identifier (stable key).", "example": "http", "minLength": 3, "maxLength": 40 }, "style": "simple", "explode": false } ], "security": [] } }, "/organizations/{organization_id}/monitors": { "get": { "operationId": "list_monitors", "tags": [ "Monitors" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "monitors collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/monitors" } } }, "application/ld+json": { "schema": { "type": "object", "description": "monitors.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/monitors.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Monitors", "description": "Retrieves a list of monitors.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "status", "in": "query", "description": "monitors status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "is_enabled", "in": "query", "description": "monitors is_enabled", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "correlation_group_id", "in": "query", "description": "monitors correlation_group_id", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "monitor_key", "in": "query", "description": "monitors monitor_key", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_monitor", "tags": [ "Monitors" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "monitors resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitors" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitors.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Monitor", "description": "Creates a new monitor.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new monitors resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitors.CreateMonitorData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitors.CreateMonitorData" } } }, "required": true } } }, "/organizations/{organization_id}/monitors/{id}": { "get": { "operationId": "get_monitor", "tags": [ "Monitors" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "monitors resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitors" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitors.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Monitor", "description": "Retrieves a monitor.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Monitor identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mon_[0-9a-f]{32}$", "description": "Monitor identifier.", "example": "mon_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_monitor", "tags": [ "Monitors" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "monitors resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Monitor", "description": "Deletes a monitor.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Monitor identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mon_[0-9a-f]{32}$", "description": "Monitor identifier.", "example": "mon_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_monitor", "tags": [ "Monitors" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "monitors resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitors" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/monitors.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Monitor", "description": "Updates a monitor.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Monitor identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mon_[0-9a-f]{32}$", "description": "Monitor identifier.", "example": "mon_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated monitors resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/monitors.UpdateMonitorData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/configuration/exports": { "get": { "operationId": "list_organization_configuration_exports", "tags": [ "Organization Configuration" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "organization_configuration_exports collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/organization_configuration_exports" } } }, "application/ld+json": { "schema": { "type": "object", "description": "organization_configuration_exports.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/organization_configuration_exports.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List organization configuration exports", "description": "Retrieves the collection of organization_configuration_exports resources.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_organization_configuration_export", "tags": [ "Organization Configuration" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "organization_configuration_exports resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization_configuration_exports" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/organization_configuration_exports.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create organization configuration export", "description": "Creates a organization_configuration_exports resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new organization_configuration_exports resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization_configuration_exports.CreateOrganizationConfigExportJobData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/organization_configuration_exports.CreateOrganizationConfigExportJobData" } } }, "required": true } } }, "/organizations/{organization_id}/configuration/exports/{id}": { "get": { "operationId": "get_organization_configuration_export", "tags": [ "Organization Configuration" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "organization_configuration_exports resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization_configuration_exports" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/organization_configuration_exports.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get organization configuration export", "description": "Retrieves a organization_configuration_exports resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Export job identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^oce_[0-9a-f]{32}$", "description": "Export job identifier.", "example": "oce_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/configuration/import-upload-url": { "post": { "operationId": "create_organization_configuration_import_upload_url", "tags": [ "Organization Configuration" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "organization_configuration_imports resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization_configuration_imports.OrganizationConfigImportUploadUrlData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/organization_configuration_imports.OrganizationConfigImportUploadUrlData.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create temporary upload URL for configuration import archive", "description": "Creates a organization_configuration_imports resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/configuration/imports": { "get": { "operationId": "list_organization_configuration_imports", "tags": [ "Organization Configuration" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "organization_configuration_imports collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/organization_configuration_imports" } } }, "application/ld+json": { "schema": { "type": "object", "description": "organization_configuration_imports.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/organization_configuration_imports.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List organization configuration imports", "description": "Retrieves the collection of organization_configuration_imports resources.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_organization_configuration_import", "tags": [ "Organization Configuration" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "organization_configuration_imports resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization_configuration_imports" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/organization_configuration_imports.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create organization configuration import", "description": "Creates a organization_configuration_imports resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new organization_configuration_imports resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization_configuration_imports.CreateOrganizationConfigImportJobData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/organization_configuration_imports.CreateOrganizationConfigImportJobData" } } }, "required": true } } }, "/organizations/{organization_id}/configuration/imports/{id}": { "get": { "operationId": "get_organization_configuration_import", "tags": [ "Organization Configuration" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "organization_configuration_imports resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization_configuration_imports" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/organization_configuration_imports.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get organization configuration import", "description": "Retrieves a organization_configuration_imports resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Import job identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^oci_[0-9a-f]{32}$", "description": "Import job identifier.", "example": "oci_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations": { "get": { "operationId": "list_organizations", "tags": [ "Organizations" ], "responses": { "200": { "description": "organizations collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/organizations" } } }, "application/ld+json": { "schema": { "type": "object", "description": "organizations.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/organizations.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Organizations", "description": "Retrieves a list of organizations.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false } ] } }, "/organizations/{id}": { "get": { "operationId": "get_organization", "tags": [ "Organizations" ], "responses": { "200": { "description": "organizations resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/organizations.jsonld" } } } }, "404": { "description": "Not found", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Organization", "description": "Retrieves an organization.", "parameters": [ { "name": "id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/severity-levels": { "get": { "operationId": "list_severity_levels", "tags": [ "Severity Levels" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "severity-levels collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/severity-levels" } } }, "application/ld+json": { "schema": { "type": "object", "description": "severity-levels.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/severity-levels.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Severity Levels", "description": "Retrieves a list of severity levels.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "severity_level_key", "in": "query", "description": "severity-levels severity_level_key", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_severity_level", "tags": [ "Severity Levels" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "severity-levels resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/severity-levels" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/severity-levels.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Severity Level", "description": "Creates a new severity level.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new severity-levels resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/severity-levels.CreateSeverityLevelData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/severity-levels.CreateSeverityLevelData" } } }, "required": true } } }, "/organizations/{organization_id}/severity-levels/{id}": { "get": { "operationId": "get_severity_level", "tags": [ "Severity Levels" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "severity-levels resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/severity-levels" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/severity-levels.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Severity Level", "description": "Retrieves a severity level.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Severity level identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sev_[0-9a-f]{32}$", "description": "Severity level identifier.", "example": "sev_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_severity_level", "tags": [ "Severity Levels" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "severity-levels resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Severity Level", "description": "Deletes a severity level.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Severity level identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sev_[0-9a-f]{32}$", "description": "Severity level identifier.", "example": "sev_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_severity_level", "tags": [ "Severity Levels" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "severity-levels resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/severity-levels" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/severity-levels.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Severity Level", "description": "Updates a severity level.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Severity level identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sev_[0-9a-f]{32}$", "description": "Severity level identifier.", "example": "sev_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated severity-levels resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/severity-levels.UpdateSeverityLevelData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/status-pages/{status_page_id}/custom-domains": { "get": { "operationId": "list_status_page_custom_domains", "tags": [ "Status Page Custom Domains" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-custom-domains collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/status-page-custom-domains" } } }, "application/ld+json": { "schema": { "type": "object", "description": "status-page-custom-domains.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/status-page-custom-domains.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Custom Domains", "description": "Retrieves the collection of status-page-custom-domains resources.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false } ] }, "post": { "operationId": "request_status_page_custom_domain", "tags": [ "Status Page Custom Domains" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-custom-domains resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-custom-domains" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-custom-domains.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Request Custom Domain", "description": "Creates a status-page-custom-domains resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new status-page-custom-domains resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-custom-domains.RequestStatusPageCustomDomainData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-custom-domains.RequestStatusPageCustomDomainData" } } }, "required": true } } }, "/organizations/{organization_id}/status-pages/{status_page_id}/custom-domains/{id}": { "get": { "operationId": "get_status_page_custom_domain", "tags": [ "Status Page Custom Domains" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-custom-domains resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-custom-domains" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-custom-domains.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Custom Domain", "description": "Retrieves a status-page-custom-domains resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page custom domain identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^scd_[0-9a-f]{32}$", "description": "Status page custom domain identifier.", "example": "scd_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "remove_status_page_custom_domain", "tags": [ "Status Page Custom Domains" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "status-page-custom-domains resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Remove Custom Domain", "description": "Removes the status-page-custom-domains resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page custom domain identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^scd_[0-9a-f]{32}$", "description": "Status page custom domain identifier.", "example": "scd_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/custom-domains/{id}/check": { "post": { "operationId": "check_status_page_custom_domain", "tags": [ "Status Page Custom Domains" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-custom-domains resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-custom-domains" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-custom-domains.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Check Custom Domain Verification", "description": "Creates a status-page-custom-domains resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page custom domain identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^scd_[0-9a-f]{32}$", "description": "Status page custom domain identifier.", "example": "scd_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/incidents": { "get": { "operationId": "list_status_page_incidents", "tags": [ "Status Page Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-incidents collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/status-page-incidents" } } }, "application/ld+json": { "schema": { "type": "object", "description": "status-page-incidents.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/status-page-incidents.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Status Page Incidents", "description": "Retrieves a list of incidents linked to a status page.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "is_published", "in": "query", "description": "status-page-incidents is_published", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/incidents/{id}": { "get": { "operationId": "get_status_page_incident_link", "tags": [ "Status Page Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-incidents resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-incidents" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-incidents.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Status Page Incident", "description": "Retrieves a status-page-incidents resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page incident identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sil_[0-9a-f]{32}$", "description": "Status page incident link identifier.", "example": "sil_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/incidents/{id}/republish": { "post": { "operationId": "republish_status_page_incident", "tags": [ "Status Page Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-incidents resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-incidents" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-incidents.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Republish Incident to Status Page", "description": "Publishes an incident again on the status page without informing the subscribers.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page incident identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sil_[0-9a-f]{32}$", "description": "Status page incident link identifier.", "example": "sil_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/incidents/{id}/unpublish": { "post": { "operationId": "unpublish_status_page_incident", "tags": [ "Status Page Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-incidents resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-incidents" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-incidents.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Unpublish Incident from Status Page", "description": "Unpublishes an incident from the status page. The subscribers will not be notified.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page incident identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sil_[0-9a-f]{32}$", "description": "Status page incident link identifier.", "example": "sil_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/incidents/{incident_id}/publish": { "post": { "operationId": "publish_status_page_incident", "tags": [ "Status Page Incidents" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-incidents resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-incidents" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-incidents.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Publish Incident to Status Page", "description": "Publishes an incident on the status page and informs the subscribers.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "incident_id", "in": "path", "description": "Incident identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^inc_[0-9a-f]{32}$", "description": "Incident identifier.", "example": "inc_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/maintenances": { "get": { "operationId": "list_status_page_maintenances", "tags": [ "Status Page Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-maintenances collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/status-page-maintenances" } } }, "application/ld+json": { "schema": { "type": "object", "description": "status-page-maintenances.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/status-page-maintenances.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Status Page Maintenances", "description": "Retrieves a list of maintenances linked to a status page.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "is_published", "in": "query", "description": "status-page-maintenances is_published", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/maintenances/{id}": { "get": { "operationId": "get_status_page_maintenance_link", "tags": [ "Status Page Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-maintenances resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-maintenances.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Status Page Maintenance", "description": "Retrieves a status-page-maintenances resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page maintenance identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sml_[0-9a-f]{32}$", "description": "Status page maintenance link identifier.", "example": "sml_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/maintenances/{id}/republish": { "post": { "operationId": "republish_status_page_maintenance", "tags": [ "Status Page Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-maintenances resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-maintenances.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Republish Maintenance to Status Page", "description": "Publishes a maintenance again on the status page without informing the subscribers.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page maintenance identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sml_[0-9a-f]{32}$", "description": "Status page maintenance link identifier.", "example": "sml_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/maintenances/{id}/unpublish": { "post": { "operationId": "unpublish_status_page_maintenance", "tags": [ "Status Page Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-maintenances resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-maintenances.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Unpublish Maintenance from Status Page", "description": "Unpublishes a maintenance from the status page. The subscribers will not be notified.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page maintenance identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sml_[0-9a-f]{32}$", "description": "Status page maintenance link identifier.", "example": "sml_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-pages/{status_page_id}/maintenances/{maintenance_id}/publish": { "post": { "operationId": "publish_status_page_maintenance", "tags": [ "Status Page Maintenances" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-maintenances resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-maintenances" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-maintenances.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Publish Maintenance to Status Page", "description": "Publishes a maintenance on the status page and informs the subscribers.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "status_page_id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "maintenance_id", "in": "path", "description": "Maintenance identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^mnt_[0-9a-f]{32}$", "description": "Maintenance identifier.", "example": "mnt_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/status-page-subscribers": { "get": { "operationId": "list_status_page_subscribers", "tags": [ "Status Page Subscribers" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-subscribers collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/status-page-subscribers" } } }, "application/ld+json": { "schema": { "type": "object", "description": "status-page-subscribers.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/status-page-subscribers.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Status Page Subscribers", "description": "Retrieves status page subscribers for the organization. The collection supports partial email search, exact filters for status and subscription type, optional status-page filtering, and soft-delete visibility via the trashed query parameter.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "email", "in": "query", "description": "Partial case-insensitive match on subscriber email.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "status", "in": "query", "description": "Filter by subscriber lifecycle status.", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "unverified", "active", "suppressed", "unsubscribed" ] }, "style": "form", "explode": false }, { "name": "subscription_type", "in": "query", "description": "Filter by subscription type preference.", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "all", "incidents", "maintenances" ] }, "style": "form", "explode": false }, { "name": "status_page_id", "in": "query", "description": "Filter subscribers to a specific status page.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "trashed", "in": "query", "description": "Controls soft-deleted row visibility. Use `without` (default), `with`, or `only`.", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "without", "with", "only" ] }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_status_page_subscriber", "tags": [ "Status Page Subscribers" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-page-subscribers resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Status Page Subscriber", "description": "Creates or reuses a status page subscriber through the same service flow as the dashboard, including verification email, throttling, duplicate handling, and silent suppression behavior.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new status-page-subscribers resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers.CreateStatusPageSubscriberData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers.CreateStatusPageSubscriberData" } } }, "required": true } } }, "/organizations/{organization_id}/status-page-subscribers/{id}": { "get": { "operationId": "get_status_page_subscriber", "tags": [ "Status Page Subscribers" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-subscribers resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Status Page Subscriber", "description": "Retrieves a single subscriber within the organization, including soft-deleted subscribers.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page subscriber identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sps_[0-9a-f]{32}$" }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_status_page_subscriber", "tags": [ "Status Page Subscribers" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "status-page-subscribers resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Status Page Subscriber", "description": "Soft-deletes a subscriber. Deleting an already deleted subscriber is a no-op.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page subscriber identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sps_[0-9a-f]{32}$" }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_status_page_subscriber", "tags": [ "Status Page Subscribers" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-page-subscribers resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Status Page Subscriber", "description": "Partially updates an active or inactive subscriber. Email changes use the pending-change confirmation flow and may send a verification email to the new address.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page subscriber identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^sps_[0-9a-f]{32}$" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated status-page-subscribers resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/status-page-subscribers.UpdateStatusPageSubscriberData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/status-pages": { "get": { "operationId": "list_status_pages", "tags": [ "Status Pages" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-pages collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/status-pages" } } }, "application/ld+json": { "schema": { "type": "object", "description": "status-pages.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/status-pages.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Status Pages", "description": "Retrieves the collection of status-pages resources.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false }, { "name": "is_enabled", "in": "query", "description": "status-pages is_enabled", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ] }, "post": { "operationId": "create_status_page", "tags": [ "Status Pages" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "201": { "description": "status-pages resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-pages" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-pages.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Create Status Page", "description": "Creates a status-pages resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new status-pages resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-pages.CreateStatusPageData" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-pages.CreateStatusPageData" } } }, "required": true } } }, "/organizations/{organization_id}/status-pages/{id}": { "get": { "operationId": "get_status_page", "tags": [ "Status Pages" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-pages resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-pages" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-pages.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Status Page", "description": "Retrieves a status-pages resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "delete": { "operationId": "delete_status_page", "tags": [ "Status Pages" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "status-pages resource deleted" }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Delete Status Page", "description": "Removes the status-pages resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] }, "patch": { "operationId": "update_status_page", "tags": [ "Status Pages" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "status-pages resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status-pages" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/status-pages.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input", "links": {} }, "422": { "description": "Validation Error", "links": {} }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Update Status Page", "description": "Updates the status-pages resource.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Status page identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^stp_[0-9a-f]{32}$", "description": "Status page identifier.", "example": "stp_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated status-pages resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/status-pages.UpdateStatusPageData.jsonMergePatch" } } }, "required": true } } }, "/organizations/{organization_id}/theme-assets": { "get": { "operationId": "list_theme_assets", "tags": [ "Themes" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "theme-assets collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/theme-assets" } } }, "application/ld+json": { "schema": { "type": "object", "description": "theme-assets.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/theme-assets.jsonld" } } } } ] } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "List Theme Assets", "description": "Retrieves theme asset metadata for the organization (files used by status page themes).", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false } ] } }, "/organizations/{organization_id}/theme-assets/{id}": { "get": { "operationId": "get_theme_asset", "tags": [ "Themes" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "theme-assets resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme-assets" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/theme-assets.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Theme Asset", "description": "Retrieves one theme asset by public identifier, including digest, MIME type, and download path.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false }, { "name": "id", "in": "path", "description": "Theme asset identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^tha_[0-9a-f]{32}$", "description": "Theme asset identifier.", "example": "tha_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/organizations/{organization_id}/theme-options": { "get": { "operationId": "get_theme_options", "tags": [ "Themes" ], "responses": { "404": { "$ref": "#/components/responses/NotFoundProblem" }, "200": { "description": "theme-options resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme-options" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/theme-options.jsonld" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedProblem" }, "403": { "$ref": "#/components/responses/ForbiddenProblem" } }, "summary": "Get Theme Options Metadata", "description": "Retrieves combined theme options metadata for frontend page settings and email notification-type settings.", "parameters": [ { "name": "organization_id", "in": "path", "description": "Organization identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^org_[0-9a-f]{32}$", "description": "Organization identifier.", "example": "org_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ] } }, "/webhook-keys/{id}/public-key": { "get": { "operationId": "get_webhook_public_key", "tags": [ "Webhook Keys" ], "responses": { "200": { "description": "The webhook public key", "content": { "text/plain": { "schema": { "type": "string", "description": "PEM-encoded public key material for verifying webhook signatures.", "example": "-----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA... -----END PUBLIC KEY-----", "minLength": 80, "maxLength": 16384, "pattern": "^-----BEGIN [A-Z0-9 +\\-]+-----\\s*[A-Za-z0-9+/=\\s]+-----END [A-Z0-9 +\\-]+-----\\s*$" } } } }, "404": { "$ref": "#/components/responses/NotFoundProblem" }, "204": { "description": "webhook-keys resource" } }, "summary": "Get Webhook Public Key", "description": "Retrieves a webhook public key.", "parameters": [ { "name": "id", "in": "path", "description": "Webhook key identifier.", "required": true, "deprecated": false, "schema": { "type": "string", "pattern": "^whk_[0-9a-f]{32}$", "description": "Webhook key identifier.", "example": "whk_550e8400e29b41d4a716446655440000", "minLength": 36, "maxLength": 36 }, "style": "simple", "explode": false } ], "security": [] } } }, "components": { "schemas": { "AffectedComponent": { "type": "object", "required": [ "component_id", "status" ], "properties": { "component_id": { "description": "Identifier of the affected component.", "externalDocs": { "url": "string" }, "example": "cmp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^cmp_[0-9a-f]{32}$" }, "status": { "description": "The status of the component.", "externalDocs": { "url": "string" }, "example": "under_investigation", "type": "string", "enum": [ "operational", "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] }, "component_impact_started_at": { "description": "The timestamp when the component impact started.", "externalDocs": { "url": "string" }, "example": "2024-01-15T10:30:00Z", "type": [ "string", "null" ], "format": "date-time" } } }, "AffectedComponentApi": { "type": "object", "required": [ "component_id", "status" ], "properties": { "component_id": { "description": "Component identifier.", "externalDocs": { "url": "string" }, "example": "cmp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^cmp_[0-9a-f]{32}$" }, "status": { "description": "The current status of the component.", "externalDocs": { "url": "string" }, "example": "operational", "type": "string", "enum": [ "operational", "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] }, "component_impact_started_at": { "description": "When the component impact started.", "externalDocs": { "url": "string" }, "example": "2025-01-15T10:30:00Z", "type": [ "string", "null" ], "format": "date-time" }, "component_impact_ended_at": { "description": "When the component impact ended (if applicable).", "externalDocs": { "url": "string" }, "example": "2025-01-15T12:30:00Z", "type": [ "string", "null" ], "format": "date-time" } } }, "AffectedComponentApi.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "component_id", "status" ], "properties": { "component_id": { "description": "Component identifier.", "externalDocs": { "url": "string" }, "example": "cmp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^cmp_[0-9a-f]{32}$" }, "status": { "description": "The current status of the component.", "externalDocs": { "url": "string" }, "example": "operational", "type": "string", "enum": [ "operational", "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] }, "component_impact_started_at": { "description": "When the component impact started.", "externalDocs": { "url": "string" }, "example": "2025-01-15T10:30:00Z", "type": [ "string", "null" ], "format": "date-time" }, "component_impact_ended_at": { "description": "When the component impact ended (if applicable).", "externalDocs": { "url": "string" }, "example": "2025-01-15T12:30:00Z", "type": [ "string", "null" ], "format": "date-time" } } } ] }, "CreateMaintenanceAffectedComponentData": { "type": "object", "required": [ "component_id", "expected_component_status" ], "properties": { "component_id": { "description": "The ID of the component affected by maintenance.", "externalDocs": { "url": "string" }, "example": "cmp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^cmp_[0-9a-f]{32}$" }, "expected_component_status": { "description": "The expected status of the component during maintenance.", "externalDocs": { "url": "string" }, "example": "maintenance", "type": "string", "enum": [ "operational", "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] } } }, "HydraCollectionBaseSchema": { "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination" }, { "type": "object", "properties": { "view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "first": { "type": "string", "format": "iri-reference" }, "last": { "type": "string", "format": "iri-reference" }, "previous": { "type": "string", "format": "iri-reference" }, "next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" } } } } ] }, "HydraCollectionBaseSchemaNoPagination": { "type": "object", "properties": { "totalItems": { "type": "integer", "minimum": 0 }, "search": { "type": "object", "properties": { "@type": { "type": "string" }, "template": { "type": "string" }, "variableRepresentation": { "type": "string" }, "mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } } }, "HydraItemBaseSchema": { "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "type": "string" }, "@type": { "type": "string" } }, "required": [ "@id", "@type" ] }, "MonitorConfigurationDefinition": { "type": "object", "required": [ "label", "help_text", "key", "is_required", "type" ], "properties": { "label": { "description": "Human-readable label shown in the dashboard for this configuration field.", "externalDocs": { "url": "string" }, "example": "Endpoint URL", "type": "string", "minLength": 2, "maxLength": 40 }, "help_text": { "description": "Helper text explaining what to enter for this field.", "externalDocs": { "url": "string" }, "example": "Full HTTPS URL including scheme; used for health checks.", "type": "string", "minLength": 2, "maxLength": 255 }, "key": { "description": "Stable machine key for this field within the monitor type configuration.", "externalDocs": { "url": "string" }, "example": "url", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "is_required": { "description": "Whether the user must provide a value for this field.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "type": { "description": "Primitive data type for values stored for this field.", "externalDocs": { "url": "string" }, "example": "string", "type": "string", "enum": [ "string", "integer", "float", "boolean" ] }, "format": { "description": "Optional string format or semantic constraint applied to the value (for example HTTPS URL or JSONLogic).", "externalDocs": { "url": "string" }, "example": "https-url", "type": [ "string", "null" ], "enum": [ "date-time", "https-url", "jsonlogic" ] }, "example": { "description": "Example value illustrating valid input for documentation and clients.", "externalDocs": { "url": "string" }, "example": "https://api.example.com/health", "type": [ "string", "null" ], "maxLength": 255 }, "default": { "description": "Default value when the user leaves the field empty (string form).", "externalDocs": { "url": "string" }, "example": "", "type": [ "string", "null" ], "maxLength": 255 }, "min_length": { "description": "Minimum string length for string values, when applicable.", "externalDocs": { "url": "integer" }, "example": 8, "type": [ "integer", "null" ], "minimum": 0 }, "max_length": { "description": "Maximum string length for string values, when applicable.", "externalDocs": { "url": "integer" }, "example": 2048, "type": [ "integer", "null" ], "minimum": 1 }, "min_value": { "description": "Minimum numeric value for number fields, when applicable.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "max_value": { "description": "Maximum numeric value for number fields, when applicable.", "externalDocs": { "url": "integer" }, "example": 65535, "type": [ "integer", "null" ] } } }, "MonitorConfigurationDefinition.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "label", "help_text", "key", "is_required", "type" ], "properties": { "label": { "description": "Human-readable label shown in the dashboard for this configuration field.", "externalDocs": { "url": "string" }, "example": "Endpoint URL", "type": "string", "minLength": 2, "maxLength": 40 }, "help_text": { "description": "Helper text explaining what to enter for this field.", "externalDocs": { "url": "string" }, "example": "Full HTTPS URL including scheme; used for health checks.", "type": "string", "minLength": 2, "maxLength": 255 }, "key": { "description": "Stable machine key for this field within the monitor type configuration.", "externalDocs": { "url": "string" }, "example": "url", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "is_required": { "description": "Whether the user must provide a value for this field.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "type": { "description": "Primitive data type for values stored for this field.", "externalDocs": { "url": "string" }, "example": "string", "type": "string", "enum": [ "string", "integer", "float", "boolean" ] }, "format": { "description": "Optional string format or semantic constraint applied to the value (for example HTTPS URL or JSONLogic).", "externalDocs": { "url": "string" }, "example": "https-url", "type": [ "string", "null" ], "enum": [ "date-time", "https-url", "jsonlogic" ] }, "example": { "description": "Example value illustrating valid input for documentation and clients.", "externalDocs": { "url": "string" }, "example": "https://api.example.com/health", "type": [ "string", "null" ], "maxLength": 255 }, "default": { "description": "Default value when the user leaves the field empty (string form).", "externalDocs": { "url": "string" }, "example": "", "type": [ "string", "null" ], "maxLength": 255 }, "min_length": { "description": "Minimum string length for string values, when applicable.", "externalDocs": { "url": "integer" }, "example": 8, "type": [ "integer", "null" ], "minimum": 0 }, "max_length": { "description": "Maximum string length for string values, when applicable.", "externalDocs": { "url": "integer" }, "example": 2048, "type": [ "integer", "null" ], "minimum": 1 }, "min_value": { "description": "Minimum numeric value for number fields, when applicable.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "max_value": { "description": "Maximum numeric value for number fields, when applicable.", "externalDocs": { "url": "integer" }, "example": 65535, "type": [ "integer", "null" ] } } } ] }, "ShortTranslation": { "type": "object", "required": [ "language", "text" ], "properties": { "language": { "description": "ISO-style language code for this entry (typically two or three lowercase letters, e.g. en, de).", "example": "en", "type": "string", "minLength": 2, "maxLength": 3, "pattern": "^[a-z]{2,3}$" }, "text": { "description": "Short summary or description text for this language entry.", "example": "We are investigating elevated error rates.", "type": "string", "minLength": 2, "maxLength": 255, "pattern": "^[\\s\\S]+$" } } }, "ShortTranslation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "language", "text" ], "properties": { "language": { "description": "ISO-style language code for this entry (typically two or three lowercase letters, e.g. en, de).", "example": "en", "type": "string", "minLength": 2, "maxLength": 3, "pattern": "^[a-z]{2,3}$" }, "text": { "description": "Short summary or description text for this language entry.", "example": "We are investigating elevated error rates.", "type": "string", "minLength": 2, "maxLength": 255, "pattern": "^[\\s\\S]+$" } } } ] }, "ThemeEditorFieldRead": { "type": "object", "required": [ "key", "label", "type", "default", "description", "options", "max_length", "min", "max" ], "properties": { "key": { "description": "Stable key for this field in stored theme JSON.", "externalDocs": { "url": "string" }, "example": "title", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "label": { "description": "Human-readable label for the field in theme editors.", "externalDocs": { "url": "string" }, "example": "Title", "type": "string", "minLength": 2, "maxLength": 40, "pattern": "^[\\s\\S]+$" }, "type": { "description": "Editor control type for this field.", "externalDocs": { "url": "string" }, "example": "text", "type": "string", "enum": [ "boolean", "text", "select", "multiselect", "integer", "enum" ], "minLength": 3, "maxLength": 12 }, "default": { "description": "Default value when the theme does not set this field; shape depends on `type` (boolean, integer, string, list of strings, etc.).", "externalDocs": { "url": "string" }, "example": false, "type": [ "string", "null" ] }, "description": { "description": "Optional helper text shown next to the field in theme editors.", "externalDocs": { "url": "string" }, "example": "Main heading shown on the page.", "type": [ "string", "null" ], "maxLength": 255 }, "options": { "description": "Selectable choices for select, multiselect, or enum field types; null when not applicable.", "externalDocs": { "url": "object" }, "example": { "open": "Open", "acknowledged": "Acknowledged" }, "type": [ "object", "null" ], "additionalProperties": { "type": "string", "maxLength": 40 } }, "max_length": { "description": "Maximum string length for text fields; null when not constrained.", "externalDocs": { "url": "integer" }, "example": 120, "type": [ "integer", "null" ], "minimum": 0, "maximum": 255 }, "min": { "description": "Minimum value for integer fields; null when not applicable.", "externalDocs": { "url": "integer" }, "example": 0, "type": [ "integer", "null" ] }, "max": { "description": "Maximum value for integer fields; null when not applicable.", "externalDocs": { "url": "integer" }, "example": 100, "type": [ "integer", "null" ] } } }, "ThemeEditorFieldRead.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "key", "label", "type", "default", "description", "options", "max_length", "min", "max" ], "properties": { "key": { "description": "Stable key for this field in stored theme JSON.", "externalDocs": { "url": "string" }, "example": "title", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "label": { "description": "Human-readable label for the field in theme editors.", "externalDocs": { "url": "string" }, "example": "Title", "type": "string", "minLength": 2, "maxLength": 40, "pattern": "^[\\s\\S]+$" }, "type": { "description": "Editor control type for this field.", "externalDocs": { "url": "string" }, "example": "text", "type": "string", "enum": [ "boolean", "text", "select", "multiselect", "integer", "enum" ], "minLength": 3, "maxLength": 12 }, "default": { "description": "Default value when the theme does not set this field; shape depends on `type` (boolean, integer, string, list of strings, etc.).", "externalDocs": { "url": "string" }, "example": false, "type": [ "string", "null" ] }, "description": { "description": "Optional helper text shown next to the field in theme editors.", "externalDocs": { "url": "string" }, "example": "Main heading shown on the page.", "type": [ "string", "null" ], "maxLength": 255 }, "options": { "description": "Selectable choices for select, multiselect, or enum field types; null when not applicable.", "externalDocs": { "url": "object" }, "example": { "open": "Open", "acknowledged": "Acknowledged" }, "type": [ "object", "null" ], "additionalProperties": { "type": "string", "maxLength": 40 } }, "max_length": { "description": "Maximum string length for text fields; null when not constrained.", "externalDocs": { "url": "integer" }, "example": 120, "type": [ "integer", "null" ], "minimum": 0, "maximum": 255 }, "min": { "description": "Minimum value for integer fields; null when not applicable.", "externalDocs": { "url": "integer" }, "example": 0, "type": [ "integer", "null" ] }, "max": { "description": "Maximum value for integer fields; null when not applicable.", "externalDocs": { "url": "integer" }, "example": 100, "type": [ "integer", "null" ] } } } ] }, "ThemeOptionsSectionRead": { "type": "object", "required": [ "key", "name", "options" ], "properties": { "key": { "description": "Stable key for this section (for example the frontend page key or notification type key).", "externalDocs": { "url": "string" }, "example": "hero", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "name": { "description": "Display name for this section in theme editors.", "externalDocs": { "url": "string" }, "example": "Hero", "type": "string", "minLength": 2, "maxLength": 40, "pattern": "^[\\s\\S]+$" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ThemeEditorFieldRead" } } } }, "ThemeOptionsSectionRead.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "key", "name", "options" ], "properties": { "key": { "description": "Stable key for this section (for example the frontend page key or notification type key).", "externalDocs": { "url": "string" }, "example": "hero", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "name": { "description": "Display name for this section in theme editors.", "externalDocs": { "url": "string" }, "example": "Hero", "type": "string", "minLength": 2, "maxLength": 40, "pattern": "^[\\s\\S]+$" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ThemeEditorFieldRead.jsonld" } } } } ] }, "TitleTranslation": { "type": "object", "required": [ "language", "text" ], "properties": { "language": { "description": "ISO-style language code for this entry (typically two or three lowercase letters, e.g. en, de).", "example": "en", "type": "string", "minLength": 2, "maxLength": 3, "pattern": "^[a-z]{2,3}$" }, "text": { "description": "Short title text for this language entry.", "example": "Service degradation", "type": "string", "minLength": 2, "maxLength": 40, "pattern": "^[\\s\\S]+$" } } }, "TitleTranslation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "language", "text" ], "properties": { "language": { "description": "ISO-style language code for this entry (typically two or three lowercase letters, e.g. en, de).", "example": "en", "type": "string", "minLength": 2, "maxLength": 3, "pattern": "^[a-z]{2,3}$" }, "text": { "description": "Short title text for this language entry.", "example": "Service degradation", "type": "string", "minLength": 2, "maxLength": 40, "pattern": "^[\\s\\S]+$" } } } ] }, "Translation": { "type": "object", "required": [ "language", "text" ], "properties": { "language": { "description": "ISO-style language code for this entry (typically two or three lowercase letters, e.g. en, de).", "example": "en", "type": "string", "minLength": 2, "maxLength": 3, "pattern": "^[a-z]{2,3}$" }, "text": { "description": "Localized text for this language entry.", "example": "This is the translated text.", "type": "string", "minLength": 1, "pattern": "^[\\s\\S]+$" } } }, "Translation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "language", "text" ], "properties": { "language": { "description": "ISO-style language code for this entry (typically two or three lowercase letters, e.g. en, de).", "example": "en", "type": "string", "minLength": 2, "maxLength": 3, "pattern": "^[a-z]{2,3}$" }, "text": { "description": "Localized text for this language entry.", "example": "This is the translated text.", "type": "string", "minLength": 1, "pattern": "^[\\s\\S]+$" } } } ] }, "UpdateMaintenanceData": { "type": "object", "properties": { "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "internal_summary": { "description": "The internal summary of the maintenance for team members.", "externalDocs": { "url": "string" }, "example": "Database upgrade to version 2.0 with improved performance.", "type": "string", "minLength": 1, "maxLength": 2000 }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/Translation" } }, "planned_start_date": { "description": "The planned start date and time of the maintenance.", "externalDocs": { "url": "string" }, "example": "2024-01-15T02:00:00Z", "type": [ "string", "null" ], "format": "date-time" }, "planned_end_date": { "description": "The planned end date and time of the maintenance.", "externalDocs": { "url": "string" }, "example": "2024-01-15T04:00:00Z", "type": [ "string", "null" ], "format": "date-time" }, "actual_start_date": { "description": "The actual start date and time of the maintenance.", "externalDocs": { "url": "string" }, "example": "2024-01-15T02:10:00Z", "type": [ "string", "null" ], "format": "date-time" }, "is_suppressing_incidents": { "description": "Whether incidents should be suppressed during maintenance.", "externalDocs": { "url": "boolean" }, "example": false, "type": [ "boolean", "null" ] }, "is_component_status_auto_updated": { "description": "Whether affected component maintenance statuses are updated automatically on stage transitions.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "is_automatically_starting": { "description": "Whether the maintenance should start automatically.", "externalDocs": { "url": "boolean" }, "example": false, "type": [ "boolean", "null" ] }, "is_automatically_ending": { "description": "Whether the maintenance should end automatically.", "externalDocs": { "url": "boolean" }, "example": false, "type": [ "boolean", "null" ] }, "auto_start_grace_period": { "description": "Grace period in minutes before auto-starting maintenance.", "externalDocs": { "url": "integer" }, "example": 0, "type": [ "integer", "null" ] }, "auto_end_grace_period": { "description": "Grace period in minutes before auto-ending maintenance.", "externalDocs": { "url": "integer" }, "example": 0, "type": [ "integer", "null" ] }, "tags": { "description": "Tags to categorize the maintenance.", "externalDocs": { "url": "array" }, "example": [ "database", "maintenance", "scheduled" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Additional metadata for the maintenance.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1", "service": "database" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } } } }, "components": { "type": "object", "description": "Logical parts of your service (for example an API, database, or CDN) that appear on status pages. Each component has a stable key, localized name and description, and a current availability status used for incidents and subscriber communication.", "required": [ "id", "component_key", "status", "name", "description", "organization", "organization_id" ], "properties": { "id": { "description": "Component identifier.", "externalDocs": { "url": "string" }, "example": "cmp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^cmp_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "component_key": { "description": "Stable unique key for the component within the organization. Used in URLs and references from other resources.", "externalDocs": { "url": "string" }, "example": "api-server", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "status": { "description": "Current availability status of the component on public status pages. Severity increases down the list; operational is healthy.", "externalDocs": { "url": "string" }, "example": "operational", "type": "string", "enum": [ "operational", "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } }, "components.CreateComponentData": { "type": "object", "description": "Logical parts of your service (for example an API, database, or CDN) that appear on status pages. Each component has a stable key, localized name and description, and a current availability status used for incidents and subscriber communication.", "required": [ "component_key", "name" ], "properties": { "component_key": { "description": "The unique key of the component.", "externalDocs": { "url": "string" }, "example": "api-server", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } } } }, "components.UpdateComponentData.jsonMergePatch": { "type": "object", "description": "Logical parts of your service (for example an API, database, or CDN) that appear on status pages. Each component has a stable key, localized name and description, and a current availability status used for incidents and subscriber communication.", "properties": { "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "component_key": { "description": "The unique key of the component.", "externalDocs": { "url": "string" }, "example": "api-server", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 } } }, "components.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "component_key", "status", "name", "description", "organization", "organization_id" ], "properties": { "id": { "description": "Component identifier.", "externalDocs": { "url": "string" }, "example": "cmp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^cmp_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "component_key": { "description": "Stable unique key for the component within the organization. Used in URLs and references from other resources.", "externalDocs": { "url": "string" }, "example": "api-server", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "status": { "description": "Current availability status of the component on public status pages. Severity increases down the list; operational is healthy.", "externalDocs": { "url": "string" }, "example": "operational", "type": "string", "enum": [ "operational", "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation.jsonld" } }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } } ], "description": "Logical parts of your service (for example an API, database, or CDN) that appear on status pages. Each component has a stable key, localized name and description, and a current availability status used for incidents and subscriber communication." }, "incident-status-transitions": { "type": "object", "description": "Incident Status Transitions define the allowed transitions between incident statuses.", "required": [ "id", "transition_key", "is_enabled", "is_primary", "name", "description", "button_name", "color", "from_status_id", "to_status_id", "order", "is_subscriber_notified", "from_status", "to_status", "organization", "organization_id", "is_default" ], "properties": { "id": { "description": "Incident status transition identifier.", "externalDocs": { "url": "string" }, "example": "itr_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^itr_[0-9a-f]{32}$" }, "transition_key": { "description": "Stable unique key for the transition within the organization.", "externalDocs": { "url": "string" }, "example": "investigating_to_monitoring", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this transition is available in the workflow.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_primary": { "description": "Whether this is the primary transition for its source status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "button_name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "color": { "description": "Dashboard color token for this transition.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this transition, if any.", "externalDocs": { "url": "string" }, "example": "play", "type": [ "string", "null" ] }, "from_status_id": { "description": "Public identifier of the source incident status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "to_status_id": { "description": "Public identifier of the target incident status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440001", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "order": { "description": "Display order among transitions from the same source status.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer", "minimum": 0 }, "is_subscriber_notified": { "description": "Whether subscribers are notified when this transition is applied.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "from_status": { "description": "Source incident status serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/incident-statuses/ist_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "to_status": { "description": "Target incident status serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/incident-statuses/ist_550e8400e29b41d4a716446655440001", "type": "string", "format": "iri-reference" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "is_default": { "description": "When true, this transition is treated as the workflow default where applicable.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" } } }, "incident-status-transitions.CreateIncidentStatusTransitionData": { "type": "object", "description": "Incident Status Transitions define the allowed transitions between incident statuses.", "required": [ "transition_key", "name", "color", "from_status_id", "to_status_id", "order" ], "properties": { "transition_key": { "description": "The unique key identifier for the status transition.", "externalDocs": { "url": "string" }, "example": "investigating_to_monitoring", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "button_name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "color": { "description": "The color associated with the status transition.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "The icon associated with the status transition.", "externalDocs": { "url": "string" }, "example": "play", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "from_status_id": { "description": "The ID of the source status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "to_status_id": { "description": "The ID of the target status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440001", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "order": { "description": "The order of the status transition.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer" }, "is_enabled": { "description": "Whether the status transition is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_primary": { "description": "Whether this transition should be set as the primary outgoing transition for its source status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_subscriber_notified": { "description": "Whether subscribers should be notified when this transition is used.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } }, "incident-status-transitions.UpdateIncidentStatusTransitionData.jsonMergePatch": { "type": "object", "description": "Incident Status Transitions define the allowed transitions between incident statuses.", "properties": { "transition_key": { "description": "The unique key identifier for the status transition.", "externalDocs": { "url": "string" }, "example": "investigating-to-monitoring", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "button_name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "color": { "description": "The color associated with the status transition.", "externalDocs": { "url": "string" }, "example": "blue", "type": [ "string", "null" ], "enum": [ "danger", "success", "warning", "info", "primary", "gray", null ] }, "icon": { "description": "The icon associated with the status transition.", "externalDocs": { "url": "string" }, "example": "play", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "from_status_id": { "description": "The ID of the source status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "to_status_id": { "description": "The ID of the target status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440001", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "order": { "description": "The order of the status transition.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "is_enabled": { "description": "Whether the status transition is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "is_primary": { "description": "Whether this transition should become the primary outgoing transition for its source status.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "is_subscriber_notified": { "description": "Whether subscribers should be notified when this transition is used.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] } } }, "incident-status-transitions.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "transition_key", "is_enabled", "is_primary", "name", "description", "button_name", "color", "from_status_id", "to_status_id", "order", "is_subscriber_notified", "from_status", "to_status", "organization", "organization_id", "is_default" ], "properties": { "id": { "description": "Incident status transition identifier.", "externalDocs": { "url": "string" }, "example": "itr_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^itr_[0-9a-f]{32}$" }, "transition_key": { "description": "Stable unique key for the transition within the organization.", "externalDocs": { "url": "string" }, "example": "investigating_to_monitoring", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this transition is available in the workflow.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_primary": { "description": "Whether this is the primary transition for its source status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation.jsonld" } }, "button_name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "color": { "description": "Dashboard color token for this transition.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this transition, if any.", "externalDocs": { "url": "string" }, "example": "play", "type": [ "string", "null" ] }, "from_status_id": { "description": "Public identifier of the source incident status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "to_status_id": { "description": "Public identifier of the target incident status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440001", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "order": { "description": "Display order among transitions from the same source status.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer", "minimum": 0 }, "is_subscriber_notified": { "description": "Whether subscribers are notified when this transition is applied.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "from_status": { "description": "Source incident status serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/incident-statuses/ist_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "to_status": { "description": "Target incident status serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/incident-statuses/ist_550e8400e29b41d4a716446655440001", "type": "string", "format": "iri-reference" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "is_default": { "description": "When true, this transition is treated as the workflow default where applicable.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" } } } ], "description": "Incident Status Transitions define the allowed transitions between incident statuses." }, "incident-statuses": { "type": "object", "description": "Incident Statuses are used to track the progress of incidents.", "required": [ "id", "status_key", "is_enabled", "is_default", "name", "description", "public_label", "stage", "color", "icon", "public_color", "public_icon", "organization", "organization_id" ], "properties": { "id": { "description": "Incident status identifier.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "status_key": { "description": "Stable unique key for the status within the organization.", "externalDocs": { "url": "string" }, "example": "investigating", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this status can be selected in workflows.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_default": { "description": "Whether this is the organization default initial status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "public_label": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "stage": { "description": "Lifecycle stage this status belongs to.", "externalDocs": { "url": "string" }, "example": "active", "type": "string", "enum": [ "triage", "active", "post-incident", "closed" ] }, "color": { "description": "Dashboard color token for this status.", "externalDocs": { "url": "string" }, "example": "warning", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this status.", "externalDocs": { "url": "string" }, "example": "magnifying-glass", "type": "string" }, "public_color": { "description": "Public status-page color token for this status.", "externalDocs": { "url": "string" }, "example": "warning", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "public_icon": { "description": "Public status-page icon token for this status.", "externalDocs": { "url": "string" }, "example": "magnifying-glass", "type": "string" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } }, "incident-statuses.CreateIncidentStatusData": { "type": "object", "description": "Incident Statuses are used to track the progress of incidents.", "required": [ "status_key", "name", "public_label", "stage", "color", "icon", "public_color", "public_icon" ], "properties": { "status_key": { "description": "The unique key identifier for the incident status.", "externalDocs": { "url": "string" }, "example": "investigating", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "public_label": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "stage": { "description": "The stage of the incident status.", "externalDocs": { "url": "string" }, "example": "investigating", "type": "string", "enum": [ "triage", "active", "post-incident", "closed" ] }, "color": { "description": "The color associated with the incident status.", "externalDocs": { "url": "string" }, "example": "orange", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "The icon associated with the incident status.", "externalDocs": { "url": "string" }, "example": "search", "type": "string", "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down" ] }, "public_color": { "description": "The public-facing color associated with the incident status.", "externalDocs": { "url": "string" }, "example": "warning", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "public_icon": { "description": "The public-facing icon associated with the incident status.", "externalDocs": { "url": "string" }, "example": "magnifying-glass", "type": "string", "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down" ] }, "is_enabled": { "description": "Whether the incident status is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } }, "incident-statuses.UpdateIncidentStatusData.jsonMergePatch": { "type": "object", "description": "Incident Statuses are used to track the progress of incidents.", "properties": { "status_key": { "description": "The unique key identifier for the incident status.", "externalDocs": { "url": "string" }, "example": "investigating", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "public_label": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "stage": { "description": "The stage of the incident status.", "externalDocs": { "url": "string" }, "example": "investigating", "type": [ "string", "null" ], "enum": [ "triage", "active", "post-incident", "closed", null ] }, "color": { "description": "The color associated with the incident status.", "externalDocs": { "url": "string" }, "example": "orange", "type": [ "string", "null" ], "enum": [ "danger", "success", "warning", "info", "primary", "gray", null ] }, "icon": { "description": "The icon associated with the incident status.", "externalDocs": { "url": "string" }, "example": "search", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "public_color": { "description": "The public-facing color associated with the incident status.", "externalDocs": { "url": "string" }, "example": "warning", "type": [ "string", "null" ], "enum": [ "danger", "success", "warning", "info", "primary", "gray", null ] }, "public_icon": { "description": "The public-facing icon associated with the incident status.", "externalDocs": { "url": "string" }, "example": "magnifying-glass", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "is_enabled": { "description": "Whether the incident status is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] } } }, "incident-statuses.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "status_key", "is_enabled", "is_default", "name", "description", "public_label", "stage", "color", "icon", "public_color", "public_icon", "organization", "organization_id" ], "properties": { "id": { "description": "Incident status identifier.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "status_key": { "description": "Stable unique key for the status within the organization.", "externalDocs": { "url": "string" }, "example": "investigating", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this status can be selected in workflows.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_default": { "description": "Whether this is the organization default initial status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation.jsonld" } }, "public_label": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "stage": { "description": "Lifecycle stage this status belongs to.", "externalDocs": { "url": "string" }, "example": "active", "type": "string", "enum": [ "triage", "active", "post-incident", "closed" ] }, "color": { "description": "Dashboard color token for this status.", "externalDocs": { "url": "string" }, "example": "warning", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this status.", "externalDocs": { "url": "string" }, "example": "magnifying-glass", "type": "string" }, "public_color": { "description": "Public status-page color token for this status.", "externalDocs": { "url": "string" }, "example": "warning", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "public_icon": { "description": "Public status-page icon token for this status.", "externalDocs": { "url": "string" }, "example": "magnifying-glass", "type": "string" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } } ], "description": "Incident Statuses are used to track the progress of incidents." }, "incidents": { "type": "object", "description": "Incidents are the main objects in the system. They are used to track the progress of incidents.", "required": [ "id", "deduplication_key", "title", "public_summary", "internal_summary", "stage", "status", "status_id", "organization", "organization_id", "severity_level", "severity_level_id" ], "properties": { "id": { "description": "Incident identifier.", "externalDocs": { "url": "string" }, "example": "inc_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^inc_[0-9a-f]{32}$" }, "deduplication_key": { "description": "Unique key used to deduplicate incidents within the organization while triage or active.", "externalDocs": { "url": "string" }, "example": "api-server-down-2024-01-15", "type": "string", "minLength": 1, "maxLength": 255 }, "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "internal_summary": { "description": "Internal summary for dashboard users (not shown on the public status page).", "externalDocs": { "url": "string" }, "example": "API server is experiencing connectivity issues.", "type": "string", "minLength": 1, "maxLength": 2000 }, "stage": { "description": "High-level lifecycle stage of the incident.", "externalDocs": { "url": "string" }, "example": "active", "type": "string", "enum": [ "triage", "active", "post-incident", "closed" ] }, "status": { "description": "Current incident status serialized as an IRI reference pointing to the IncidentStatus resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/incident-statuses/ist_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_id": { "description": "Public identifier of the current incident status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "started_at": { "description": "When the incident was first opened, if set.", "externalDocs": { "url": "string" }, "example": "2025-03-22T10:00:00.000000Z", "type": [ "string", "null" ], "format": "date-time" }, "resolved_at": { "description": "When the incident was marked resolved, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "activated_at": { "description": "When the incident became customer-visible / activated, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "post_incident_at": { "description": "When the incident entered post-incident review, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "closed_at": { "description": "When the incident was closed, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "severity_level": { "description": "Severity level serialized as an IRI reference pointing to the SeverityLevel resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/severity-levels/sev_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "severity_level_id": { "description": "Public identifier of the incident severity level.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sev_[0-9a-f]{32}$" }, "tags": { "description": "Tags used to categorize the incident.", "externalDocs": { "url": "array" }, "example": [ "production", "api" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Arbitrary string key/value metadata attached to the incident.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } }, "affected_components": { "type": "array", "items": { "$ref": "#/components/schemas/AffectedComponentApi" } } } }, "incidents.CreateIncidentData": { "type": "object", "description": "Incidents are the main objects in the system. They are used to track the progress of incidents.", "required": [ "deduplication_key", "title", "internal_summary", "affected_components", "severity_level_id" ], "properties": { "deduplication_key": { "description": "A unique key to prevent duplicate incidents.", "externalDocs": { "url": "string" }, "example": "api-server-down-2024-01-15", "type": "string" }, "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "internal_summary": { "description": "The internal summary of the incident for team members.", "externalDocs": { "url": "string" }, "example": "API server is experiencing connectivity issues.", "type": "string", "minLength": 1, "maxLength": 2000 }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "affected_components": { "type": "array", "items": { "$ref": "#/components/schemas/AffectedComponent" } }, "severity_level_id": { "description": "The ID of the severity level.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sev_[0-9a-f]{32}$" }, "tags": { "description": "Tags to categorize the incident.", "externalDocs": { "url": "array" }, "example": [ "production", "api", "critical" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Additional metadata for the incident.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1", "service": "api-gateway" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } }, "initial_status_id": { "description": "The ID of the initial status for the incident. If not provided, the organization workflow default will be used.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440003", "type": "string", "pattern": "^ist_[0-9a-f]{32}$", "nullable": true } } }, "incidents.CreateIncidentUpdateData": { "type": "object", "description": "Incidents are the main objects in the system. They are used to track the progress of incidents.", "required": [ "deduplication_key" ], "properties": { "deduplication_key": { "description": "A unique key to prevent duplicate status updates.", "externalDocs": { "url": "string" }, "example": "status-update-2024-01-15-001", "type": "string", "minLength": 5, "maxLength": 40, "pattern": "/^[a-z0-9-]+$/" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status update.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "message": { "type": "array", "items": { "$ref": "#/components/schemas/Translation" } }, "new_status_id": { "description": "The ID of the new status to transition to.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$", "nullable": true } } }, "incidents.UpdateIncidentData.jsonMergePatch": { "type": "object", "description": "Incidents are the main objects in the system. They are used to track the progress of incidents.", "properties": { "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "internal_summary": { "description": "The internal summary of the incident for team members.", "externalDocs": { "url": "string" }, "example": "API server is experiencing connectivity issues.", "type": "string", "minLength": 2, "maxLength": 2000 }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/Translation" } }, "severity_level_id": { "description": "The ID of the severity level.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sev_[0-9a-f]{32}$", "nullable": true }, "started_at": { "description": "The timestamp when the incident started.", "externalDocs": { "url": "string" }, "example": "2024-01-15T10:30:00Z", "type": [ "string", "null" ], "format": "date-time" }, "resolved_at": { "description": "The timestamp when the incident was resolved.", "externalDocs": { "url": "string" }, "example": "2024-01-15T12:00:00Z", "type": [ "string", "null" ], "format": "date-time" }, "tags": { "description": "Tags to categorize the incident.", "externalDocs": { "url": "array" }, "example": [ "production", "api", "critical" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Additional metadata for the incident.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1", "service": "api-gateway" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } }, "affected_components": { "type": "array", "items": { "$ref": "#/components/schemas/AffectedComponent" } } } }, "incidents.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "deduplication_key", "title", "public_summary", "internal_summary", "stage", "status", "status_id", "organization", "organization_id", "severity_level", "severity_level_id" ], "properties": { "id": { "description": "Incident identifier.", "externalDocs": { "url": "string" }, "example": "inc_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^inc_[0-9a-f]{32}$" }, "deduplication_key": { "description": "Unique key used to deduplicate incidents within the organization while triage or active.", "externalDocs": { "url": "string" }, "example": "api-server-down-2024-01-15", "type": "string", "minLength": 1, "maxLength": 255 }, "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation.jsonld" } }, "internal_summary": { "description": "Internal summary for dashboard users (not shown on the public status page).", "externalDocs": { "url": "string" }, "example": "API server is experiencing connectivity issues.", "type": "string", "minLength": 1, "maxLength": 2000 }, "stage": { "description": "High-level lifecycle stage of the incident.", "externalDocs": { "url": "string" }, "example": "active", "type": "string", "enum": [ "triage", "active", "post-incident", "closed" ] }, "status": { "description": "Current incident status serialized as an IRI reference pointing to the IncidentStatus resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/incident-statuses/ist_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_id": { "description": "Public identifier of the current incident status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^ist_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "started_at": { "description": "When the incident was first opened, if set.", "externalDocs": { "url": "string" }, "example": "2025-03-22T10:00:00.000000Z", "type": [ "string", "null" ], "format": "date-time" }, "resolved_at": { "description": "When the incident was marked resolved, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "activated_at": { "description": "When the incident became customer-visible / activated, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "post_incident_at": { "description": "When the incident entered post-incident review, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "closed_at": { "description": "When the incident was closed, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "severity_level": { "description": "Severity level serialized as an IRI reference pointing to the SeverityLevel resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/severity-levels/sev_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "severity_level_id": { "description": "Public identifier of the incident severity level.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sev_[0-9a-f]{32}$" }, "tags": { "description": "Tags used to categorize the incident.", "externalDocs": { "url": "array" }, "example": [ "production", "api" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Arbitrary string key/value metadata attached to the incident.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } }, "affected_components": { "type": "array", "items": { "$ref": "#/components/schemas/AffectedComponentApi.jsonld" } } } } ], "description": "Incidents are the main objects in the system. They are used to track the progress of incidents." }, "maintenance-status-transitions": { "type": "object", "description": "Maintenance Status Transitions define the allowed transitions between maintenance statuses.", "required": [ "id", "transition_key", "is_enabled", "is_primary", "name", "description", "button_name", "color", "from_status_id", "to_status_id", "order", "is_subscriber_notified", "from_status", "to_status", "organization", "organization_id", "is_default" ], "properties": { "id": { "description": "Maintenance status transition identifier.", "externalDocs": { "url": "string" }, "example": "mtr_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mtr_[0-9a-f]{32}$" }, "transition_key": { "description": "Stable unique key for the transition within the organization.", "externalDocs": { "url": "string" }, "example": "draft-to-scheduled", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this transition is available in the workflow.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_primary": { "description": "Whether this is the primary transition for its source status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "button_name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "color": { "description": "Dashboard color token for this transition.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this transition, if any.", "externalDocs": { "url": "string" }, "example": "play", "type": [ "string", "null" ] }, "from_status_id": { "description": "Public identifier of the source maintenance status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "to_status_id": { "description": "Public identifier of the target maintenance status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440001", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "order": { "description": "Display order among transitions from the same source status.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer", "minimum": 0 }, "is_subscriber_notified": { "description": "Whether subscribers are notified when this transition is applied.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "from_status": { "description": "Source maintenance status serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/maintenance-statuses/mst_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "to_status": { "description": "Target maintenance status serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/maintenance-statuses/mst_550e8400e29b41d4a716446655440001", "type": "string", "format": "iri-reference" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "is_default": { "description": "When true, this transition is treated as the workflow default where applicable.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" } } }, "maintenance-status-transitions.CreateMaintenanceStatusTransitionData": { "type": "object", "description": "Maintenance Status Transitions define the allowed transitions between maintenance statuses.", "required": [ "transition_key", "name", "color", "from_status_id", "to_status_id", "order" ], "properties": { "transition_key": { "description": "The unique key identifier for the status transition.", "externalDocs": { "url": "string" }, "example": "draft-to-scheduled", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "button_name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "color": { "description": "The color associated with the status transition.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "The icon associated with the status transition.", "externalDocs": { "url": "string" }, "example": "play", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "from_status_id": { "description": "The ID of the source status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "to_status_id": { "description": "The ID of the target status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440001", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "order": { "description": "The order of the status transition.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer" }, "is_enabled": { "description": "Whether the status transition is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_primary": { "description": "Whether this transition should be set as the primary outgoing transition for its source status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_subscriber_notified": { "description": "Whether subscribers should be notified when this transition is used.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } }, "maintenance-status-transitions.UpdateMaintenanceStatusTransitionData.jsonMergePatch": { "type": "object", "description": "Maintenance Status Transitions define the allowed transitions between maintenance statuses.", "properties": { "transition_key": { "description": "The unique key identifier for the status transition.", "externalDocs": { "url": "string" }, "example": "draft-to-scheduled", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "button_name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "color": { "description": "The color associated with the status transition.", "externalDocs": { "url": "string" }, "example": "blue", "type": [ "string", "null" ], "enum": [ "danger", "success", "warning", "info", "primary", "gray", null ] }, "icon": { "description": "The icon associated with the status transition.", "externalDocs": { "url": "string" }, "example": "play", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "from_status_id": { "description": "The ID of the source status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$", "nullable": true }, "to_status_id": { "description": "The ID of the target status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440001", "type": "string", "pattern": "^mst_[0-9a-f]{32}$", "nullable": true }, "order": { "description": "The order of the status transition.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "is_enabled": { "description": "Whether the status transition is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "is_primary": { "description": "Whether this transition should become the primary outgoing transition for its source status.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "is_subscriber_notified": { "description": "Whether subscribers should be notified when this transition is used.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] } } }, "maintenance-status-transitions.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "transition_key", "is_enabled", "is_primary", "name", "description", "button_name", "color", "from_status_id", "to_status_id", "order", "is_subscriber_notified", "from_status", "to_status", "organization", "organization_id", "is_default" ], "properties": { "id": { "description": "Maintenance status transition identifier.", "externalDocs": { "url": "string" }, "example": "mtr_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mtr_[0-9a-f]{32}$" }, "transition_key": { "description": "Stable unique key for the transition within the organization.", "externalDocs": { "url": "string" }, "example": "draft-to-scheduled", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this transition is available in the workflow.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_primary": { "description": "Whether this is the primary transition for its source status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation.jsonld" } }, "button_name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "color": { "description": "Dashboard color token for this transition.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this transition, if any.", "externalDocs": { "url": "string" }, "example": "play", "type": [ "string", "null" ] }, "from_status_id": { "description": "Public identifier of the source maintenance status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "to_status_id": { "description": "Public identifier of the target maintenance status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440001", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "order": { "description": "Display order among transitions from the same source status.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer", "minimum": 0 }, "is_subscriber_notified": { "description": "Whether subscribers are notified when this transition is applied.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "from_status": { "description": "Source maintenance status serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/maintenance-statuses/mst_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "to_status": { "description": "Target maintenance status serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/maintenance-statuses/mst_550e8400e29b41d4a716446655440001", "type": "string", "format": "iri-reference" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "is_default": { "description": "When true, this transition is treated as the workflow default where applicable.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" } } } ], "description": "Maintenance Status Transitions define the allowed transitions between maintenance statuses." }, "maintenance-statuses": { "type": "object", "description": "Maintenance Statuses are used to track the progress of maintenance.", "required": [ "id", "status_key", "is_enabled", "is_default", "name", "description", "public_label", "stage", "color", "icon", "public_color", "public_icon", "organization", "organization_id" ], "properties": { "id": { "description": "Maintenance status identifier.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "status_key": { "description": "Stable unique key for the status within the organization.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this status can be selected in workflows.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_default": { "description": "Whether this is the organization default initial maintenance status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "public_label": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "stage": { "description": "Lifecycle stage this maintenance status belongs to.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": "string", "enum": [ "draft", "scheduled", "in-progress", "post-maintenance", "closed" ] }, "color": { "description": "Dashboard color token for this status.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this status.", "externalDocs": { "url": "string" }, "example": "calendar", "type": "string" }, "public_color": { "description": "Public status-page color token for this maintenance status.", "externalDocs": { "url": "string" }, "example": "info", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "public_icon": { "description": "Public status-page icon token for this maintenance status.", "externalDocs": { "url": "string" }, "example": "calendar", "type": "string" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } }, "maintenance-statuses.CreateMaintenanceStatusData": { "type": "object", "description": "Maintenance Statuses are used to track the progress of maintenance.", "required": [ "status_key", "name", "public_label", "stage", "color", "icon", "public_color", "public_icon" ], "properties": { "status_key": { "description": "The unique key identifier for the maintenance status.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "public_label": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "stage": { "description": "The stage of the maintenance status.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": "string", "enum": [ "draft", "scheduled", "in-progress", "post-maintenance", "closed" ] }, "color": { "description": "The color associated with the maintenance status.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "The icon associated with the maintenance status.", "externalDocs": { "url": "string" }, "example": "calendar", "type": "string", "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down" ] }, "public_color": { "description": "The public-facing color associated with the maintenance status.", "externalDocs": { "url": "string" }, "example": "info", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "public_icon": { "description": "The public-facing icon associated with the maintenance status.", "externalDocs": { "url": "string" }, "example": "calendar", "type": "string", "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down" ] }, "is_enabled": { "description": "Whether the maintenance status is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } }, "maintenance-statuses.UpdateMaintenanceStatusData.jsonMergePatch": { "type": "object", "description": "Maintenance Statuses are used to track the progress of maintenance.", "properties": { "status_key": { "description": "The unique key identifier for the maintenance status.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "public_label": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "stage": { "description": "The stage of the maintenance status.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": [ "string", "null" ], "enum": [ "draft", "scheduled", "in-progress", "post-maintenance", "closed", null ] }, "color": { "description": "The color associated with the maintenance status.", "externalDocs": { "url": "string" }, "example": "blue", "type": [ "string", "null" ], "enum": [ "danger", "success", "warning", "info", "primary", "gray", null ] }, "icon": { "description": "The icon associated with the maintenance status.", "externalDocs": { "url": "string" }, "example": "calendar", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "public_color": { "description": "The public-facing color associated with the maintenance status.", "externalDocs": { "url": "string" }, "example": "info", "type": [ "string", "null" ], "enum": [ "danger", "success", "warning", "info", "primary", "gray", null ] }, "public_icon": { "description": "The public-facing icon associated with the maintenance status.", "externalDocs": { "url": "string" }, "example": "calendar", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "is_enabled": { "description": "Whether the maintenance status is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] } } }, "maintenance-statuses.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "status_key", "is_enabled", "is_default", "name", "description", "public_label", "stage", "color", "icon", "public_color", "public_icon", "organization", "organization_id" ], "properties": { "id": { "description": "Maintenance status identifier.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "status_key": { "description": "Stable unique key for the status within the organization.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this status can be selected in workflows.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_default": { "description": "Whether this is the organization default initial maintenance status.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation.jsonld" } }, "public_label": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "stage": { "description": "Lifecycle stage this maintenance status belongs to.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": "string", "enum": [ "draft", "scheduled", "in-progress", "post-maintenance", "closed" ] }, "color": { "description": "Dashboard color token for this status.", "externalDocs": { "url": "string" }, "example": "blue", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this status.", "externalDocs": { "url": "string" }, "example": "calendar", "type": "string" }, "public_color": { "description": "Public status-page color token for this maintenance status.", "externalDocs": { "url": "string" }, "example": "info", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "public_icon": { "description": "Public status-page icon token for this maintenance status.", "externalDocs": { "url": "string" }, "example": "calendar", "type": "string" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } } ], "description": "Maintenance Statuses are used to track the progress of maintenance." }, "maintenances": { "type": "object", "description": "Maintenances are scheduled maintenance windows that can affect system components.", "required": [ "id", "deduplication_key", "title", "public_summary", "status", "status_id", "organization", "organization_id", "planned_start_date", "planned_end_date", "is_downtime_expected", "is_suppressing_incidents", "is_component_status_auto_updated", "is_automatically_starting", "auto_start_grace_period", "is_automatically_ending", "auto_end_grace_period", "source" ], "properties": { "id": { "description": "Maintenance identifier.", "externalDocs": { "url": "string" }, "example": "mnt_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mnt_[0-9a-f]{32}$" }, "deduplication_key": { "description": "Unique key used to deduplicate maintenances within the organization while draft, scheduled, or in-progress.", "externalDocs": { "url": "string" }, "example": "database-maintenance-2024-01-15", "type": "string", "minLength": 5, "maxLength": 40, "pattern": "/^[a-z0-9-]+$/" }, "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "internal_summary": { "description": "Internal summary for dashboard users (not shown on the public status page).", "externalDocs": { "url": "string" }, "example": "Database upgrade to version 2.0.", "type": [ "string", "null" ], "minLength": 1, "maxLength": 2000 }, "status": { "description": "Current maintenance status serialized as an IRI reference pointing to the MaintenanceStatus resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/maintenance-statuses/mst_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_id": { "description": "Public identifier of the current maintenance status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "planned_start_date": { "description": "Planned maintenance start (organization-local semantics; serialized as ISO 8601).", "externalDocs": { "url": "string" }, "example": "2025-03-22T02:00:00.000000Z", "type": "string", "format": "date-time" }, "planned_end_date": { "description": "Planned maintenance end (organization-local semantics; serialized as ISO 8601).", "externalDocs": { "url": "string" }, "example": "2025-03-22T04:00:00.000000Z", "type": "string", "format": "date-time" }, "actual_start_date": { "description": "Actual start time when maintenance went in progress, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "actual_end_date": { "description": "Actual end time when maintenance finished, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "closed_at": { "description": "When the maintenance was closed, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "scheduled_at": { "description": "When the maintenance was scheduled for visibility, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "post_maintenance_at": { "description": "When the maintenance entered post-maintenance, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "is_downtime_expected": { "description": "Whether customer-facing messaging should reflect expected downtime. Stored on the maintenance and recomputed from affected components: true when any expected component status is partial_outage or full_outage. Not set independently via create or patch.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_suppressing_incidents": { "description": "Whether incidents are suppressed while this maintenance is active.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_component_status_auto_updated": { "description": "Whether affected component statuses update automatically on workflow transitions.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_automatically_starting": { "description": "Whether the platform may start this maintenance automatically when planned time is reached.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "auto_start_grace_period": { "description": "Grace period in minutes before automatic start.", "externalDocs": { "url": "integer" }, "example": 0, "type": "integer", "minimum": 0 }, "is_automatically_ending": { "description": "Whether the platform may end this maintenance automatically when planned end is reached.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "auto_end_grace_period": { "description": "Grace period in minutes before automatic end.", "externalDocs": { "url": "integer" }, "example": 0, "type": "integer", "minimum": 0 }, "source": { "description": "Origin of the maintenance record (dashboard, API, or monitor automation).", "externalDocs": { "url": "string" }, "example": "web", "type": "string", "enum": [ "web", "api", "monitor" ] }, "tags": { "description": "Tags used to categorize the maintenance.", "externalDocs": { "url": "array" }, "example": [ "production", "database" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Arbitrary string key/value metadata attached to the maintenance.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } } } }, "maintenances.CreateMaintenanceData": { "type": "object", "description": "Maintenances are scheduled maintenance windows that can affect system components.", "required": [ "deduplication_key", "title", "public_summary", "planned_start_date", "planned_end_date" ], "properties": { "deduplication_key": { "description": "A unique key to prevent duplicate maintenances within the organization while the maintenance is in draft, scheduled, or in-progress.", "externalDocs": { "url": "string" }, "example": "database-maintenance-2024-01-15", "type": "string", "minLength": 5, "maxLength": 40, "pattern": "/^[a-z0-9-]+$/" }, "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/Translation" } }, "internal_summary": { "description": "The internal summary of the maintenance for team members.", "externalDocs": { "url": "string" }, "example": "Database upgrade to version 2.0 with improved performance.", "type": "string", "minLength": 1, "maxLength": 2000 }, "planned_start_date": { "description": "The planned start date and time of the maintenance.", "externalDocs": { "url": "string" }, "example": "2024-01-15T02:00:00Z", "type": "string", "format": "date-time" }, "planned_end_date": { "description": "The planned end date and time of the maintenance.", "externalDocs": { "url": "string" }, "example": "2024-01-15T04:00:00Z", "type": "string", "format": "date-time" }, "tags": { "description": "Tags to categorize the maintenance.", "externalDocs": { "url": "array" }, "example": [ "production", "api", "critical" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Additional metadata for the maintenance.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1", "service": "api-gateway" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } }, "is_suppressing_incidents": { "description": "Whether incidents should be suppressed during maintenance.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_component_status_auto_updated": { "description": "Whether affected component maintenance statuses are updated automatically on stage transitions.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_automatically_starting": { "description": "Whether the maintenance should start automatically.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_automatically_ending": { "description": "Whether the maintenance should end automatically.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "auto_start_grace_period": { "description": "Grace period in minutes before auto-starting maintenance.", "externalDocs": { "url": "integer" }, "example": 0, "type": "integer" }, "auto_end_grace_period": { "description": "Grace period in minutes before auto-ending maintenance.", "externalDocs": { "url": "integer" }, "example": 0, "type": "integer" }, "affected_components": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMaintenanceAffectedComponentData" } } } }, "maintenances.CreateMaintenanceStatusUpdateData": { "type": "object", "description": "Maintenances are scheduled maintenance windows that can affect system components.", "required": [ "deduplication_key" ], "properties": { "deduplication_key": { "description": "A unique key to prevent duplicate status updates.", "externalDocs": { "url": "string" }, "example": "status-update-2024-01-15-001", "type": "string", "minLength": 5, "maxLength": 40, "pattern": "/^[a-z0-9-]+$/" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status update. When not provided, the default value is used.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "message": { "type": "array", "items": { "$ref": "#/components/schemas/Translation" } }, "new_status_id": { "description": "The ID of the new status to transition to.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$", "nullable": true }, "maintenance_data": { "anyOf": [ { "$ref": "#/components/schemas/UpdateMaintenanceData" }, { "type": "null" } ] } } }, "maintenances.UpdateMaintenanceAffectedComponentData": { "type": "object", "description": "Maintenances are scheduled maintenance windows that can affect system components.", "required": [ "component_id", "status", "expected_component_status" ], "properties": { "component_id": { "description": "The ID of the component affected by maintenance.", "externalDocs": { "url": "string" }, "example": "cmp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^cmp_[0-9a-f]{32}$" }, "status": { "description": "The maintenance status of the component.", "externalDocs": { "url": "string" }, "example": "scheduled", "type": "string", "enum": [ "scheduled", "in_progress", "completed", "skipped" ] }, "expected_component_status": { "description": "The expected status of the component during maintenance.", "externalDocs": { "url": "string" }, "example": "maintenance", "type": "string", "enum": [ "operational", "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] } } }, "maintenances.UpdateMaintenanceData.jsonMergePatch": { "type": "object", "description": "Maintenances are scheduled maintenance windows that can affect system components.", "properties": { "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "internal_summary": { "description": "The internal summary of the maintenance for team members.", "externalDocs": { "url": "string" }, "example": "Database upgrade to version 2.0 with improved performance.", "type": "string", "minLength": 1, "maxLength": 2000 }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/Translation" } }, "planned_start_date": { "description": "The planned start date and time of the maintenance.", "externalDocs": { "url": "string" }, "example": "2024-01-15T02:00:00Z", "type": [ "string", "null" ], "format": "date-time" }, "planned_end_date": { "description": "The planned end date and time of the maintenance.", "externalDocs": { "url": "string" }, "example": "2024-01-15T04:00:00Z", "type": [ "string", "null" ], "format": "date-time" }, "actual_start_date": { "description": "The actual start date and time of the maintenance.", "externalDocs": { "url": "string" }, "example": "2024-01-15T02:10:00Z", "type": [ "string", "null" ], "format": "date-time" }, "is_suppressing_incidents": { "description": "Whether incidents should be suppressed during maintenance.", "externalDocs": { "url": "boolean" }, "example": false, "type": [ "boolean", "null" ] }, "is_component_status_auto_updated": { "description": "Whether affected component maintenance statuses are updated automatically on stage transitions.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "is_automatically_starting": { "description": "Whether the maintenance should start automatically.", "externalDocs": { "url": "boolean" }, "example": false, "type": [ "boolean", "null" ] }, "is_automatically_ending": { "description": "Whether the maintenance should end automatically.", "externalDocs": { "url": "boolean" }, "example": false, "type": [ "boolean", "null" ] }, "auto_start_grace_period": { "description": "Grace period in minutes before auto-starting maintenance.", "externalDocs": { "url": "integer" }, "example": 0, "type": [ "integer", "null" ] }, "auto_end_grace_period": { "description": "Grace period in minutes before auto-ending maintenance.", "externalDocs": { "url": "integer" }, "example": 0, "type": [ "integer", "null" ] }, "tags": { "description": "Tags to categorize the maintenance.", "externalDocs": { "url": "array" }, "example": [ "database", "maintenance", "scheduled" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Additional metadata for the maintenance.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1", "service": "database" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } } } }, "maintenances.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "deduplication_key", "title", "public_summary", "status", "status_id", "organization", "organization_id", "planned_start_date", "planned_end_date", "is_downtime_expected", "is_suppressing_incidents", "is_component_status_auto_updated", "is_automatically_starting", "auto_start_grace_period", "is_automatically_ending", "auto_end_grace_period", "source" ], "properties": { "id": { "description": "Maintenance identifier.", "externalDocs": { "url": "string" }, "example": "mnt_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mnt_[0-9a-f]{32}$" }, "deduplication_key": { "description": "Unique key used to deduplicate maintenances within the organization while draft, scheduled, or in-progress.", "externalDocs": { "url": "string" }, "example": "database-maintenance-2024-01-15", "type": "string", "minLength": 5, "maxLength": 40, "pattern": "/^[a-z0-9-]+$/" }, "title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation.jsonld" } }, "internal_summary": { "description": "Internal summary for dashboard users (not shown on the public status page).", "externalDocs": { "url": "string" }, "example": "Database upgrade to version 2.0.", "type": [ "string", "null" ], "minLength": 1, "maxLength": 2000 }, "status": { "description": "Current maintenance status serialized as an IRI reference pointing to the MaintenanceStatus resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/maintenance-statuses/mst_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_id": { "description": "Public identifier of the current maintenance status.", "externalDocs": { "url": "string" }, "example": "mst_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mst_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "planned_start_date": { "description": "Planned maintenance start (organization-local semantics; serialized as ISO 8601).", "externalDocs": { "url": "string" }, "example": "2025-03-22T02:00:00.000000Z", "type": "string", "format": "date-time" }, "planned_end_date": { "description": "Planned maintenance end (organization-local semantics; serialized as ISO 8601).", "externalDocs": { "url": "string" }, "example": "2025-03-22T04:00:00.000000Z", "type": "string", "format": "date-time" }, "actual_start_date": { "description": "Actual start time when maintenance went in progress, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "actual_end_date": { "description": "Actual end time when maintenance finished, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "closed_at": { "description": "When the maintenance was closed, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "scheduled_at": { "description": "When the maintenance was scheduled for visibility, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "post_maintenance_at": { "description": "When the maintenance entered post-maintenance, if set.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "is_downtime_expected": { "description": "Whether customer-facing messaging should reflect expected downtime. Stored on the maintenance and recomputed from affected components: true when any expected component status is partial_outage or full_outage. Not set independently via create or patch.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_suppressing_incidents": { "description": "Whether incidents are suppressed while this maintenance is active.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_component_status_auto_updated": { "description": "Whether affected component statuses update automatically on workflow transitions.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_automatically_starting": { "description": "Whether the platform may start this maintenance automatically when planned time is reached.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "auto_start_grace_period": { "description": "Grace period in minutes before automatic start.", "externalDocs": { "url": "integer" }, "example": 0, "type": "integer", "minimum": 0 }, "is_automatically_ending": { "description": "Whether the platform may end this maintenance automatically when planned end is reached.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "auto_end_grace_period": { "description": "Grace period in minutes before automatic end.", "externalDocs": { "url": "integer" }, "example": 0, "type": "integer", "minimum": 0 }, "source": { "description": "Origin of the maintenance record (dashboard, API, or monitor automation).", "externalDocs": { "url": "string" }, "example": "web", "type": "string", "enum": [ "web", "api", "monitor" ] }, "tags": { "description": "Tags used to categorize the maintenance.", "externalDocs": { "url": "array" }, "example": [ "production", "database" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "metadata": { "description": "Arbitrary string key/value metadata attached to the maintenance.", "externalDocs": { "url": "object" }, "example": { "region": "us-east-1" }, "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } } } } ], "description": "Maintenances are scheduled maintenance windows that can affect system components." }, "monitor-correlation-groups": { "type": "object", "description": "Monitor correlation groups are used to group monitors together for incident correlation.", "required": [ "id", "is_enabled", "group_key", "name", "severity_level", "minimum_unhealthy_monitors_to_trigger_incident", "is_resolving_incident_automatically", "organization", "organization_id" ], "properties": { "id": { "description": "The ID of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "1", "type": "string" }, "is_enabled": { "description": "Whether the monitor correlation group is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "group_key": { "description": "The unique key of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "core-services", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "description": "The name of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "Dashboard", "type": "string", "maxLength": 40, "minLength": 2 }, "comment": { "description": "The comment helps to understand the purpose of the monitor correlation group. It is only visible internally.", "externalDocs": { "url": "string" }, "example": "The monitor tracks the availability of the dashboard.", "type": [ "string", "null" ], "maxLength": 255 }, "incident_title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "incident_public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/Translation" } }, "incident_internal_summary": { "description": "The internal summary is put on the incident created for the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "We are investigating the issue.", "type": [ "string", "null" ], "maxLength": 2000 }, "incident_tags": { "description": "The tags are put on the incident created for the monitor correlation group.", "externalDocs": { "url": "array" }, "example": [ "production", "region-eu-west-1" ], "type": "array", "items": { "type": "string" } }, "incident_metadata": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } }, "severity_level": { "description": "The severity level which is used for the incident created for the monitor correlation group.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "string", "null" ], "format": "iri-reference" }, "initial_incident_status": { "description": "The initial incident status which is used for the incident created for the monitor correlation group.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "string", "null" ], "format": "iri-reference" }, "minimum_unhealthy_monitors_to_trigger_incident": { "description": "The minimum number of unhealthy monitors to trigger an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer" }, "minimum_unhealthy_monitors_to_activate_incident": { "description": "The minimum number of unhealthy monitors to activate an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "is_resolving_incident_automatically": { "description": "Whether the incident is automatically resolved when the number of unhealthy monitors is below the maximum.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "maximum_unhealthy_monitors_to_resolve_incident": { "description": "The maximum number of unhealthy monitors to resolve an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } }, "monitor-correlation-groups.CreateMonitorCorrelationGroupData": { "type": "object", "description": "Monitor correlation groups are used to group monitors together for incident correlation.", "required": [ "severity_level_id", "group_key", "name" ], "properties": { "severity_level_id": { "description": "The ID of the severity level.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sev_[0-9a-f]{32}$" }, "group_key": { "description": "The unique key of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "core-services", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "description": "The name of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "Dashboard", "type": "string", "maxLength": 40, "minLength": 2 }, "comment": { "description": "The comment helps to understand the purpose of the monitor correlation group. It is only visible internally.", "externalDocs": { "url": "string" }, "example": "The monitor tracks the availability of the dashboard.", "type": [ "string", "null" ], "maxLength": 255 }, "incident_title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "incident_public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "incident_internal_summary": { "description": "The internal summary is put on the incident created for the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "We are investigating the issue.", "type": [ "string", "null" ], "maxLength": 2000 }, "incident_tags": { "description": "The tags are put on the incident created for the monitor correlation group.", "externalDocs": { "url": "array" }, "example": [ "production", "region-eu-west-1" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "incident_metadata": { "description": "The metadata is put on the incident created for the monitor correlation group. The key must be between 3 and 20 characters and can only contain letters, numbers, and underscores. The value must be between 1 and 1000 characters.", "externalDocs": { "url": "object" }, "example": { "key": "value" }, "type": "object", "additionalProperties": { "type": "string" } }, "is_enabled": { "description": "Whether the monitor correlation group is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "initial_incident_status_id": { "description": "The ID of the initial incident status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440003", "type": "string", "pattern": "^ist_[0-9a-f]{32}$", "nullable": true }, "minimum_unhealthy_monitors_to_trigger_incident": { "description": "The minimum number of unhealthy monitors to trigger an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer" }, "minimum_unhealthy_monitors_to_activate_incident": { "description": "The minimum number of unhealthy monitors to activate an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "is_resolving_incident_automatically": { "description": "Whether the incident is automatically resolved when the number of unhealthy monitors is below the maximum.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "maximum_unhealthy_monitors_to_resolve_incident": { "description": "The maximum number of unhealthy monitors to resolve an incident.", "externalDocs": { "url": "integer" }, "example": 0, "type": [ "integer", "null" ] } } }, "monitor-correlation-groups.UpdateMonitorCorrelationGroupData.jsonMergePatch": { "type": "object", "description": "Monitor correlation groups are used to group monitors together for incident correlation.", "properties": { "group_key": { "description": "The unique key of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "core-services", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "description": "The name of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "Dashboard", "type": [ "string", "null" ], "maxLength": 40, "minLength": 2 }, "comment": { "description": "The comment helps to understand the purpose of the monitor correlation group. It is only visible internally.", "externalDocs": { "url": "string" }, "example": "The monitor tracks the availability of the dashboard.", "type": [ "string", "null" ], "maxLength": 255 }, "incident_title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "incident_public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "incident_internal_summary": { "description": "The internal summary is put on the incident created for the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "We are investigating the issue.", "type": [ "string", "null" ], "maxLength": 2000 }, "incident_tags": { "description": "The tags are put on the incident created for the monitor correlation group.", "externalDocs": { "url": "array" }, "example": [ "production", "region-eu-west-1" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "incident_metadata": { "description": "The metadata is put on the incident created for the monitor correlation group. The key must be between 3 and 20 characters and can only contain letters, numbers, and underscores. The value must be between 1 and 1000 characters.", "externalDocs": { "url": "object" }, "example": { "key": "value" }, "type": "object", "additionalProperties": { "type": "string" } }, "is_enabled": { "description": "Whether the monitor correlation group is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "severity_level_id": { "description": "The ID of the severity level.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sev_[0-9a-f]{32}$", "nullable": true }, "initial_incident_status_id": { "description": "The ID of the initial incident status.", "externalDocs": { "url": "string" }, "example": "ist_550e8400e29b41d4a716446655440003", "type": "string", "pattern": "^ist_[0-9a-f]{32}$", "nullable": true }, "minimum_unhealthy_monitors_to_trigger_incident": { "description": "The minimum number of unhealthy monitors to trigger an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "minimum_unhealthy_monitors_to_activate_incident": { "description": "The minimum number of unhealthy monitors to activate an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "is_resolving_incident_automatically": { "description": "Whether the incident is automatically resolved when the number of unhealthy monitors is below the maximum.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "maximum_unhealthy_monitors_to_resolve_incident": { "description": "The maximum number of unhealthy monitors to resolve an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] } } }, "monitor-correlation-groups.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "is_enabled", "group_key", "name", "severity_level", "minimum_unhealthy_monitors_to_trigger_incident", "is_resolving_incident_automatically", "organization", "organization_id" ], "properties": { "id": { "description": "The ID of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "1", "type": "string" }, "is_enabled": { "description": "Whether the monitor correlation group is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "group_key": { "description": "The unique key of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "core-services", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "description": "The name of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "Dashboard", "type": "string", "maxLength": 40, "minLength": 2 }, "comment": { "description": "The comment helps to understand the purpose of the monitor correlation group. It is only visible internally.", "externalDocs": { "url": "string" }, "example": "The monitor tracks the availability of the dashboard.", "type": [ "string", "null" ], "maxLength": 255 }, "incident_title": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "incident_public_summary": { "type": "array", "items": { "$ref": "#/components/schemas/Translation.jsonld" } }, "incident_internal_summary": { "description": "The internal summary is put on the incident created for the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "We are investigating the issue.", "type": [ "string", "null" ], "maxLength": 2000 }, "incident_tags": { "description": "The tags are put on the incident created for the monitor correlation group.", "externalDocs": { "url": "array" }, "example": [ "production", "region-eu-west-1" ], "type": "array", "items": { "type": "string" } }, "incident_metadata": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } }, "severity_level": { "description": "The severity level which is used for the incident created for the monitor correlation group.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "string", "null" ], "format": "iri-reference" }, "initial_incident_status": { "description": "The initial incident status which is used for the incident created for the monitor correlation group.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "string", "null" ], "format": "iri-reference" }, "minimum_unhealthy_monitors_to_trigger_incident": { "description": "The minimum number of unhealthy monitors to trigger an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer" }, "minimum_unhealthy_monitors_to_activate_incident": { "description": "The minimum number of unhealthy monitors to activate an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "is_resolving_incident_automatically": { "description": "Whether the incident is automatically resolved when the number of unhealthy monitors is below the maximum.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "maximum_unhealthy_monitors_to_resolve_incident": { "description": "The maximum number of unhealthy monitors to resolve an incident.", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } } ], "description": "Monitor correlation groups are used to group monitors together for incident correlation." }, "monitor-types": { "type": "object", "description": "Each monitor has a type. The type determines how the status of the monitor is updated. Each type has a dedicated configuration.", "required": [ "id", "name", "description", "configuration_definitions" ], "properties": { "id": { "description": "Monitor type identifier (stable key).", "externalDocs": { "url": "string" }, "example": "http", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "name": { "description": "Short display name of the monitor type in the dashboard.", "externalDocs": { "url": "string" }, "example": "HTTP(S)", "type": "string", "minLength": 2, "maxLength": 40 }, "description": { "description": "Longer description of what this monitor type measures and how it is used.", "externalDocs": { "url": "string" }, "example": "Checks reachability and response of an HTTP or HTTPS endpoint.", "type": "string", "minLength": 2, "maxLength": 255 }, "configuration_definitions": { "type": "array", "items": { "$ref": "#/components/schemas/MonitorConfigurationDefinition" } } } }, "monitor-types.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "name", "description", "configuration_definitions" ], "properties": { "id": { "description": "Monitor type identifier (stable key).", "externalDocs": { "url": "string" }, "example": "http", "type": "string", "pattern": "^[a-z0-9\\-]{3,40}$", "minLength": 3, "maxLength": 40 }, "name": { "description": "Short display name of the monitor type in the dashboard.", "externalDocs": { "url": "string" }, "example": "HTTP(S)", "type": "string", "minLength": 2, "maxLength": 40 }, "description": { "description": "Longer description of what this monitor type measures and how it is used.", "externalDocs": { "url": "string" }, "example": "Checks reachability and response of an HTTP or HTTPS endpoint.", "type": "string", "minLength": 2, "maxLength": 255 }, "configuration_definitions": { "type": "array", "items": { "$ref": "#/components/schemas/MonitorConfigurationDefinition.jsonld" } } } } ], "description": "Each monitor has a type. The type determines how the status of the monitor is updated. Each type has a dedicated configuration." }, "monitors": { "type": "object", "description": "Monitors are used to track the health of specific applications or services.", "required": [ "id", "type", "type_id", "configuration", "monitor_key", "is_enabled", "name", "status", "last_status_change_at", "correlation_group", "correlation_group_id", "is_force_triggering_incident", "is_force_activating_incident", "organization", "organization_id" ], "properties": { "id": { "description": "Monitor identifier.", "externalDocs": { "url": "string" }, "example": "mon_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mon_[0-9a-f]{32}$" }, "type": { "description": "Monitor type serialized as an IRI reference pointing to the MonitorType resource.", "example": "/monitor-types/pingdom", "type": "string", "format": "iri-reference" }, "type_id": { "description": "Monitor type identifier (same as the MonitorType resource id; one of the values from GET /monitor-types).", "externalDocs": { "url": "string" }, "example": "pingdom", "type": "string", "enum": [ "generic", "pingdom", "grafana" ] }, "configuration": { "description": "Type-specific configuration object. Shape depends on monitor type; see GET /monitor-types for JSON Schema-style definitions.", "externalDocs": { "url": "object" }, "example": { "endpoint": "https://example.com/health" }, "type": "object", "additionalProperties": true }, "monitor_key": { "description": "Stable unique key for the monitor within the organization.", "externalDocs": { "url": "string" }, "example": "api-server-pingdom-001", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether health checks are active for this monitor.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "name": { "description": "Human-readable monitor name shown in the dashboard.", "externalDocs": { "url": "string" }, "example": "API Server Pingdom Monitor", "type": "string", "minLength": 2, "maxLength": 40 }, "comment": { "description": "Optional operator notes for this monitor.", "externalDocs": { "url": "string" }, "example": "Primary production check", "type": [ "string", "null" ], "minLength": 2, "maxLength": 255 }, "status": { "description": "Last computed health state from monitor callbacks.", "externalDocs": { "url": "string" }, "example": "healthy", "type": "string", "enum": [ "healthy", "unhealthy" ] }, "last_status_change_at": { "description": "ISO 8601 timestamp of the last monitor status change.", "externalDocs": { "url": "string" }, "example": "2025-03-22T12:00:00.000000Z", "type": "string", "format": "date-time" }, "force_severity_level": { "description": "Optional severity level override when this monitor forces incident severity; IRI reference to SeverityLevel.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/severity-levels/sev_550e8400e29b41d4a716446655440000", "type": [ "string", "null" ], "format": "iri-reference" }, "force_severity_level_id": { "description": "Public id of the forced severity level when set; null when the monitor does not override severity.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": [ "string", "null" ], "pattern": "^sev_[0-9a-f]{32}$" }, "correlation_group": { "description": "Monitor correlation group serialized as an IRI reference pointing to the MonitorCorrelationGroup resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/monitor-correlation-groups/mcg_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "correlation_group_id": { "description": "Public identifier of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "mcg_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mcg_[0-9a-f]{32}$" }, "is_force_triggering_incident": { "description": "When true, this monitor may open a new incident when unhealthy.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_force_activating_incident": { "description": "When true, this monitor may activate an existing incident when unhealthy.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "installation_instructions": { "description": "Rendered installation instructions for this monitor type, or null when none apply.", "externalDocs": { "url": "object" }, "type": [ "object", "null" ], "properties": { "text": { "type": "string", "description": "Instruction template text with placeholders." }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Placeholder values keyed by placeholder name." } } }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } }, "monitors.CreateMonitorData": { "type": "object", "description": "Monitors are used to track the health of specific applications or services.", "required": [ "monitor_key", "correlation_group_id", "component_ids", "type", "name" ], "properties": { "monitor_key": { "description": "The unique key identifier for the monitor.", "externalDocs": { "url": "string" }, "example": "api-server-pingdom-001", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "correlation_group_id": { "description": "The ID of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "mcg_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mcg_[0-9a-f]{32}$" }, "component_ids": { "description": "Public IDs of components that can be affected by this monitor.", "externalDocs": { "url": "array" }, "example": [ "cmp_550e8400e29b41d4a716446655440001", "cmp_550e8400e29b41d4a716446655440002" ], "type": "array", "items": { "type": "string", "pattern": "^cmp_[0-9a-f]{32}$" } }, "type": { "description": "Identifier of the monitor type resource.", "externalDocs": { "url": "string" }, "example": "pingdom", "type": "string", "x-related-resource": "#/components/schemas/MonitorType", "x-related-path": "/monitor-types/{id}", "format": "string" }, "name": { "description": "The name of the monitor.", "externalDocs": { "url": "string" }, "example": "API Server Pingdom Monitor", "type": "string", "minLength": 2, "maxLength": 40 }, "configuration": { "description": "The configuration of the monitor. Use the dedicated endpoint to get the configurations that are available for the monitor type.", "externalDocs": { "url": "array" }, "example": { "key": "value" }, "type": "array", "items": { "type": [ "string", "null" ] } }, "comment": { "description": "A comment about the monitor for internal use.", "externalDocs": { "url": "string" }, "example": "Monitors the main API server endpoint", "type": "string", "minLength": 2, "maxLength": 255 }, "is_enabled": { "description": "Whether the monitor is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "force_severity_level_id": { "description": "The ID of the severity level to force when this monitor fails.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440003", "type": "string", "pattern": "^sev_[0-9a-f]{32}$", "nullable": true }, "is_force_triggering_incident": { "description": "Whether this monitor should force trigger an incident.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_force_activating_incident": { "description": "Whether this monitor should force activate an incident.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "component_status": { "description": "The component status to set when this monitor becomes unhealthy.", "externalDocs": { "url": "string" }, "example": "under_investigation", "type": "string", "enum": [ "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] }, "type_as_enum": { "type": "string", "enum": [ "generic", "pingdom", "grafana" ] } } }, "monitors.UpdateMonitorData.jsonMergePatch": { "type": "object", "description": "Monitors are used to track the health of specific applications or services.", "properties": { "configuration": { "description": "The configuration of the monitor. Use the dedicated endpoint to get the configurations that are available for the monitor type.", "externalDocs": { "url": "array" }, "example": { "key": "value" }, "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "name": { "description": "The name of the monitor.", "externalDocs": { "url": "string" }, "example": "API Server Pingdom Monitor", "type": "string", "minLength": 2, "maxLength": 40 }, "comment": { "description": "A comment about the monitor for internal use.", "externalDocs": { "url": "string" }, "example": "Monitors the main API server endpoint", "type": "string", "minLength": 2, "maxLength": 255 }, "is_enabled": { "description": "Whether the monitor is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "force_severity_level_id": { "description": "The ID of the severity level.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440003", "type": "string", "pattern": "^sev_[0-9a-f]{32}$", "nullable": true }, "correlation_group_id": { "description": "The ID of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "mcg_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mcg_[0-9a-f]{32}$", "nullable": true }, "is_force_triggering_incident": { "description": "Whether this monitor should force trigger an incident.", "externalDocs": { "url": "boolean" }, "example": false, "type": [ "boolean", "null" ] }, "is_force_activating_incident": { "description": "Whether this monitor should force activate an incident.", "externalDocs": { "url": "boolean" }, "example": false, "type": [ "boolean", "null" ] }, "component_ids": { "description": "Public IDs of components that can be affected by this monitor.", "externalDocs": { "url": "array" }, "example": [ "cmp_550e8400e29b41d4a716446655440001", "cmp_550e8400e29b41d4a716446655440002" ], "type": "array", "items": { "type": "string", "pattern": "^cmp_[0-9a-f]{32}$" }, "nullable": true }, "component_status": { "description": "The component status to set when this monitor becomes unhealthy.", "externalDocs": { "url": "string" }, "example": "under_investigation", "type": "string", "enum": [ "under_investigation", "degraded_performance", "partial_outage", "full_outage" ] } } }, "monitors.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "type", "type_id", "configuration", "monitor_key", "is_enabled", "name", "status", "last_status_change_at", "correlation_group", "correlation_group_id", "is_force_triggering_incident", "is_force_activating_incident", "organization", "organization_id" ], "properties": { "id": { "description": "Monitor identifier.", "externalDocs": { "url": "string" }, "example": "mon_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mon_[0-9a-f]{32}$" }, "type": { "description": "Monitor type serialized as an IRI reference pointing to the MonitorType resource.", "example": "/monitor-types/pingdom", "type": "string", "format": "iri-reference" }, "type_id": { "description": "Monitor type identifier (same as the MonitorType resource id; one of the values from GET /monitor-types).", "externalDocs": { "url": "string" }, "example": "pingdom", "type": "string", "enum": [ "generic", "pingdom", "grafana" ] }, "configuration": { "description": "Type-specific configuration object. Shape depends on monitor type; see GET /monitor-types for JSON Schema-style definitions.", "externalDocs": { "url": "object" }, "example": { "endpoint": "https://example.com/health" }, "type": "object", "additionalProperties": true }, "monitor_key": { "description": "Stable unique key for the monitor within the organization.", "externalDocs": { "url": "string" }, "example": "api-server-pingdom-001", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether health checks are active for this monitor.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "name": { "description": "Human-readable monitor name shown in the dashboard.", "externalDocs": { "url": "string" }, "example": "API Server Pingdom Monitor", "type": "string", "minLength": 2, "maxLength": 40 }, "comment": { "description": "Optional operator notes for this monitor.", "externalDocs": { "url": "string" }, "example": "Primary production check", "type": [ "string", "null" ], "minLength": 2, "maxLength": 255 }, "status": { "description": "Last computed health state from monitor callbacks.", "externalDocs": { "url": "string" }, "example": "healthy", "type": "string", "enum": [ "healthy", "unhealthy" ] }, "last_status_change_at": { "description": "ISO 8601 timestamp of the last monitor status change.", "externalDocs": { "url": "string" }, "example": "2025-03-22T12:00:00.000000Z", "type": "string", "format": "date-time" }, "force_severity_level": { "description": "Optional severity level override when this monitor forces incident severity; IRI reference to SeverityLevel.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/severity-levels/sev_550e8400e29b41d4a716446655440000", "type": [ "string", "null" ], "format": "iri-reference" }, "force_severity_level_id": { "description": "Public id of the forced severity level when set; null when the monitor does not override severity.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": [ "string", "null" ], "pattern": "^sev_[0-9a-f]{32}$" }, "correlation_group": { "description": "Monitor correlation group serialized as an IRI reference pointing to the MonitorCorrelationGroup resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/monitor-correlation-groups/mcg_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "correlation_group_id": { "description": "Public identifier of the monitor correlation group.", "externalDocs": { "url": "string" }, "example": "mcg_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mcg_[0-9a-f]{32}$" }, "is_force_triggering_incident": { "description": "When true, this monitor may open a new incident when unhealthy.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "is_force_activating_incident": { "description": "When true, this monitor may activate an existing incident when unhealthy.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "installation_instructions": { "description": "Rendered installation instructions for this monitor type, or null when none apply.", "externalDocs": { "url": "object" }, "type": [ "object", "null" ], "properties": { "text": { "type": "string", "description": "Instruction template text with placeholders." }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Placeholder values keyed by placeholder name." } } }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } } ], "description": "Monitors are used to track the health of specific applications or services." }, "organization_configuration_exports": { "type": "object", "description": "Asynchronous organization configuration exports.", "required": [ "id", "status", "selections", "organization", "organization_id" ], "properties": { "id": { "description": "Export job identifier.", "externalDocs": { "url": "string" }, "example": "oce_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^oce_[0-9a-f]{32}$" }, "status": { "description": "Current processing state of the export job.", "externalDocs": { "url": "string" }, "example": "queued", "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "selections": { "description": "Selected records per domain used for this export.", "externalDocs": { "url": "array" }, "example": [ { "domain_key": "severity_levels", "record_ids": [ "1", "2" ] } ], "type": "array", "items": { "type": "object", "required": [ "domain_key" ], "properties": { "domain_key": { "type": "string", "enum": [ "incident_statuses", "maintenance_statuses", "severity_levels", "themes", "components", "monitor_correlation_groups", "status_pages", "webhook_subscriptions", "monitors" ], "example": "severity_levels", "minLength": 6, "maxLength": 26 }, "record_ids": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^\\d+$", "example": "1", "minLength": 1, "maxLength": 20 }, "example": [ "1", "2" ] } } } }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "initiated_by_user_id": { "description": "User identifier of the account that queued the export.", "externalDocs": { "url": "string" }, "example": "usr_550e8400e29b41d4a716446655440000", "type": [ "string", "null" ], "pattern": "^usr_[0-9a-f]{32}$" }, "error_message": { "description": "Error message captured when export processing fails.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ] }, "download_url": { "description": "Temporary download URL for the finished export archive.", "externalDocs": { "url": "string" }, "example": "https://files.example.com/organization-config/exports/acme-20260320-221500-abcdefgh.zip", "type": [ "string", "null" ], "format": "uri" } } }, "organization_configuration_exports.CreateOrganizationConfigExportJobData": { "type": "object", "description": "Asynchronous organization configuration exports.", "required": [ "selections" ], "properties": { "selections": { "description": "Domain selections to export.", "example": [ { "domain_key": "severity_levels", "record_ids": [ "sev_550e8400e29b41d4a716446655440000", "sev_660e8400e29b41d4a716446655440001" ] }, { "domain_key": "status_pages", "record_ids": null } ], "type": "array", "items": { "type": "object", "description": "One export domain selection.", "example": { "domain_key": "severity_levels", "record_ids": [ "sev_550e8400e29b41d4a716446655440000" ] }, "required": [ "domain_key" ], "properties": { "domain_key": { "type": "string", "description": "Domain key to export.", "enum": [ "incident_statuses", "maintenance_statuses", "severity_levels", "themes", "components", "monitor_correlation_groups", "status_pages", "webhook_subscriptions", "monitors" ], "example": "severity_levels", "minLength": 6, "maxLength": 26 }, "record_ids": { "type": [ "array", "null" ], "description": "Optional record IDs in public prefixed form for that domain (e.g. `sev_` + 32 hex) or canonical UUID. Use null to export all records.", "items": { "type": "string", "description": "Identifier of a record in the selected domain.", "example": "sev_550e8400e29b41d4a716446655440000", "pattern": "^([a-z]{2,4}_[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$", "minLength": 32, "maxLength": 40 }, "example": [ "sev_550e8400e29b41d4a716446655440000" ] } } } } } }, "organization_configuration_exports.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "status", "selections", "organization", "organization_id" ], "properties": { "id": { "description": "Export job identifier.", "externalDocs": { "url": "string" }, "example": "oce_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^oce_[0-9a-f]{32}$" }, "status": { "description": "Current processing state of the export job.", "externalDocs": { "url": "string" }, "example": "queued", "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "selections": { "description": "Selected records per domain used for this export.", "externalDocs": { "url": "array" }, "example": [ { "domain_key": "severity_levels", "record_ids": [ "1", "2" ] } ], "type": "array", "items": { "type": "object", "required": [ "domain_key" ], "properties": { "domain_key": { "type": "string", "enum": [ "incident_statuses", "maintenance_statuses", "severity_levels", "themes", "components", "monitor_correlation_groups", "status_pages", "webhook_subscriptions", "monitors" ], "example": "severity_levels", "minLength": 6, "maxLength": 26 }, "record_ids": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^\\d+$", "example": "1", "minLength": 1, "maxLength": 20 }, "example": [ "1", "2" ] } } } }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "initiated_by_user_id": { "description": "User identifier of the account that queued the export.", "externalDocs": { "url": "string" }, "example": "usr_550e8400e29b41d4a716446655440000", "type": [ "string", "null" ], "pattern": "^usr_[0-9a-f]{32}$" }, "error_message": { "description": "Error message captured when export processing fails.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ] }, "download_url": { "description": "Temporary download URL for the finished export archive.", "externalDocs": { "url": "string" }, "example": "https://files.example.com/organization-config/exports/acme-20260320-221500-abcdefgh.zip", "type": [ "string", "null" ], "format": "uri" } } } ], "description": "Asynchronous organization configuration exports." }, "organization_configuration_imports": { "type": "object", "description": "Asynchronous organization configuration imports.", "required": [ "id", "status", "is_dry_run", "organization", "organization_id" ], "properties": { "id": { "description": "Import job identifier.", "externalDocs": { "url": "string" }, "example": "oci_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^oci_[0-9a-f]{32}$" }, "status": { "description": "Current processing state of the import job.", "externalDocs": { "url": "string" }, "example": "queued", "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "is_dry_run": { "description": "When true, the import validates the archive without persisting changes.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "initiated_by_user_id": { "description": "User identifier of the account that queued the import.", "externalDocs": { "url": "string" }, "example": "usr_550e8400e29b41d4a716446655440000", "type": [ "string", "null" ], "pattern": "^usr_[0-9a-f]{32}$" }, "error_message": { "description": "Error message captured when import processing fails.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ] }, "result": { "description": "Structured summary of import outcomes when completed (shape varies by archive content).", "externalDocs": { "url": "object" }, "example": { "imported": { "severity_levels": 3 } }, "type": [ "object", "null" ], "additionalProperties": true } } }, "organization_configuration_imports.CreateOrganizationConfigImportJobData": { "type": "object", "description": "Asynchronous organization configuration imports.", "required": [ "object_key" ], "properties": { "object_key": { "description": "Object key for the uploaded ZIP archive. Obtain this value from POST /organizations/{organization_id}/configuration/import-upload-url and then upload the file to the returned temporary URL before creating the import.", "type": "string" }, "is_dry_run": { "description": "Run import as dry-run transaction.", "type": "boolean" } } }, "organization_configuration_imports.OrganizationConfigImportUploadUrlData": { "type": "object", "description": "Asynchronous organization configuration imports.", "properties": { "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "object_key": { "type": "string" }, "expires_at": { "type": "string" } } }, "organization_configuration_imports.OrganizationConfigImportUploadUrlData.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "object_key": { "type": "string" }, "expires_at": { "type": "string" } } } ], "description": "Asynchronous organization configuration imports." }, "organization_configuration_imports.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "status", "is_dry_run", "organization", "organization_id" ], "properties": { "id": { "description": "Import job identifier.", "externalDocs": { "url": "string" }, "example": "oci_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^oci_[0-9a-f]{32}$" }, "status": { "description": "Current processing state of the import job.", "externalDocs": { "url": "string" }, "example": "queued", "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "is_dry_run": { "description": "When true, the import validates the archive without persisting changes.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "initiated_by_user_id": { "description": "User identifier of the account that queued the import.", "externalDocs": { "url": "string" }, "example": "usr_550e8400e29b41d4a716446655440000", "type": [ "string", "null" ], "pattern": "^usr_[0-9a-f]{32}$" }, "error_message": { "description": "Error message captured when import processing fails.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ] }, "result": { "description": "Structured summary of import outcomes when completed (shape varies by archive content).", "externalDocs": { "url": "object" }, "example": { "imported": { "severity_levels": 3 } }, "type": [ "object", "null" ], "additionalProperties": true } } } ], "description": "Asynchronous organization configuration imports." }, "organizations": { "type": "object", "description": "Organizations form the foundation of Incido. All the data is organized into organizations.", "required": [ "id", "name" ], "properties": { "id": { "description": "Organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "name": { "description": "Display name of the organization.", "externalDocs": { "url": "string" }, "example": "Acme Corp", "type": "string", "minLength": 2, "maxLength": 40 }, "email": { "description": "Billing or contact email for the organization, if set.", "externalDocs": { "url": "string" }, "example": "billing@acme.example", "type": [ "string", "null" ], "format": "email", "minLength": 5, "maxLength": 255 }, "default_locale": { "description": "Default locale used for dashboard and notification defaults (BCP 47 style, e.g. en_US).", "externalDocs": { "url": "string" }, "example": "en_US", "type": [ "string", "null" ], "minLength": 2, "maxLength": 6 }, "languages": { "description": "Languages enabled for this organization. The language does not contain a locale.", "externalDocs": { "url": "array" }, "example": [ "en", "de" ], "type": [ "array", "null" ], "items": { "type": "string", "minLength": 2, "maxLength": 3 } } } }, "organizations.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "description": "Organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "name": { "description": "Display name of the organization.", "externalDocs": { "url": "string" }, "example": "Acme Corp", "type": "string", "minLength": 2, "maxLength": 40 }, "email": { "description": "Billing or contact email for the organization, if set.", "externalDocs": { "url": "string" }, "example": "billing@acme.example", "type": [ "string", "null" ], "format": "email", "minLength": 5, "maxLength": 255 }, "default_locale": { "description": "Default locale used for dashboard and notification defaults (BCP 47 style, e.g. en_US).", "externalDocs": { "url": "string" }, "example": "en_US", "type": [ "string", "null" ], "minLength": 2, "maxLength": 6 }, "languages": { "description": "Languages enabled for this organization. The language does not contain a locale.", "externalDocs": { "url": "array" }, "example": [ "en", "de" ], "type": [ "array", "null" ], "items": { "type": "string", "minLength": 2, "maxLength": 3 } } } } ], "description": "Organizations form the foundation of Incido. All the data is organized into organizations." }, "severity-levels": { "type": "object", "description": "Severity Levels are used to categorize the severity of incidents.", "required": [ "id", "severity_level_key", "is_enabled", "is_default", "name", "description", "order", "color", "icon", "organization", "organization_id" ], "properties": { "id": { "description": "Severity level identifier.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sev_[0-9a-f]{32}$" }, "severity_level_key": { "description": "Stable unique key for the severity level within the organization.", "externalDocs": { "url": "string" }, "example": "critical", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this severity level can be selected for new incidents.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_default": { "description": "Whether this is the organization default severity level.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "order": { "description": "Sort order for display (lower numbers are shown as more severe).", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer", "minimum": 0 }, "color": { "description": "Dashboard color token for this severity level.", "externalDocs": { "url": "string" }, "example": "danger", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this severity level.", "externalDocs": { "url": "string" }, "example": "exclamation-triangle", "type": "string" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } }, "severity-levels.CreateSeverityLevelData": { "type": "object", "description": "Severity Levels are used to categorize the severity of incidents.", "required": [ "severity_level_key", "name", "order", "color", "icon" ], "properties": { "severity_level_key": { "description": "The unique key identifier for the severity level.", "externalDocs": { "url": "string" }, "example": "critical", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "order": { "description": "The order of the severity level (lower numbers = higher severity).", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer" }, "color": { "description": "The color associated with the severity level.", "externalDocs": { "url": "string" }, "example": "red", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "The icon associated with the severity level.", "externalDocs": { "url": "string" }, "example": "exclamation-triangle", "type": "string", "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down" ] }, "is_enabled": { "description": "Whether the severity level is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } }, "severity-levels.UpdateSeverityLevelData.jsonMergePatch": { "type": "object", "description": "Severity Levels are used to categorize the severity of incidents.", "properties": { "severity_level_key": { "description": "The unique key identifier for the severity level.", "externalDocs": { "url": "string" }, "example": "critical", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation" } }, "order": { "description": "The order of the severity level (lower numbers = higher severity).", "externalDocs": { "url": "integer" }, "example": 1, "type": [ "integer", "null" ] }, "color": { "description": "The color associated with the severity level.", "externalDocs": { "url": "string" }, "example": "red", "type": [ "string", "null" ], "enum": [ "danger", "success", "warning", "info", "primary", "gray", null ] }, "icon": { "description": "The icon associated with the severity level.", "externalDocs": { "url": "string" }, "example": "exclamation-triangle", "type": [ "string", "null" ], "enum": [ "information", "cross", "check-circle", "document", "clock", "document-check", "pause", "play", "calendar", "arrow-path", "document-duplicate", "document-plus", "magnifying-glass", "question-mark", "fire", "exclamation", "minus", "flag", "flash", "flash-slash", "arrow-trending-down", "arrow-trending-up", "star", "pencil", "bell", "bell-alert", "bell-slash", "envelope", "envelope-open", "tag", "bookmark", "bookmark-slash", "lock-closed", "lock-open", "eye", "eye-slash", "arrow-left", "arrow-right", "arrow-up", "arrow-down", null ] }, "is_enabled": { "description": "Whether the severity level is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] } } }, "severity-levels.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "severity_level_key", "is_enabled", "is_default", "name", "description", "order", "color", "icon", "organization", "organization_id" ], "properties": { "id": { "description": "Severity level identifier.", "externalDocs": { "url": "string" }, "example": "sev_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sev_[0-9a-f]{32}$" }, "severity_level_key": { "description": "Stable unique key for the severity level within the organization.", "externalDocs": { "url": "string" }, "example": "critical", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether this severity level can be selected for new incidents.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "is_default": { "description": "Whether this is the organization default severity level.", "externalDocs": { "url": "boolean" }, "example": false, "type": "boolean" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TitleTranslation.jsonld" } }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTranslation.jsonld" } }, "order": { "description": "Sort order for display (lower numbers are shown as more severe).", "externalDocs": { "url": "integer" }, "example": 1, "type": "integer", "minimum": 0 }, "color": { "description": "Dashboard color token for this severity level.", "externalDocs": { "url": "string" }, "example": "danger", "type": "string", "enum": [ "danger", "success", "warning", "info", "primary", "gray" ] }, "icon": { "description": "Dashboard icon token for this severity level.", "externalDocs": { "url": "string" }, "example": "exclamation-triangle", "type": "string" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } } ], "description": "Severity Levels are used to categorize the severity of incidents." }, "status-page-custom-domains": { "type": "object", "description": "Custom domain lifecycle records for status pages.", "required": [ "id", "organization", "organization_id", "status_page", "status_page_id", "hostname", "state" ], "properties": { "id": { "description": "Custom domain record identifier.", "externalDocs": { "url": "string" }, "example": "scd_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^scd_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "status_page": { "description": "Status page this custom domain is attached to, serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/status-pages/stp_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_page_id": { "description": "Status page identifier for this custom domain.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "hostname": { "description": "Requested hostname for the status page (FQDN).", "externalDocs": { "url": "string" }, "example": "status.example.com", "type": "string", "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\\.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))*$" }, "state": { "description": "Lifecycle state of the custom domain in Incido and the certificate/DNS workflow.", "externalDocs": { "url": "string" }, "example": "pending_verification", "type": "string", "enum": [ "pending_verification", "active", "deprovision_pending", "deprovision_failed", "removed" ] }, "provider_status": { "description": "Provider-specific status text from the TLS/DNS integration, if any.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "maxLength": 2000 }, "dns_target_records": { "description": "DNS records the customer should configure (traffic routing, validation, etc.).", "externalDocs": { "url": "array" }, "example": [ { "purpose": "traffic_routing", "type": "CNAME", "name": "status.example.com", "value": "pages.example.net" } ], "type": [ "array", "null" ], "items": { "type": "object", "required": [ "purpose", "type", "name", "value" ], "properties": { "purpose": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } } } }, "certificate_validation_txt_name": { "description": "TXT record name for certificate domain validation, when required.", "externalDocs": { "url": "string" }, "example": "_acme-challenge.status.example.com", "type": [ "string", "null" ], "maxLength": 253 }, "certificate_validation_txt_value": { "description": "TXT record value for certificate domain validation, when required.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "maxLength": 1024 }, "hostname_prevalidation_txt_name": { "description": "TXT record name for hostname pre-validation, when required.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "maxLength": 253 }, "hostname_prevalidation_txt_value": { "description": "TXT record value for hostname pre-validation, when required.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "maxLength": 1024 }, "expires_at": { "description": "When the custom domain certificate expires, if known (ISO 8601).", "externalDocs": { "url": "string" }, "example": "2026-06-01T12:00:00.000000Z", "type": [ "string", "null" ], "format": "date-time" } } }, "status-page-custom-domains.RequestStatusPageCustomDomainData": { "type": "object", "description": "Custom domain lifecycle records for status pages.", "required": [ "hostname" ], "properties": { "hostname": { "description": "The requested custom hostname for the status page.", "externalDocs": { "url": "string" }, "example": "status.example.com", "type": "string", "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\\.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))*$" } } }, "status-page-custom-domains.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "organization", "organization_id", "status_page", "status_page_id", "hostname", "state" ], "properties": { "id": { "description": "Custom domain record identifier.", "externalDocs": { "url": "string" }, "example": "scd_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^scd_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "status_page": { "description": "Status page this custom domain is attached to, serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/status-pages/stp_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_page_id": { "description": "Status page identifier for this custom domain.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "hostname": { "description": "Requested hostname for the status page (FQDN).", "externalDocs": { "url": "string" }, "example": "status.example.com", "type": "string", "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\\.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))*$" }, "state": { "description": "Lifecycle state of the custom domain in Incido and the certificate/DNS workflow.", "externalDocs": { "url": "string" }, "example": "pending_verification", "type": "string", "enum": [ "pending_verification", "active", "deprovision_pending", "deprovision_failed", "removed" ] }, "provider_status": { "description": "Provider-specific status text from the TLS/DNS integration, if any.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "maxLength": 2000 }, "dns_target_records": { "description": "DNS records the customer should configure (traffic routing, validation, etc.).", "externalDocs": { "url": "array" }, "example": [ { "purpose": "traffic_routing", "type": "CNAME", "name": "status.example.com", "value": "pages.example.net" } ], "type": [ "array", "null" ], "items": { "type": "object", "required": [ "purpose", "type", "name", "value" ], "properties": { "purpose": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } } } }, "certificate_validation_txt_name": { "description": "TXT record name for certificate domain validation, when required.", "externalDocs": { "url": "string" }, "example": "_acme-challenge.status.example.com", "type": [ "string", "null" ], "maxLength": 253 }, "certificate_validation_txt_value": { "description": "TXT record value for certificate domain validation, when required.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "maxLength": 1024 }, "hostname_prevalidation_txt_name": { "description": "TXT record name for hostname pre-validation, when required.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "maxLength": 253 }, "hostname_prevalidation_txt_value": { "description": "TXT record value for hostname pre-validation, when required.", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "maxLength": 1024 }, "expires_at": { "description": "When the custom domain certificate expires, if known (ISO 8601).", "externalDocs": { "url": "string" }, "example": "2026-06-01T12:00:00.000000Z", "type": [ "string", "null" ], "format": "date-time" } } } ], "description": "Custom domain lifecycle records for status pages." }, "status-page-incidents": { "type": "object", "description": "Manages incidents on a status page, including publication lifecycle actions.", "required": [ "id", "organization", "organization_id", "status_page", "status_page_id", "incident", "incident_id", "is_published" ], "properties": { "id": { "description": "Status page incident identifier.", "externalDocs": { "url": "string" }, "example": "sil_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sil_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "status_page": { "description": "Status page this incident is linked to, serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/status-pages/stp_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_page_id": { "description": "Status page identifier for this incident.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "incident": { "description": "Incident to which this status page incident is linked to.", "example": "/incidents/inc_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "incident_id": { "description": "Incident identifier for this status page incident.", "externalDocs": { "url": "string" }, "example": "inc_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^inc_[0-9a-f]{32}$" }, "is_published": { "description": "Whether the incident is published on the status page.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } }, "status-page-incidents.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "organization", "organization_id", "status_page", "status_page_id", "incident", "incident_id", "is_published" ], "properties": { "id": { "description": "Status page incident identifier.", "externalDocs": { "url": "string" }, "example": "sil_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sil_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "status_page": { "description": "Status page this incident is linked to, serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/status-pages/stp_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_page_id": { "description": "Status page identifier for this incident.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "incident": { "description": "Incident to which this status page incident is linked to.", "example": "/incidents/inc_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "incident_id": { "description": "Incident identifier for this status page incident.", "externalDocs": { "url": "string" }, "example": "inc_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^inc_[0-9a-f]{32}$" }, "is_published": { "description": "Whether the incident is published on the status page.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } } ], "description": "Manages incidents on a status page, including publication lifecycle actions." }, "status-page-maintenances": { "type": "object", "description": "Manages maintenances on a status page, including publication lifecycle actions.", "required": [ "id", "organization", "organization_id", "status_page", "status_page_id", "maintenance", "maintenance_id", "is_published" ], "properties": { "id": { "description": "Status page maintenance identifier.", "externalDocs": { "url": "string" }, "example": "sml_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sml_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "status_page": { "description": "Status page this maintenance is linked to, serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/status-pages/stp_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_page_id": { "description": "Status page identifier for this maintenance.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "maintenance": { "description": "Maintenance to which this status page maintenance is linked to.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/maintenances/mnt_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "maintenance_id": { "description": "Maintenance identifier for this status page maintenance.", "externalDocs": { "url": "string" }, "example": "mnt_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mnt_[0-9a-f]{32}$" }, "is_published": { "description": "Whether the maintenance is published on the status page.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } }, "status-page-maintenances.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "organization", "organization_id", "status_page", "status_page_id", "maintenance", "maintenance_id", "is_published" ], "properties": { "id": { "description": "Status page maintenance identifier.", "externalDocs": { "url": "string" }, "example": "sml_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sml_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "status_page": { "description": "Status page this maintenance is linked to, serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/status-pages/stp_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_page_id": { "description": "Status page identifier for this maintenance.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "maintenance": { "description": "Maintenance to which this status page maintenance is linked to.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/maintenances/mnt_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "maintenance_id": { "description": "Maintenance identifier for this status page maintenance.", "externalDocs": { "url": "string" }, "example": "mnt_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^mnt_[0-9a-f]{32}$" }, "is_published": { "description": "Whether the maintenance is published on the status page.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" } } } ], "description": "Manages maintenances on a status page, including publication lifecycle actions." }, "status-page-subscribers": { "type": "object", "description": "Organization-scoped subscriber management records for status pages. Operators can list, inspect, create, update, and soft-delete subscribers while preserving verification, throttling, and pending-change service behavior.", "required": [ "id", "organization", "organization_id", "status_page", "status_page_id", "status_page_name", "email", "status", "subscription_type", "language", "timezone", "subscribed_to_all_components", "subscribed_component_ids", "created_at" ], "properties": { "id": { "description": "Status page subscriber identifier.", "externalDocs": { "url": "string" }, "example": "sps_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sps_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "status_page": { "description": "Status page this subscriber belongs to, serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/status-pages/stp_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_page_id": { "description": "Status page identifier for this subscriber.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "status_page_name": { "description": "Status page name shown in the dashboard list.", "externalDocs": { "url": "string" }, "example": "API Status", "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "description": "Subscriber email address.", "externalDocs": { "url": "string" }, "example": "subscriber@example.com", "type": "string", "format": "email" }, "status": { "description": "Subscriber lifecycle status.", "externalDocs": { "url": "string" }, "example": "active", "type": "string", "enum": [ "unverified", "active", "suppressed", "unsubscribed" ] }, "subscription_type": { "description": "Notification preference determining which status-page messages the subscriber receives.", "externalDocs": { "url": "string" }, "example": "all", "type": "string", "enum": [ "all", "incidents", "maintenances" ] }, "language": { "description": "Subscriber language used for notification rendering.", "externalDocs": { "url": "string" }, "example": "en", "type": "string" }, "timezone": { "description": "Subscriber timezone used for notification rendering.", "externalDocs": { "url": "string" }, "example": "Europe/Zurich", "type": "string" }, "subscribed_to_all_components": { "description": "Whether the subscriber currently receives notifications for all components on the status page.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "subscribed_component_ids": { "description": "Status page component identifiers explicitly subscribed to. Empty when the subscriber follows all components.", "externalDocs": { "url": "array" }, "example": [ "spc_550e8400e29b41d4a716446655440000" ], "type": "array", "items": { "type": "string", "pattern": "^spc_[0-9a-f]{32}$" } }, "created_at": { "description": "Timestamp when the subscriber record was created (ISO 8601).", "externalDocs": { "url": "string" }, "example": "2026-04-03T12:00:00.000000Z", "type": "string", "format": "date-time" }, "verified_at": { "description": "Timestamp when the subscriber was verified, if verification has completed (ISO 8601).", "externalDocs": { "url": "string" }, "example": "2026-04-03T12:05:00.000000Z", "type": [ "string", "null" ], "format": "date-time" }, "unsubscribed_at": { "description": "Timestamp when the subscriber unsubscribed, if applicable (ISO 8601).", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "suppressed_at": { "description": "Timestamp when the subscriber became suppressed, if applicable (ISO 8601).", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "deleted_at": { "description": "Timestamp when the subscriber was soft-deleted, if applicable (ISO 8601).", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" } } }, "status-page-subscribers.CreateStatusPageSubscriberData": { "type": "object", "description": "Organization-scoped subscriber management records for status pages. Operators can list, inspect, create, update, and soft-delete subscribers while preserving verification, throttling, and pending-change service behavior.", "required": [ "email", "status_page_id", "language" ], "properties": { "email": { "description": "The email address of the subscriber.", "externalDocs": { "url": "string" }, "example": "subscriber@example.com", "type": "string", "format": "email", "minLength": 5, "maxLength": 255, "pattern": "/^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$/" }, "status_page_id": { "description": "The ID of the status page to subscribe to.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "language": { "description": "The language to subscribe to.", "externalDocs": { "url": "string" }, "example": "en", "type": "string" }, "timezone": { "description": "The timezone of the subscriber, used for formatting dates in emails.", "externalDocs": { "url": "string" }, "example": "Europe/Zurich", "type": "string" }, "subscribed_component_ids": { "description": "IDs of status page components to subscribe to. If not provided, the subscriber will be subscribed to all components.", "externalDocs": { "url": "array" }, "example": [ "spc_550e8400e29b41d4a716446655440001", "spc_550e8400e29b41d4a716446655440002" ], "type": "array", "items": { "type": "string", "pattern": "^spc_[0-9a-f]{32}$" } }, "subscription_type": { "description": "What the subscriber wants to receive: all updates, incidents only, or maintenances only.", "externalDocs": { "url": "string" }, "example": "all", "type": "string", "enum": [ "all", "incidents", "maintenances" ] } } }, "status-page-subscribers.UpdateStatusPageSubscriberData.jsonMergePatch": { "type": "object", "description": "Organization-scoped subscriber management records for status pages. Operators can list, inspect, create, update, and soft-delete subscribers while preserving verification, throttling, and pending-change service behavior.", "properties": { "email": { "description": "The new email address. When changed, requires verification via a confirmation link.", "externalDocs": { "url": "string" }, "example": "subscriber@example.com", "type": "string", "format": "email", "minLength": 5, "maxLength": 255, "pattern": "/^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$/" }, "language": { "description": "The language to subscribe to.", "externalDocs": { "url": "string" }, "example": "en", "type": [ "string", "null" ] }, "timezone": { "description": "The timezone of the subscriber, used for formatting dates in emails.", "externalDocs": { "url": "string" }, "example": "Europe/Zurich", "type": [ "string", "null" ] }, "subscribed_component_ids": { "description": "IDs of status page components to subscribe to. If not provided (null), the subscriptions remain unchanged. If an empty list is provided, the subscriber will be subscribed to all components.", "externalDocs": { "url": "array" }, "example": [ "spc_550e8400e29b41d4a716446655440001", "spc_550e8400e29b41d4a716446655440002" ], "type": "array", "items": { "type": "string", "pattern": "^spc_[0-9a-f]{32}$" } }, "subscription_type": { "description": "What the subscriber wants to receive: all updates, incidents only, or maintenances only.", "externalDocs": { "url": "string" }, "example": "all", "type": [ "string", "null" ], "enum": [ "all", "incidents", "maintenances", null ] } } }, "status-page-subscribers.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "organization", "organization_id", "status_page", "status_page_id", "status_page_name", "email", "status", "subscription_type", "language", "timezone", "subscribed_to_all_components", "subscribed_component_ids", "created_at" ], "properties": { "id": { "description": "Status page subscriber identifier.", "externalDocs": { "url": "string" }, "example": "sps_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^sps_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "status_page": { "description": "Status page this subscriber belongs to, serialized as an IRI reference.", "example": "/organizations/org_550e8400e29b41d4a716446655440000/status-pages/stp_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "status_page_id": { "description": "Status page identifier for this subscriber.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "status_page_name": { "description": "Status page name shown in the dashboard list.", "externalDocs": { "url": "string" }, "example": "API Status", "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "description": "Subscriber email address.", "externalDocs": { "url": "string" }, "example": "subscriber@example.com", "type": "string", "format": "email" }, "status": { "description": "Subscriber lifecycle status.", "externalDocs": { "url": "string" }, "example": "active", "type": "string", "enum": [ "unverified", "active", "suppressed", "unsubscribed" ] }, "subscription_type": { "description": "Notification preference determining which status-page messages the subscriber receives.", "externalDocs": { "url": "string" }, "example": "all", "type": "string", "enum": [ "all", "incidents", "maintenances" ] }, "language": { "description": "Subscriber language used for notification rendering.", "externalDocs": { "url": "string" }, "example": "en", "type": "string" }, "timezone": { "description": "Subscriber timezone used for notification rendering.", "externalDocs": { "url": "string" }, "example": "Europe/Zurich", "type": "string" }, "subscribed_to_all_components": { "description": "Whether the subscriber currently receives notifications for all components on the status page.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "subscribed_component_ids": { "description": "Status page component identifiers explicitly subscribed to. Empty when the subscriber follows all components.", "externalDocs": { "url": "array" }, "example": [ "spc_550e8400e29b41d4a716446655440000" ], "type": "array", "items": { "type": "string", "pattern": "^spc_[0-9a-f]{32}$" } }, "created_at": { "description": "Timestamp when the subscriber record was created (ISO 8601).", "externalDocs": { "url": "string" }, "example": "2026-04-03T12:00:00.000000Z", "type": "string", "format": "date-time" }, "verified_at": { "description": "Timestamp when the subscriber was verified, if verification has completed (ISO 8601).", "externalDocs": { "url": "string" }, "example": "2026-04-03T12:05:00.000000Z", "type": [ "string", "null" ], "format": "date-time" }, "unsubscribed_at": { "description": "Timestamp when the subscriber unsubscribed, if applicable (ISO 8601).", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "suppressed_at": { "description": "Timestamp when the subscriber became suppressed, if applicable (ISO 8601).", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" }, "deleted_at": { "description": "Timestamp when the subscriber was soft-deleted, if applicable (ISO 8601).", "externalDocs": { "url": "string" }, "type": [ "string", "null" ], "format": "date-time" } } } ], "description": "Organization-scoped subscriber management records for status pages. Operators can list, inspect, create, update, and soft-delete subscribers while preserving verification, throttling, and pending-change service behavior." }, "status-pages": { "type": "object", "description": "Status pages define public incident and maintenance visibility.", "required": [ "id", "organization", "organization_id", "name", "status_page_key", "is_enabled", "theme_id" ], "properties": { "id": { "description": "Status page identifier.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "name": { "description": "Human-readable name shown in the dashboard.", "externalDocs": { "url": "string" }, "example": "API Status", "type": "string", "minLength": 2, "maxLength": 40 }, "status_page_key": { "description": "URL slug key for the public status page.", "externalDocs": { "url": "string" }, "example": "api-status", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether the status page accepts traffic and publishes content.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "theme_id": { "description": "Public identifier of the theme applied to this status page.", "externalDocs": { "url": "string" }, "example": "thm_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^thm_[0-9a-f]{32}$" }, "required_tags": { "description": "Tags incidents must include to be eligible for this status page.", "externalDocs": { "url": "array" }, "example": [ "production", "api" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "/^[a-z][a-z0-9-]*$/" } }, "excluded_tags": { "description": "Tags that exclude incidents from this status page even if required tags match.", "externalDocs": { "url": "array" }, "example": [ "internal", "test" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "/^[a-z][a-z0-9-]*$/" } }, "applicable_severity_level_ids": { "description": "Severity levels whose incidents may be published on this page.", "externalDocs": { "url": "array" }, "example": [ "sev_550e8400e29b41d4a716446655440000" ], "type": "array", "items": { "type": "string", "pattern": "^sev_[0-9a-f]{32}$" } }, "applicable_incident_status_ids": { "description": "Incident workflow statuses whose incidents may be published on this page.", "externalDocs": { "url": "array" }, "example": [ "ist_550e8400e29b41d4a716446655440000" ], "type": "array", "items": { "type": "string", "pattern": "^ist_[0-9a-f]{32}$" } }, "applicable_maintenance_status_ids": { "description": "Maintenance workflow statuses whose maintenances may be published on this page.", "externalDocs": { "url": "array" }, "example": [ "mst_550e8400e29b41d4a716446655440000" ], "type": "array", "items": { "type": "string", "pattern": "^mst_[0-9a-f]{32}$" } }, "active_custom_domain_hostname": { "description": "Hostname of the verified custom domain currently serving this page, if any.", "externalDocs": { "url": "string" }, "example": "status.acme.example", "type": [ "string", "null" ], "minLength": 1, "maxLength": 253 } } }, "status-pages.CreateStatusPageData": { "type": "object", "description": "Status pages define public incident and maintenance visibility.", "required": [ "name", "status_page_key", "applicable_severity_level_ids", "applicable_incident_status_ids", "applicable_maintenance_status_ids" ], "properties": { "name": { "description": "The name of the status page.", "externalDocs": { "url": "string" }, "example": "API Status", "type": "string", "minLength": 2, "maxLength": 40 }, "status_page_key": { "description": "The unique key for the status page URL.", "externalDocs": { "url": "string" }, "example": "api-status", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "applicable_severity_level_ids": { "description": "IDs of severity levels that should be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "sev_550e8400e29b41d4a716446655440000", "sev_550e8400e29b41d4a716446655440001" ], "type": "array", "items": { "type": "string", "pattern": "^sev_[0-9a-f]{32}$" } }, "applicable_incident_status_ids": { "description": "IDs of incident statuses that should be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "ist_550e8400e29b41d4a716446655440002", "ist_550e8400e29b41d4a716446655440003" ], "type": "array", "items": { "type": "string", "pattern": "^ist_[0-9a-f]{32}$" } }, "applicable_maintenance_status_ids": { "description": "IDs of maintenance statuses that should be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "mst_550e8400e29b41d4a716446655440004", "mst_550e8400e29b41d4a716446655440005" ], "type": "array", "items": { "type": "string", "pattern": "^mst_[0-9a-f]{32}$" } }, "theme_id": { "description": "The ID of the theme to use for this status page.", "externalDocs": { "url": "string" }, "example": "thm_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^thm_[0-9a-f]{32}$", "nullable": true }, "is_enabled": { "description": "Whether the status page is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "required_tags": { "description": "Tags that incidents must have to be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "production", "api" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "excluded_tags": { "description": "Tags that incidents must not have to be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "internal", "test" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "email_sender_address_id": { "description": "Optional verified sender address ID used for subscriber notifications on this status page.", "externalDocs": { "url": "string" }, "example": "ems_550e8400e29b41d4a716446655440006", "type": "string", "pattern": "^ems_[0-9a-f]{32}$", "nullable": true }, "email_sender_name": { "description": "Optional sender name override used for subscriber notifications on this status page.", "externalDocs": { "url": "string" }, "example": "Acme Status", "type": "string", "maxLength": 40 } } }, "status-pages.UpdateStatusPageData.jsonMergePatch": { "type": "object", "description": "Status pages define public incident and maintenance visibility.", "properties": { "name": { "description": "The name of the status page.", "externalDocs": { "url": "string" }, "example": "API Status", "type": "string", "minLength": 2, "maxLength": 40 }, "status_page_key": { "description": "The unique key for the status page URL.", "externalDocs": { "url": "string" }, "example": "api-status", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "applicable_severity_level_ids": { "description": "IDs of severity levels that should be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "sev_550e8400e29b41d4a716446655440000", "sev_550e8400e29b41d4a716446655440001" ], "type": "array", "items": { "type": "string", "pattern": "^sev_[0-9a-f]{32}$" } }, "applicable_incident_status_ids": { "description": "IDs of incident statuses that should be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "ist_550e8400e29b41d4a716446655440002", "ist_550e8400e29b41d4a716446655440003" ], "type": "array", "items": { "type": "string", "pattern": "^ist_[0-9a-f]{32}$" } }, "applicable_maintenance_status_ids": { "description": "IDs of maintenance statuses that should be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "mst_550e8400e29b41d4a716446655440004", "mst_550e8400e29b41d4a716446655440005" ], "type": "array", "items": { "type": "string", "pattern": "^mst_[0-9a-f]{32}$" } }, "theme_id": { "description": "The ID of the theme to use for this status page.", "externalDocs": { "url": "string" }, "example": "thm_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^thm_[0-9a-f]{32}$", "nullable": true }, "is_enabled": { "description": "Whether the status page is enabled.", "externalDocs": { "url": "boolean" }, "example": true, "type": [ "boolean", "null" ] }, "required_tags": { "description": "Tags that incidents must have to be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "production", "api" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "excluded_tags": { "description": "Tags that incidents must not have to be published on this status page.", "externalDocs": { "url": "array" }, "example": [ "internal", "test" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "^[a-z][a-z0-9-]*$" } }, "email_sender_address_id": { "description": "Optional verified sender address ID used for subscriber notifications on this status page. Pass an empty string to clear the override.", "externalDocs": { "url": "string" }, "example": "ems_550e8400e29b41d4a716446655440006", "type": "string", "pattern": "^ems_[0-9a-f]{32}$", "nullable": true }, "email_sender_name": { "description": "Optional sender name override used for subscriber notifications on this status page.", "externalDocs": { "url": "string" }, "example": "Acme Status", "type": "string", "maxLength": 40 } } }, "status-pages.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "organization", "organization_id", "name", "status_page_key", "is_enabled", "theme_id" ], "properties": { "id": { "description": "Status page identifier.", "externalDocs": { "url": "string" }, "example": "stp_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^stp_[0-9a-f]{32}$" }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "name": { "description": "Human-readable name shown in the dashboard.", "externalDocs": { "url": "string" }, "example": "API Status", "type": "string", "minLength": 2, "maxLength": 40 }, "status_page_key": { "description": "URL slug key for the public status page.", "externalDocs": { "url": "string" }, "example": "api-status", "type": "string", "pattern": "/^[a-z0-9\\-]{3,40}$/", "minLength": 3, "maxLength": 40 }, "is_enabled": { "description": "Whether the status page accepts traffic and publishes content.", "externalDocs": { "url": "boolean" }, "example": true, "type": "boolean" }, "theme_id": { "description": "Public identifier of the theme applied to this status page.", "externalDocs": { "url": "string" }, "example": "thm_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^thm_[0-9a-f]{32}$" }, "required_tags": { "description": "Tags incidents must include to be eligible for this status page.", "externalDocs": { "url": "array" }, "example": [ "production", "api" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "/^[a-z][a-z0-9-]*$/" } }, "excluded_tags": { "description": "Tags that exclude incidents from this status page even if required tags match.", "externalDocs": { "url": "array" }, "example": [ "internal", "test" ], "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 255, "pattern": "/^[a-z][a-z0-9-]*$/" } }, "applicable_severity_level_ids": { "description": "Severity levels whose incidents may be published on this page.", "externalDocs": { "url": "array" }, "example": [ "sev_550e8400e29b41d4a716446655440000" ], "type": "array", "items": { "type": "string", "pattern": "^sev_[0-9a-f]{32}$" } }, "applicable_incident_status_ids": { "description": "Incident workflow statuses whose incidents may be published on this page.", "externalDocs": { "url": "array" }, "example": [ "ist_550e8400e29b41d4a716446655440000" ], "type": "array", "items": { "type": "string", "pattern": "^ist_[0-9a-f]{32}$" } }, "applicable_maintenance_status_ids": { "description": "Maintenance workflow statuses whose maintenances may be published on this page.", "externalDocs": { "url": "array" }, "example": [ "mst_550e8400e29b41d4a716446655440000" ], "type": "array", "items": { "type": "string", "pattern": "^mst_[0-9a-f]{32}$" } }, "active_custom_domain_hostname": { "description": "Hostname of the verified custom domain currently serving this page, if any.", "externalDocs": { "url": "string" }, "example": "status.acme.example", "type": [ "string", "null" ], "minLength": 1, "maxLength": 253 } } } ], "description": "Status pages define public incident and maintenance visibility." }, "theme-assets": { "type": "object", "description": "Organization-scoped theme assets.", "required": [ "id", "sha256", "extension", "mime_type", "size_bytes", "asset_url", "organization", "organization_id" ], "properties": { "id": { "description": "Theme asset identifier.", "externalDocs": { "url": "string" }, "example": "tha_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^tha_[0-9a-f]{32}$" }, "sha256": { "description": "SHA-256 digest of the stored file bytes (hex, lowercase).", "externalDocs": { "url": "string" }, "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", "type": "string", "pattern": "^[a-f0-9]{64}$" }, "extension": { "description": "File extension used in URLs and storage (no leading dot).", "externalDocs": { "url": "string" }, "example": "png", "type": "string", "minLength": 1, "maxLength": 32 }, "mime_type": { "description": "MIME type of the asset.", "externalDocs": { "url": "string" }, "example": "image/png", "type": "string", "minLength": 3, "maxLength": 255 }, "size_bytes": { "description": "Size of the asset in bytes.", "externalDocs": { "url": "integer" }, "example": 102400, "type": "integer", "minimum": 0 }, "asset_url": { "description": "Relative URL path to fetch the asset.", "externalDocs": { "url": "string" }, "example": "/_assets/550e8400-e29b-41d4-a716-446655440000/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.png", "type": "string", "minLength": 1, "maxLength": 512 }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } }, "theme-assets.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "sha256", "extension", "mime_type", "size_bytes", "asset_url", "organization", "organization_id" ], "properties": { "id": { "description": "Theme asset identifier.", "externalDocs": { "url": "string" }, "example": "tha_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^tha_[0-9a-f]{32}$" }, "sha256": { "description": "SHA-256 digest of the stored file bytes (hex, lowercase).", "externalDocs": { "url": "string" }, "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", "type": "string", "pattern": "^[a-f0-9]{64}$" }, "extension": { "description": "File extension used in URLs and storage (no leading dot).", "externalDocs": { "url": "string" }, "example": "png", "type": "string", "minLength": 1, "maxLength": 32 }, "mime_type": { "description": "MIME type of the asset.", "externalDocs": { "url": "string" }, "example": "image/png", "type": "string", "minLength": 3, "maxLength": 255 }, "size_bytes": { "description": "Size of the asset in bytes.", "externalDocs": { "url": "integer" }, "example": 102400, "type": "integer", "minimum": 0 }, "asset_url": { "description": "Relative URL path to fetch the asset.", "externalDocs": { "url": "string" }, "example": "/_assets/550e8400-e29b-41d4-a716-446655440000/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.png", "type": "string", "minLength": 1, "maxLength": 512 }, "organization": { "description": "Owning organization serialized as an IRI reference pointing to the Organization resource.", "example": "/organizations/org_550e8400e29b41d4a716446655440000", "type": "string", "format": "iri-reference" }, "organization_id": { "description": "Owning organization identifier.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 } } } ], "description": "Organization-scoped theme assets." }, "theme-options": { "type": "object", "description": "Read-only metadata for frontend page options and email notification-type options used by theme editors.", "required": [ "organization_id", "frontend_pages", "email_notification_types" ], "properties": { "organization_id": { "description": "Organization whose theme editor options are returned.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "frontend_pages": { "type": "array", "items": { "$ref": "#/components/schemas/ThemeOptionsSectionRead" } }, "email_notification_types": { "type": "array", "items": { "$ref": "#/components/schemas/ThemeOptionsSectionRead" } } } }, "theme-options.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "organization_id", "frontend_pages", "email_notification_types" ], "properties": { "organization_id": { "description": "Organization whose theme editor options are returned.", "externalDocs": { "url": "string" }, "example": "org_550e8400e29b41d4a716446655440000", "type": "string", "pattern": "^org_[0-9a-f]{32}$", "minLength": 36, "maxLength": 36 }, "frontend_pages": { "type": "array", "items": { "$ref": "#/components/schemas/ThemeOptionsSectionRead.jsonld" } }, "email_notification_types": { "type": "array", "items": { "$ref": "#/components/schemas/ThemeOptionsSectionRead.jsonld" } } } } ], "description": "Read-only metadata for frontend page options and email notification-type options used by theme editors." }, "Rfc7807Problem": { "type": "object", "description": "RFC 7807 Problem Details (application/problem+json).", "example": { "type": "https://api.incido.app/problems/unauthenticated", "title": "Unauthenticated", "status": 401, "detail": "Missing or invalid bearer token.", "instance": "https://api.incido.app/api/organizations/org_550e8400e29b41d4a716446655440000/components" }, "properties": { "type": { "type": "string", "format": "uri", "example": "https://api.incido.app/problems/unauthenticated" }, "title": { "type": "string", "example": "Unauthenticated" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "Missing or invalid bearer token." } } } }, "responses": { "UnauthorizedProblem": { "description": "Missing or invalid bearer token. The API returns an RFC 7807 problem detail body.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Rfc7807Problem" }, "example": { "type": "https://api.incido.app/problems/unauthenticated", "title": "Unauthenticated", "status": 401, "detail": "Missing or invalid bearer token.", "instance": "https://api.incido.app/api/organizations/org_550e8400e29b41d4a716446655440000/components" } } } }, "ForbiddenProblem": { "description": "Authenticated user is not allowed to perform this operation. The API returns an RFC 7807 problem detail body.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Rfc7807Problem" }, "example": { "type": "https://api.incido.app/problems/forbidden", "title": "Forbidden", "status": 403, "detail": "You are not authorized to perform this action.", "instance": "https://api.incido.app/api/organizations/org_550e8400e29b41d4a716446655440000/components" } } } }, "NotFoundProblem": { "description": "The organization or resource identified in the path does not exist, or the caller cannot access it. The API returns an RFC 7807 problem detail body.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Rfc7807Problem" }, "example": { "type": "https://api.incido.app/problems/not-found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "instance": "https://api.incido.app/api/organizations/org_550e8400e29b41d4a716446655440000/components" } } } } }, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "bearer": { "type": "http", "description": "To authenticate with the Incido API, use an OAuth 2 personal access token. Send `Authorization: Bearer ` on each request unless the operation explicitly requires no authentication. Go to the Incido Dashboard to create a token under the top right user menu \u2192 **API Tokens** \u2192 Create Token.\n\nEach token can be created with **all scopes** or **custom scopes**; the API still enforces your Dashboard permissions for the target organization, so the token cannot exceed what you can do manually. Many paths include `organization_id`; you must be a member of that organization. When an operation lists `security: []` in this document, it does not require a bearer token.", "scheme": "bearer" } } }, "security": [ { "bearer": [] } ], "tags": [ { "name": "Components", "description": "Logical parts of your service (for example an API, database, or CDN) that appear on status pages. Each component has a stable key, localized name and description, and a current availability status used for incidents and subscriber communication." }, { "name": "Incidents", "description": "Incidents are the main objects in the system. They are used to track the progress of incidents." }, { "name": "Incident Statuses", "description": "Incident Statuses are used to track the progress of incidents." }, { "name": "Incident Status Transitions", "description": "Incident Status Transitions define the allowed transitions between incident statuses." }, { "name": "Maintenances", "description": "Maintenances are scheduled maintenance windows that can affect system components." }, { "name": "Maintenance Statuses", "description": "Maintenance Statuses are used to track the progress of maintenance." }, { "name": "Maintenance Status Transitions", "description": "Maintenance Status Transitions define the allowed transitions between maintenance statuses." }, { "name": "Monitors", "description": "Monitors are used to track the health of specific applications or services." }, { "name": "Monitor Correlation Groups", "description": "Monitor correlation groups are used to group monitors together for incident correlation." }, { "name": "Monitor Types", "description": "Each monitor has a type. The type determines how the status of the monitor is updated. Each type has a dedicated configuration." }, { "name": "Organizations", "description": "Organizations form the foundation of Incido. All the data is organized into organizations." }, { "name": "Organization Configuration", "description": "Asynchronous organization configuration imports." }, { "name": "Severity Levels", "description": "Severity Levels are used to categorize the severity of incidents." }, { "name": "Status Pages", "description": "Status pages define public incident and maintenance visibility." }, { "name": "Status Page Custom Domains", "description": "Custom domain lifecycle records for status pages." }, { "name": "Status Page Incidents", "description": "Manages incidents on a status page, including publication lifecycle actions." }, { "name": "Status Page Maintenances", "description": "Manages maintenances on a status page, including publication lifecycle actions." }, { "name": "Status Page Subscribers", "description": "Organization-scoped subscriber management records for status pages. Operators can list, inspect, create, update, and soft-delete subscribers while preserving verification, throttling, and pending-change service behavior." }, { "name": "Themes", "description": "Read-only metadata for frontend page options and email notification-type options used by theme editors." }, { "name": "Webhook Keys", "description": "Webhook Keys are used to validate webhook payloads." } ], "webhooks": {} }