{ "components": { "responses": { "Error": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Standard error envelope" } }, "schemas": { "Envelope": { "properties": { "data": {}, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "required": [ "data" ], "type": "object" }, "ErrorEnvelope": { "properties": { "error": { "properties": { "code": { "type": "string" }, "details": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" }, "Pagination": { "properties": { "cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" }, "limit": { "maximum": 250, "minimum": 1, "type": "integer" }, "next_cursor": { "type": [ "string", "null" ] }, "prev_cursor": { "type": [ "string", "null" ] } }, "type": "object" }, "Resource": { "additionalProperties": true, "type": "object" } }, "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT or API key", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Public API contract generated from docs/api/route-inventory.yaml. Internal, admin, runtime, and inbound-provider routes are intentionally excluded.", "title": "up4 Public REST API", "version": "2026-07-09" }, "openapi": "3.1.0", "paths": { "/advisor": { "get": { "operationId": "get_advisor", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /advisor", "tags": [ "advisor" ], "x-audience": "public_api", "x-stability": "stable" } }, "/advisor/apply": { "post": { "operationId": "post_advisor_apply", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /advisor/apply", "tags": [ "advisor" ], "x-audience": "public_api", "x-stability": "stable" } }, "/client-templates": { "get": { "operationId": "get_client_templates", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /client-templates", "tags": [ "client-templates" ], "x-audience": "public_api", "x-stability": "stable" }, "post": { "operationId": "post_client_templates", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /client-templates", "tags": [ "client-templates" ], "x-audience": "public_api", "x-stability": "stable" } }, "/client-templates/{templateID}": { "delete": { "operationId": "delete_client_templates_templateID", "parameters": [ { "in": "path", "name": "templateID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /client-templates/{templateID}", "tags": [ "client-templates" ], "x-audience": "public_api", "x-stability": "stable" }, "get": { "operationId": "get_client_templates_templateID", "parameters": [ { "in": "path", "name": "templateID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /client-templates/{templateID}", "tags": [ "client-templates" ], "x-audience": "public_api", "x-stability": "stable" }, "put": { "operationId": "put_client_templates_templateID", "parameters": [ { "in": "path", "name": "templateID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /client-templates/{templateID}", "tags": [ "client-templates" ], "x-audience": "public_api", "x-stability": "stable" } }, "/clients": { "get": { "operationId": "get_clients", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /clients", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" }, "post": { "operationId": "post_clients", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /clients", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" } }, "/clients/{clientID}": { "get": { "operationId": "get_clients_clientID", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /clients/{clientID}", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" }, "put": { "operationId": "put_clients_clientID", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /clients/{clientID}", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" } }, "/clients/{clientID}/archive": { "post": { "operationId": "post_clients_clientID_archive", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /clients/{clientID}/archive", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" } }, "/clients/{clientID}/portal-settings": { "get": { "operationId": "get_clients_clientID_portal_settings", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /clients/{clientID}/portal-settings", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" }, "put": { "operationId": "put_clients_clientID_portal_settings", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /clients/{clientID}/portal-settings", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" } }, "/clients/{clientID}/share-links": { "get": { "operationId": "get_clients_clientID_share_links", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /clients/{clientID}/share-links", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" }, "post": { "operationId": "post_clients_clientID_share_links", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /clients/{clientID}/share-links", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" } }, "/clients/{clientID}/share-links/{linkID}": { "delete": { "operationId": "delete_clients_clientID_share_links_linkID", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "linkID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /clients/{clientID}/share-links/{linkID}", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" } }, "/clients/{clientID}/teams": { "get": { "operationId": "get_clients_clientID_teams", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /clients/{clientID}/teams", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.read", "x-stability": "stable" } }, "/clients/{clientID}/unarchive": { "post": { "operationId": "post_clients_clientID_unarchive", "parameters": [ { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /clients/{clientID}/unarchive", "tags": [ "clients" ], "x-audience": "public_api", "x-permission": "client.write", "x-stability": "stable" } }, "/escalation-policies": { "get": { "operationId": "get_escalation_policies", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /escalation-policies", "tags": [ "escalation-policies" ], "x-audience": "public_api", "x-permission": "escalation_policy.write", "x-stability": "stable" }, "post": { "operationId": "post_escalation_policies", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /escalation-policies", "tags": [ "escalation-policies" ], "x-audience": "public_api", "x-permission": "escalation_policy.write", "x-stability": "stable" } }, "/escalation-policies/{policyID}": { "delete": { "operationId": "delete_escalation_policies_policyID", "parameters": [ { "in": "path", "name": "policyID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /escalation-policies/{policyID}", "tags": [ "escalation-policies" ], "x-audience": "public_api", "x-permission": "escalation_policy.write", "x-stability": "stable" }, "get": { "operationId": "get_escalation_policies_policyID", "parameters": [ { "in": "path", "name": "policyID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /escalation-policies/{policyID}", "tags": [ "escalation-policies" ], "x-audience": "public_api", "x-permission": "escalation_policy.write", "x-stability": "stable" }, "put": { "operationId": "put_escalation_policies_policyID", "parameters": [ { "in": "path", "name": "policyID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /escalation-policies/{policyID}", "tags": [ "escalation-policies" ], "x-audience": "public_api", "x-permission": "escalation_policy.write", "x-stability": "stable" } }, "/escalation-policies/{policyID}/test": { "post": { "operationId": "post_escalation_policies_policyID_test", "parameters": [ { "in": "path", "name": "policyID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /escalation-policies/{policyID}/test", "tags": [ "escalation-policies" ], "x-audience": "public_api", "x-permission": "escalation_policy.write", "x-stability": "stable" } }, "/heartbeat-groups": { "get": { "operationId": "get_heartbeat_groups", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /heartbeat-groups", "tags": [ "heartbeat-groups" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "post": { "operationId": "post_heartbeat_groups", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /heartbeat-groups", "tags": [ "heartbeat-groups" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" } }, "/heartbeat-groups/assign": { "post": { "operationId": "post_heartbeat_groups_assign", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /heartbeat-groups/assign", "tags": [ "heartbeat-groups" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" } }, "/heartbeat-groups/{groupID}": { "delete": { "operationId": "delete_heartbeat_groups_groupID", "parameters": [ { "in": "path", "name": "groupID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /heartbeat-groups/{groupID}", "tags": [ "heartbeat-groups" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "get": { "operationId": "get_heartbeat_groups_groupID", "parameters": [ { "in": "path", "name": "groupID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /heartbeat-groups/{groupID}", "tags": [ "heartbeat-groups" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "put": { "operationId": "put_heartbeat_groups_groupID", "parameters": [ { "in": "path", "name": "groupID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /heartbeat-groups/{groupID}", "tags": [ "heartbeat-groups" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" } }, "/heartbeats": { "get": { "operationId": "get_heartbeats", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /heartbeats", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "post": { "operationId": "post_heartbeats", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /heartbeats", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" } }, "/heartbeats/{heartbeatID}": { "delete": { "operationId": "delete_heartbeats_heartbeatID", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /heartbeats/{heartbeatID}", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "get": { "operationId": "get_heartbeats_heartbeatID", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /heartbeats/{heartbeatID}", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "patch": { "operationId": "patch_heartbeats_heartbeatID", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PATCH /heartbeats/{heartbeatID}", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "put": { "operationId": "put_heartbeats_heartbeatID", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /heartbeats/{heartbeatID}", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" } }, "/heartbeats/{heartbeatID}/availability": { "get": { "operationId": "get_heartbeats_heartbeatID_availability", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /heartbeats/{heartbeatID}/availability", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.read", "x-stability": "stable" } }, "/heartbeats/{heartbeatID}/pause": { "post": { "operationId": "post_heartbeats_heartbeatID_pause", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /heartbeats/{heartbeatID}/pause", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "put": { "operationId": "put_heartbeats_heartbeatID_pause", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /heartbeats/{heartbeatID}/pause", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" } }, "/heartbeats/{heartbeatID}/pings": { "get": { "operationId": "get_heartbeats_heartbeatID_pings", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /heartbeats/{heartbeatID}/pings", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.read", "x-stability": "stable" } }, "/heartbeats/{heartbeatID}/resume": { "post": { "operationId": "post_heartbeats_heartbeatID_resume", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /heartbeats/{heartbeatID}/resume", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" }, "put": { "operationId": "put_heartbeats_heartbeatID_resume", "parameters": [ { "in": "path", "name": "heartbeatID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /heartbeats/{heartbeatID}/resume", "tags": [ "heartbeats" ], "x-audience": "public_api", "x-permission": "heartbeat.write", "x-stability": "stable" } }, "/incidents": { "get": { "operationId": "get_incidents", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" }, "post": { "operationId": "post_incidents", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}": { "get": { "operationId": "get_incidents_incidentID", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents/{incidentID}", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.read", "x-stability": "stable" } }, "/incidents/{incidentID}/acknowledge": { "post": { "operationId": "post_incidents_incidentID_acknowledge", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/acknowledge", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" }, "put": { "operationId": "put_incidents_incidentID_acknowledge", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /incidents/{incidentID}/acknowledge", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/ai": { "get": { "operationId": "get_incidents_incidentID_ai", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents/{incidentID}/ai", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.read", "x-stability": "stable" } }, "/incidents/{incidentID}/ai/postmortem": { "post": { "operationId": "post_incidents_incidentID_ai_postmortem", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/ai/postmortem", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/ai/summary": { "post": { "operationId": "post_incidents_incidentID_ai_summary", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/ai/summary", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/ai/{kind}/rating": { "put": { "operationId": "put_incidents_incidentID_ai_kind_rating", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "kind", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /incidents/{incidentID}/ai/{kind}/rating", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/attachments": { "get": { "operationId": "get_incidents_incidentID_attachments", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents/{incidentID}/attachments", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" }, "post": { "operationId": "post_incidents_incidentID_attachments", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/attachments", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/attachments/{attachmentID}": { "delete": { "operationId": "delete_incidents_incidentID_attachments_attachmentID", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "attachmentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /incidents/{incidentID}/attachments/{attachmentID}", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" }, "get": { "operationId": "get_incidents_incidentID_attachments_attachmentID", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "attachmentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents/{incidentID}/attachments/{attachmentID}", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/comments": { "get": { "operationId": "get_incidents_incidentID_comments", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents/{incidentID}/comments", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" }, "post": { "operationId": "post_incidents_incidentID_comments", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/comments", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/comments/{commentID}": { "delete": { "operationId": "delete_incidents_incidentID_comments_commentID", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "commentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /incidents/{incidentID}/comments/{commentID}", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/escalate": { "post": { "operationId": "post_incidents_incidentID_escalate", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/escalate", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/group": { "get": { "operationId": "get_incidents_incidentID_group", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents/{incidentID}/group", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.read", "x-stability": "stable" } }, "/incidents/{incidentID}/reopen": { "post": { "operationId": "post_incidents_incidentID_reopen", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/reopen", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" }, "put": { "operationId": "put_incidents_incidentID_reopen", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /incidents/{incidentID}/reopen", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/resolve": { "post": { "operationId": "post_incidents_incidentID_resolve", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/resolve", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" }, "put": { "operationId": "put_incidents_incidentID_resolve", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /incidents/{incidentID}/resolve", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/runbook-progress": { "get": { "operationId": "get_incidents_incidentID_runbook_progress", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents/{incidentID}/runbook-progress", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.read", "x-stability": "stable" } }, "/incidents/{incidentID}/runbook-steps/{stepID}/completion": { "put": { "operationId": "put_incidents_incidentID_runbook_steps_stepID_completion", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "stepID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /incidents/{incidentID}/runbook-steps/{stepID}/completion", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/incidents/{incidentID}/timeline": { "get": { "operationId": "get_incidents_incidentID_timeline", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /incidents/{incidentID}/timeline", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.read", "x-stability": "stable" } }, "/incidents/{incidentID}/updates": { "post": { "operationId": "post_incidents_incidentID_updates", "parameters": [ { "in": "path", "name": "incidentID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /incidents/{incidentID}/updates", "tags": [ "incidents" ], "x-audience": "public_api", "x-permission": "incident.write", "x-stability": "stable" } }, "/internal/fleet/releases": { "post": { "operationId": "post_internal_fleet_releases", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /internal/fleet/releases", "tags": [ "internal" ], "x-audience": "public_api", "x-stability": "stable" } }, "/invites": { "get": { "operationId": "get_invites", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /invites", "tags": [ "invites" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" }, "post": { "operationId": "post_invites", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /invites", "tags": [ "invites" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/invites/{inviteID}": { "delete": { "operationId": "delete_invites_inviteID", "parameters": [ { "in": "path", "name": "inviteID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /invites/{inviteID}", "tags": [ "invites" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/invites/{inviteID}/resend": { "post": { "operationId": "post_invites_inviteID_resend", "parameters": [ { "in": "path", "name": "inviteID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /invites/{inviteID}/resend", "tags": [ "invites" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/me": { "get": { "operationId": "get_me", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /me", "tags": [ "me" ], "x-audience": "public_api", "x-permission": "self.read", "x-stability": "stable" } }, "/metadata": { "get": { "operationId": "get_metadata", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /metadata", "tags": [ "metadata" ], "x-audience": "public_api", "x-permission": "metadata.write", "x-stability": "stable" }, "put": { "operationId": "put_metadata", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /metadata", "tags": [ "metadata" ], "x-audience": "public_api", "x-permission": "metadata.write", "x-stability": "stable" } }, "/monitor-groups": { "get": { "operationId": "get_monitor_groups", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitor-groups", "tags": [ "monitor-groups" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" }, "post": { "operationId": "post_monitor_groups", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitor-groups", "tags": [ "monitor-groups" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/monitor-groups/assign": { "post": { "operationId": "post_monitor_groups_assign", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitor-groups/assign", "tags": [ "monitor-groups" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/monitor-groups/{groupID}": { "delete": { "operationId": "delete_monitor_groups_groupID", "parameters": [ { "in": "path", "name": "groupID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /monitor-groups/{groupID}", "tags": [ "monitor-groups" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" }, "get": { "operationId": "get_monitor_groups_groupID", "parameters": [ { "in": "path", "name": "groupID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitor-groups/{groupID}", "tags": [ "monitor-groups" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" }, "put": { "operationId": "put_monitor_groups_groupID", "parameters": [ { "in": "path", "name": "groupID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /monitor-groups/{groupID}", "tags": [ "monitor-groups" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" } }, "/monitors": { "get": { "operationId": "get_monitors", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "UP", "DOWN", "PAUSED" ], "type": "string" } }, { "in": "query", "name": "monitor_type", "required": false, "schema": { "enum": [ "http", "ping", "tcp", "dns" ], "type": "string" } }, { "in": "query", "name": "region", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" }, "post": { "operationId": "post_monitors", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitors", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/monitors/batch": { "post": { "operationId": "post_monitors_batch", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitors/batch", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/monitors/batch/dry-run": { "post": { "operationId": "post_monitors_batch_dry_run", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitors/batch/dry-run", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/monitors/{monitorID}": { "delete": { "operationId": "delete_monitors_monitorID", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /monitors/{monitorID}", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" }, "get": { "operationId": "get_monitors_monitorID", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors/{monitorID}", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" }, "patch": { "operationId": "patch_monitors_monitorID", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PATCH /monitors/{monitorID}", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" }, "put": { "operationId": "put_monitors_monitorID", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /monitors/{monitorID}", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" } }, "/monitors/{monitorID}/availability": { "get": { "operationId": "get_monitors_monitorID_availability", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors/{monitorID}/availability", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.read", "x-stability": "stable" } }, "/monitors/{monitorID}/certificates": { "get": { "operationId": "get_monitors_monitorID_certificates", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors/{monitorID}/certificates", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.read", "x-stability": "stable" } }, "/monitors/{monitorID}/check": { "post": { "operationId": "post_monitors_monitorID_check", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitors/{monitorID}/check", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/monitors/{monitorID}/escalation-policy": { "delete": { "operationId": "delete_monitors_monitorID_escalation_policy", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /monitors/{monitorID}/escalation-policy", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" }, "put": { "operationId": "put_monitors_monitorID_escalation_policy", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /monitors/{monitorID}/escalation-policy", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" } }, "/monitors/{monitorID}/incidents": { "get": { "operationId": "get_monitors_monitorID_incidents", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors/{monitorID}/incidents", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.read", "x-stability": "stable" } }, "/monitors/{monitorID}/notification_channels": { "get": { "operationId": "get_monitors_monitorID_notification_channels", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors/{monitorID}/notification_channels", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.read", "x-stability": "stable" } }, "/monitors/{monitorID}/notification_channels/{channelID}": { "delete": { "operationId": "delete_monitors_monitorID_notification_channels_channelID", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "channelID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /monitors/{monitorID}/notification_channels/{channelID}", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" }, "post": { "operationId": "post_monitors_monitorID_notification_channels_channelID", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "channelID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitors/{monitorID}/notification_channels/{channelID}", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.delete", "x-stability": "stable" } }, "/monitors/{monitorID}/pause": { "post": { "operationId": "post_monitors_monitorID_pause", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitors/{monitorID}/pause", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/monitors/{monitorID}/regions": { "get": { "operationId": "get_monitors_monitorID_regions", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors/{monitorID}/regions", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.read", "x-stability": "stable" } }, "/monitors/{monitorID}/response_times": { "get": { "operationId": "get_monitors_monitorID_response_times", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors/{monitorID}/response_times", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.read", "x-stability": "stable" } }, "/monitors/{monitorID}/results": { "get": { "operationId": "get_monitors_monitorID_results", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /monitors/{monitorID}/results", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.read", "x-stability": "stable" } }, "/monitors/{monitorID}/resume": { "post": { "operationId": "post_monitors_monitorID_resume", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitors/{monitorID}/resume", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/monitors/{monitorID}/test-alert": { "post": { "operationId": "post_monitors_monitorID_test_alert", "parameters": [ { "in": "path", "name": "monitorID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /monitors/{monitorID}/test-alert", "tags": [ "monitors" ], "x-audience": "public_api", "x-permission": "monitor.write", "x-stability": "stable" } }, "/notification_channels": { "get": { "operationId": "get_notification_channels", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /notification_channels", "tags": [ "notification-channels" ], "x-audience": "public_api", "x-permission": "notification_channel.write", "x-stability": "stable" }, "post": { "operationId": "post_notification_channels", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /notification_channels", "tags": [ "notification-channels" ], "x-audience": "public_api", "x-permission": "notification_channel.write", "x-stability": "stable" } }, "/notification_channels/{channelID}": { "delete": { "operationId": "delete_notification_channels_channelID", "parameters": [ { "in": "path", "name": "channelID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /notification_channels/{channelID}", "tags": [ "notification-channels" ], "x-audience": "public_api", "x-permission": "notification_channel.write", "x-stability": "stable" }, "get": { "operationId": "get_notification_channels_channelID", "parameters": [ { "in": "path", "name": "channelID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /notification_channels/{channelID}", "tags": [ "notification-channels" ], "x-audience": "public_api", "x-permission": "notification_channel.write", "x-stability": "stable" }, "put": { "operationId": "put_notification_channels_channelID", "parameters": [ { "in": "path", "name": "channelID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /notification_channels/{channelID}", "tags": [ "notification-channels" ], "x-audience": "public_api", "x-permission": "notification_channel.write", "x-stability": "stable" } }, "/notification_channels/{channelID}/test": { "post": { "operationId": "post_notification_channels_channelID_test", "parameters": [ { "in": "path", "name": "channelID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /notification_channels/{channelID}/test", "tags": [ "notification-channels" ], "x-audience": "public_api", "x-permission": "notification_channel.write", "x-stability": "stable" } }, "/oncall-schedules": { "get": { "operationId": "get_oncall_schedules", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /oncall-schedules", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.write", "x-stability": "stable" }, "post": { "operationId": "post_oncall_schedules", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /oncall-schedules", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.write", "x-stability": "stable" } }, "/oncall-schedules/current": { "get": { "operationId": "get_oncall_schedules_current", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /oncall-schedules/current", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.read", "x-stability": "stable" } }, "/oncall-schedules/{scheduleID}": { "delete": { "operationId": "delete_oncall_schedules_scheduleID", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /oncall-schedules/{scheduleID}", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.write", "x-stability": "stable" }, "get": { "operationId": "get_oncall_schedules_scheduleID", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /oncall-schedules/{scheduleID}", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.write", "x-stability": "stable" }, "put": { "operationId": "put_oncall_schedules_scheduleID", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /oncall-schedules/{scheduleID}", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.write", "x-stability": "stable" } }, "/oncall-schedules/{scheduleID}/coverage": { "get": { "operationId": "get_oncall_schedules_scheduleID_coverage", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /oncall-schedules/{scheduleID}/coverage", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.read", "x-stability": "stable" } }, "/oncall-schedules/{scheduleID}/events": { "get": { "operationId": "get_oncall_schedules_scheduleID_events", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /oncall-schedules/{scheduleID}/events", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.read", "x-stability": "stable" } }, "/oncall-schedules/{scheduleID}/overrides": { "get": { "operationId": "get_oncall_schedules_scheduleID_overrides", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /oncall-schedules/{scheduleID}/overrides", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.write", "x-stability": "stable" }, "post": { "operationId": "post_oncall_schedules_scheduleID_overrides", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /oncall-schedules/{scheduleID}/overrides", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.write", "x-stability": "stable" } }, "/oncall-schedules/{scheduleID}/overrides/{overrideID}": { "delete": { "operationId": "delete_oncall_schedules_scheduleID_overrides_overrideID", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "overrideID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /oncall-schedules/{scheduleID}/overrides/{overrideID}", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.write", "x-stability": "stable" } }, "/oncall-schedules/{scheduleID}/rotations": { "get": { "operationId": "get_oncall_schedules_scheduleID_rotations", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /oncall-schedules/{scheduleID}/rotations", "tags": [ "oncall-schedules" ], "x-audience": "public_api", "x-permission": "oncall.read", "x-stability": "stable" } }, "/organization": { "delete": { "operationId": "delete_organization", "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /organization", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.write", "x-stability": "stable" }, "get": { "operationId": "get_organization", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /organization", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.write", "x-stability": "stable" }, "post": { "operationId": "post_organization", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /organization", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.write", "x-stability": "stable" }, "put": { "operationId": "put_organization", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /organization", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.write", "x-stability": "stable" } }, "/organization/ai-quota": { "put": { "operationId": "put_organization_ai_quota", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /organization/ai-quota", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.write", "x-stability": "stable" } }, "/organization/ai-usage": { "get": { "operationId": "get_organization_ai_usage", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /organization/ai-usage", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.read", "x-stability": "stable" } }, "/organization/audit-logs": { "get": { "operationId": "get_organization_audit_logs", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /organization/audit-logs", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "audit_log.read", "x-stability": "stable" } }, "/organization/members": { "get": { "operationId": "get_organization_members", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /organization/members", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "member.read", "x-stability": "stable" } }, "/organization/members/email/{email}": { "delete": { "operationId": "delete_organization_members_email_email", "parameters": [ { "in": "path", "name": "email", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /organization/members/email/{email}", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" }, "get": { "operationId": "get_organization_members_email_email", "parameters": [ { "in": "path", "name": "email", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /organization/members/email/{email}", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/organization/members/{memberID}": { "delete": { "operationId": "delete_organization_members_memberID", "parameters": [ { "in": "path", "name": "memberID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /organization/members/{memberID}", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/organization/members/{memberID}/role": { "put": { "operationId": "put_organization_members_memberID_role", "parameters": [ { "in": "path", "name": "memberID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /organization/members/{memberID}/role", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/organization/security": { "get": { "operationId": "get_organization_security", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /organization/security", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.write", "x-stability": "stable" }, "put": { "operationId": "put_organization_security", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /organization/security", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.write", "x-stability": "stable" } }, "/organization/sso": { "get": { "operationId": "get_organization_sso", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /organization/sso", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.read", "x-stability": "stable" } }, "/organization/sso/{provider}": { "put": { "operationId": "put_organization_sso_provider", "parameters": [ { "in": "path", "name": "provider", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /organization/sso/{provider}", "tags": [ "organization" ], "x-audience": "public_api", "x-permission": "organization.write", "x-stability": "stable" } }, "/reports/agency-ribbon": { "get": { "operationId": "get_reports_agency_ribbon", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/agency-ribbon", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/downtime-ledger": { "get": { "operationId": "get_reports_downtime_ledger", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/downtime-ledger", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/export": { "get": { "operationId": "get_reports_export", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/export", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/incidents": { "get": { "operationId": "get_reports_incidents", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/incidents", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/monitor-ribbon": { "get": { "operationId": "get_reports_monitor_ribbon", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/monitor-ribbon", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/monitors": { "get": { "operationId": "get_reports_monitors", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/monitors", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/response-time": { "get": { "operationId": "get_reports_response_time", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/response-time", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/runs": { "get": { "operationId": "get_reports_runs", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/runs", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/schedules": { "get": { "operationId": "get_reports_schedules", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/schedules", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" }, "post": { "operationId": "post_reports_schedules", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /reports/schedules", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/schedules/{scheduleID}": { "delete": { "operationId": "delete_reports_schedules_scheduleID", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /reports/schedules/{scheduleID}", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" }, "get": { "operationId": "get_reports_schedules_scheduleID", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/schedules/{scheduleID}", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" }, "put": { "operationId": "put_reports_schedules_scheduleID", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /reports/schedules/{scheduleID}", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/schedules/{scheduleID}/run-now": { "post": { "operationId": "post_reports_schedules_scheduleID_run_now", "parameters": [ { "in": "path", "name": "scheduleID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /reports/schedules/{scheduleID}/run-now", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/share-links": { "get": { "operationId": "get_reports_share_links", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/share-links", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/share-links/{linkID}": { "delete": { "operationId": "delete_reports_share_links_linkID", "parameters": [ { "in": "path", "name": "linkID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /reports/share-links/{linkID}", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/sla": { "get": { "operationId": "get_reports_sla", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/sla", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/summary": { "get": { "operationId": "get_reports_summary", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/summary", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/trends": { "get": { "operationId": "get_reports_trends", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/trends", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/verify/{hash}": { "get": { "operationId": "get_reports_verify_hash", "parameters": [ { "in": "path", "name": "hash", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /reports/verify/{hash}", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/reports/{runID}/share": { "post": { "operationId": "post_reports_runID_share", "parameters": [ { "in": "path", "name": "runID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /reports/{runID}/share", "tags": [ "reports" ], "x-audience": "public_api", "x-permission": "report.read", "x-stability": "stable" } }, "/runbooks": { "get": { "operationId": "get_runbooks", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /runbooks", "tags": [ "runbooks" ], "x-audience": "public_api", "x-permission": "runbook.write", "x-stability": "stable" }, "post": { "operationId": "post_runbooks", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /runbooks", "tags": [ "runbooks" ], "x-audience": "public_api", "x-permission": "runbook.write", "x-stability": "stable" } }, "/runbooks/{runbookID}": { "delete": { "operationId": "delete_runbooks_runbookID", "parameters": [ { "in": "path", "name": "runbookID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /runbooks/{runbookID}", "tags": [ "runbooks" ], "x-audience": "public_api", "x-permission": "runbook.write", "x-stability": "stable" }, "get": { "operationId": "get_runbooks_runbookID", "parameters": [ { "in": "path", "name": "runbookID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /runbooks/{runbookID}", "tags": [ "runbooks" ], "x-audience": "public_api", "x-permission": "runbook.write", "x-stability": "stable" }, "put": { "operationId": "put_runbooks_runbookID", "parameters": [ { "in": "path", "name": "runbookID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /runbooks/{runbookID}", "tags": [ "runbooks" ], "x-audience": "public_api", "x-permission": "runbook.write", "x-stability": "stable" } }, "/runbooks/{runbookID}/step-completions": { "get": { "operationId": "get_runbooks_runbookID_step_completions", "parameters": [ { "in": "path", "name": "runbookID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /runbooks/{runbookID}/step-completions", "tags": [ "runbooks" ], "x-audience": "public_api", "x-permission": "runbook.read", "x-stability": "stable" } }, "/runbooks/{runbookID}/steps/{stepID}/completion": { "put": { "operationId": "put_runbooks_runbookID_steps_stepID_completion", "parameters": [ { "in": "path", "name": "runbookID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "stepID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /runbooks/{runbookID}/steps/{stepID}/completion", "tags": [ "runbooks" ], "x-audience": "public_api", "x-permission": "runbook.write", "x-stability": "stable" } }, "/severities": { "get": { "operationId": "get_severities", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /severities", "tags": [ "severities" ], "x-audience": "public_api", "x-permission": "incident.read", "x-stability": "stable" } }, "/severity-groups": { "get": { "operationId": "get_severity_groups", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /severity-groups", "tags": [ "severity-groups" ], "x-audience": "public_api", "x-permission": "incident.read", "x-stability": "stable" } }, "/share/reports/{token}": { "get": { "operationId": "get_share_reports_token", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /share/reports/{token}", "tags": [ "share" ], "x-audience": "public_api", "x-stability": "stable" } }, "/sla-policies": { "get": { "operationId": "get_sla_policies", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /sla-policies", "tags": [ "sla-policies" ], "x-audience": "public_api", "x-stability": "stable" }, "post": { "operationId": "post_sla_policies", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /sla-policies", "tags": [ "sla-policies" ], "x-audience": "public_api", "x-stability": "stable" } }, "/sla-policies/{policyID}": { "delete": { "operationId": "delete_sla_policies_policyID", "parameters": [ { "in": "path", "name": "policyID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /sla-policies/{policyID}", "tags": [ "sla-policies" ], "x-audience": "public_api", "x-stability": "stable" }, "get": { "operationId": "get_sla_policies_policyID", "parameters": [ { "in": "path", "name": "policyID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /sla-policies/{policyID}", "tags": [ "sla-policies" ], "x-audience": "public_api", "x-stability": "stable" }, "put": { "operationId": "put_sla_policies_policyID", "parameters": [ { "in": "path", "name": "policyID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /sla-policies/{policyID}", "tags": [ "sla-policies" ], "x-audience": "public_api", "x-stability": "stable" } }, "/status-pages": { "get": { "operationId": "get_status_pages", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "post": { "operationId": "post_status_pages", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}": { "delete": { "operationId": "delete_status_pages_pageID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /status-pages/{pageID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "get": { "operationId": "get_status_pages_pageID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "put": { "operationId": "put_status_pages_pageID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /status-pages/{pageID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/access": { "get": { "operationId": "get_status_pages_pageID_access", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/access", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "put": { "operationId": "put_status_pages_pageID_access", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /status-pages/{pageID}/access", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/access-token": { "delete": { "operationId": "delete_status_pages_pageID_access_token", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /status-pages/{pageID}/access-token", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "post": { "operationId": "post_status_pages_pageID_access_token", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/access-token", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/custom-domain": { "delete": { "operationId": "delete_status_pages_pageID_custom_domain", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /status-pages/{pageID}/custom-domain", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "put": { "operationId": "put_status_pages_pageID_custom_domain", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /status-pages/{pageID}/custom-domain", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/custom-domain/recheck": { "post": { "operationId": "post_status_pages_pageID_custom_domain_recheck", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/custom-domain/recheck", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/domain": { "get": { "operationId": "get_status_pages_pageID_domain", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/domain", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.read", "x-stability": "stable" } }, "/status-pages/{pageID}/domain/events": { "get": { "operationId": "get_status_pages_pageID_domain_events", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/domain/events", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.read", "x-stability": "stable" } }, "/status-pages/{pageID}/report-updates": { "get": { "operationId": "get_status_pages_pageID_report_updates", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/report-updates", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.read", "x-stability": "stable" } }, "/status-pages/{pageID}/reports": { "get": { "operationId": "get_status_pages_pageID_reports", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/reports", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "post": { "operationId": "post_status_pages_pageID_reports", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/reports", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/sections": { "get": { "operationId": "get_status_pages_pageID_sections", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/sections", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "post": { "operationId": "post_status_pages_pageID_sections", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/sections", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/sections/{sectionID}": { "delete": { "operationId": "delete_status_pages_pageID_sections_sectionID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "sectionID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /status-pages/{pageID}/sections/{sectionID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "put": { "operationId": "put_status_pages_pageID_sections_sectionID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "sectionID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /status-pages/{pageID}/sections/{sectionID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/sections/{sectionID}/resources": { "get": { "operationId": "get_status_pages_pageID_sections_sectionID_resources", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "sectionID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/sections/{sectionID}/resources", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "post": { "operationId": "post_status_pages_pageID_sections_sectionID_resources", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "sectionID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/sections/{sectionID}/resources", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/sections/{sectionID}/resources/{resourceID}": { "delete": { "operationId": "delete_status_pages_pageID_sections_sectionID_resources_resourceID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "sectionID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /status-pages/{pageID}/sections/{sectionID}/resources/{resourceID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "put": { "operationId": "put_status_pages_pageID_sections_sectionID_resources_resourceID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "sectionID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /status-pages/{pageID}/sections/{sectionID}/resources/{resourceID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/structure": { "get": { "operationId": "get_status_pages_pageID_structure", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/structure", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "put": { "operationId": "put_status_pages_pageID_structure", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /status-pages/{pageID}/structure", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/subscribers": { "get": { "operationId": "get_status_pages_pageID_subscribers", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/subscribers", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.subscriber.write", "x-stability": "stable" }, "post": { "operationId": "post_status_pages_pageID_subscribers", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/subscribers", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.subscriber.write", "x-stability": "stable" } }, "/status-pages/{pageID}/subscribers/upload": { "post": { "operationId": "post_status_pages_pageID_subscribers_upload", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/subscribers/upload", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.subscriber.write", "x-stability": "stable" } }, "/status-pages/{pageID}/subscribers/{subscriberID}": { "delete": { "operationId": "delete_status_pages_pageID_subscribers_subscriberID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "subscriberID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /status-pages/{pageID}/subscribers/{subscriberID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.subscriber.write", "x-stability": "stable" } }, "/status-pages/{pageID}/subscribers/{subscriberID}/resend": { "post": { "operationId": "post_status_pages_pageID_subscribers_subscriberID_resend", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "subscriberID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/subscribers/{subscriberID}/resend", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.subscriber.write", "x-stability": "stable" } }, "/status-pages/{pageID}/translations": { "get": { "operationId": "get_status_pages_pageID_translations", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/translations", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "post": { "operationId": "post_status_pages_pageID_translations", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/translations", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/translations/{translationID}": { "delete": { "operationId": "delete_status_pages_pageID_translations_translationID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "translationID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /status-pages/{pageID}/translations/{translationID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "put": { "operationId": "put_status_pages_pageID_translations_translationID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "translationID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /status-pages/{pageID}/translations/{translationID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/updates": { "get": { "operationId": "get_status_pages_pageID_updates", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /status-pages/{pageID}/updates", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" }, "post": { "operationId": "post_status_pages_pageID_updates", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /status-pages/{pageID}/updates", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/status-pages/{pageID}/updates/{updateID}": { "delete": { "operationId": "delete_status_pages_pageID_updates_updateID", "parameters": [ { "in": "path", "name": "pageID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "updateID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /status-pages/{pageID}/updates/{updateID}", "tags": [ "status-pages" ], "x-audience": "public_api", "x-permission": "status_page.write", "x-stability": "stable" } }, "/teams": { "get": { "operationId": "get_teams", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /teams", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "team.write", "x-stability": "stable" }, "post": { "operationId": "post_teams", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /teams", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "team.write", "x-stability": "stable" } }, "/teams/{teamID}": { "delete": { "operationId": "delete_teams_teamID", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /teams/{teamID}", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "team.write", "x-stability": "stable" }, "get": { "operationId": "get_teams_teamID", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /teams/{teamID}", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "team.write", "x-stability": "stable" }, "put": { "operationId": "put_teams_teamID", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /teams/{teamID}", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "team.write", "x-stability": "stable" } }, "/teams/{teamID}/clients": { "get": { "operationId": "get_teams_teamID_clients", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /teams/{teamID}/clients", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "team.write", "x-stability": "stable" }, "post": { "operationId": "post_teams_teamID_clients", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /teams/{teamID}/clients", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "team.write", "x-stability": "stable" } }, "/teams/{teamID}/clients/{clientID}": { "delete": { "operationId": "delete_teams_teamID_clients_clientID", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "clientID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /teams/{teamID}/clients/{clientID}", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "team.write", "x-stability": "stable" } }, "/teams/{teamID}/members": { "get": { "operationId": "get_teams_teamID_members", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /teams/{teamID}/members", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" }, "post": { "operationId": "post_teams_teamID_members", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /teams/{teamID}/members", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/teams/{teamID}/members/email/{email}": { "delete": { "operationId": "delete_teams_teamID_members_email_email", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "email", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /teams/{teamID}/members/email/{email}", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" }, "get": { "operationId": "get_teams_teamID_members_email_email", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "email", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /teams/{teamID}/members/email/{email}", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/teams/{teamID}/members/{memberID}": { "delete": { "operationId": "delete_teams_teamID_members_memberID", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "memberID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /teams/{teamID}/members/{memberID}", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/teams/{teamID}/members/{memberID}/role": { "put": { "operationId": "put_teams_teamID_members_memberID_role", "parameters": [ { "in": "path", "name": "teamID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "memberID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /teams/{teamID}/members/{memberID}/role", "tags": [ "teams" ], "x-audience": "public_api", "x-permission": "member.write", "x-stability": "stable" } }, "/webhook-subscriptions": { "get": { "operationId": "get_webhook_subscriptions", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 250, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "all_clients", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /webhook-subscriptions", "tags": [ "webhook-subscriptions" ], "x-audience": "public_api", "x-permission": "webhook.write", "x-stability": "beta" }, "post": { "operationId": "post_webhook_subscriptions", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /webhook-subscriptions", "tags": [ "webhook-subscriptions" ], "x-audience": "public_api", "x-permission": "webhook.write", "x-stability": "beta" } }, "/webhook-subscriptions/{subscriptionID}": { "delete": { "operationId": "delete_webhook_subscriptions_subscriptionID", "parameters": [ { "in": "path", "name": "subscriptionID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "DELETE /webhook-subscriptions/{subscriptionID}", "tags": [ "webhook-subscriptions" ], "x-audience": "public_api", "x-permission": "webhook.write", "x-stability": "beta" }, "put": { "operationId": "put_webhook_subscriptions_subscriptionID", "parameters": [ { "in": "path", "name": "subscriptionID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "PUT /webhook-subscriptions/{subscriptionID}", "tags": [ "webhook-subscriptions" ], "x-audience": "public_api", "x-permission": "webhook.write", "x-stability": "beta" } }, "/webhook-subscriptions/{subscriptionID}/deliveries": { "get": { "operationId": "get_webhook_subscriptions_subscriptionID_deliveries", "parameters": [ { "in": "path", "name": "subscriptionID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "GET /webhook-subscriptions/{subscriptionID}/deliveries", "tags": [ "webhook-subscriptions" ], "x-audience": "public_api", "x-permission": "webhook.read", "x-stability": "beta" } }, "/webhook-subscriptions/{subscriptionID}/redeliver/{deliveryID}": { "post": { "operationId": "post_webhook_subscriptions_subscriptionID_redeliver_deliveryID", "parameters": [ { "in": "path", "name": "subscriptionID", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "deliveryID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /webhook-subscriptions/{subscriptionID}/redeliver/{deliveryID}", "tags": [ "webhook-subscriptions" ], "x-audience": "public_api", "x-permission": "webhook.write", "x-stability": "beta" } }, "/webhook-subscriptions/{subscriptionID}/test": { "post": { "operationId": "post_webhook_subscriptions_subscriptionID_test", "parameters": [ { "in": "path", "name": "subscriptionID", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/Error" } }, "summary": "POST /webhook-subscriptions/{subscriptionID}/test", "tags": [ "webhook-subscriptions" ], "x-audience": "public_api", "x-permission": "webhook.write", "x-stability": "beta" } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "/v1" } ] }