{ "components": { "schemas": { "api.CapabilityManagedResourceBundle": { "properties": { "custom_views": { "items": { "$ref": "#/components/schemas/api.CapabilityManagedResourceSummary" }, "type": "array" }, "email": { "type": "string" }, "rss_feeds": { "items": { "$ref": "#/components/schemas/api.CapabilityManagedResourceSummary" }, "type": "array" }, "subscriptions": { "items": { "$ref": "#/components/schemas/api.CapabilityManagedSubscriberSummary" }, "type": "array" } }, "type": "object" }, "api.CapabilityManagedResourceSummary": { "properties": { "name": { "type": "string" }, "short_code": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "api.CapabilityManagedSubscriberProfile": { "properties": { "email": { "type": "string" }, "id": { "type": "integer" }, "manage_token": { "type": "string" }, "manage_url": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "api.CapabilityManagedSubscriberSummary": { "properties": { "email": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "api.CapabilityManager": { "properties": { "email": { "type": "string" }, "role": { "type": "string" } }, "type": "object" }, "api.CapabilityNotificationSubscription": { "properties": { "channel": { "type": "string" }, "destination": { "type": "string" }, "enabled": { "type": "boolean" }, "incident_events": { "items": { "type": "string" }, "type": "array" }, "maintenance_events": { "items": { "type": "string" }, "type": "array" }, "min_severity": { "type": "string" }, "scope_ref": { "type": "string" }, "scope_type": { "type": "string" } }, "type": "object" }, "api.CapabilitySubscriber": { "properties": { "description": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "preferred_locale": { "type": "string" } }, "type": "object" }, "api.EmailRequest": { "properties": { "email": { "type": "string" } }, "type": "object" }, "api.EmailTransferRequest": { "properties": { "confirm_email": { "type": "string" }, "email": { "type": "string" } }, "type": "object" }, "api.ManagedProfileResponse": { "properties": { "profile": { "$ref": "#/components/schemas/api.CapabilityManagedSubscriberProfile" } }, "type": "object" }, "api.ManagedProfilesResponse": { "properties": { "profiles": { "items": { "$ref": "#/components/schemas/api.CapabilityManagedSubscriberProfile" }, "type": "array" } }, "type": "object" }, "api.MessageResponse": { "properties": { "message": { "type": "string" } }, "type": "object" }, "api.NameDescriptionRequest": { "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "api.RSSFeedManagersResponse": { "properties": { "managers": { "items": { "$ref": "#/components/schemas/api.CapabilityManager" }, "type": "array" } }, "type": "object" }, "api.SubscriberManagersResponse": { "properties": { "managers": { "items": { "$ref": "#/components/schemas/api.CapabilityManager" }, "type": "array" } }, "type": "object" }, "api.SubscriberResponse": { "properties": { "subscriber": { "$ref": "#/components/schemas/api.CapabilitySubscriber" } }, "type": "object" }, "api.SubscriptionPreferencesResponse": { "properties": { "subscriber": { "$ref": "#/components/schemas/api.CapabilitySubscriber" }, "subscriptions": { "items": { "$ref": "#/components/schemas/api.CapabilityNotificationSubscription" }, "type": "array" } }, "type": "object" }, "api.SubscriptionPreferencesUpdateRequest": { "properties": { "subscriptions": { "items": { "$ref": "#/components/schemas/service.SubscriptionPreferenceInput" }, "type": "array" } }, "type": "object" }, "api.SubscriptionPreferencesUpdateResponse": { "properties": { "message": { "type": "string" }, "subscriptions": { "items": { "$ref": "#/components/schemas/api.CapabilityNotificationSubscription" }, "type": "array" } }, "type": "object" }, "api.ViewManagersResponse": { "properties": { "managers": { "items": { "$ref": "#/components/schemas/api.CapabilityManager" }, "type": "array" } }, "type": "object" }, "handlers.ErrorResponse": { "properties": { "error": { "type": "string" } }, "type": "object" }, "handlers.capabilitySubscriberResponse": { "properties": { "description": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "preferred_locale": { "type": "string" } }, "type": "object" }, "handlers.incidentFollowConfirmationResponse": { "properties": { "incident_id": { "type": "integer" }, "incident_url": { "type": "string" }, "manage_url": { "type": "string" }, "message": { "type": "string" }, "subscriber": { "$ref": "#/components/schemas/handlers.capabilitySubscriberResponse" } }, "type": "object" }, "handlers.managerEmailRequest": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "type": "object" }, "handlers.managerTransferRequest": { "properties": { "confirm_email": { "type": "string" }, "email": { "type": "string" } }, "required": [ "email" ], "type": "object" }, "handlers.subscriberManagerRequest": { "properties": { "confirm_email": { "type": "string" }, "email": { "type": "string" }, "token": { "format": "password", "type": "string", "writeOnly": true } }, "type": "object" }, "handlers.subscriberProfileRequest": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "token": { "format": "password", "type": "string", "writeOnly": true } }, "type": "object" }, "handlers.tokenRequest": { "properties": { "token": { "format": "password", "type": "string", "writeOnly": true } }, "required": [ "token" ], "type": "object" }, "handlers.updateFeedRequest": { "properties": { "component_ids": { "$ref": "#/components/schemas/models.IntArray" }, "description": { "type": "string" }, "format": { "type": "string" }, "incident_statuses": { "$ref": "#/components/schemas/models.StringArray" }, "include_incidents": { "type": "boolean" }, "include_maintenance": { "type": "boolean" }, "include_status_changes": { "type": "boolean" }, "language": { "type": "string" }, "lifecycle_stage_ids": { "$ref": "#/components/schemas/models.IntArray" }, "max_age_days": { "type": "integer" }, "max_items": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "format", "language", "max_age_days", "max_items", "name" ], "type": "object" }, "handlers.updatePreferencesRequest": { "properties": { "subscriptions": { "items": { "$ref": "#/components/schemas/service.SubscriptionPreferenceInput" }, "type": "array" }, "token": { "format": "password", "type": "string", "writeOnly": true } }, "type": "object" }, "handlers.updateViewRequest": { "properties": { "access_message": { "type": "string" }, "access_mode": { "type": "string" }, "access_session_ttl_minutes": { "type": "integer" }, "alias": { "type": "string" }, "allowed_domains": { "items": { "type": "string" }, "type": "array" }, "allowed_emails": { "items": { "type": "string" }, "type": "array" }, "component_ids": { "$ref": "#/components/schemas/models.IntArray" }, "description": { "type": "string" }, "incident_card_settings_enabled": { "type": "boolean" }, "incident_primary_message_mode": { "type": "string" }, "name": { "type": "string" }, "show_incident_affected_summary": { "type": "boolean" }, "show_incident_impact_in_collapsed": { "type": "boolean" }, "show_incident_last_updated_at": { "type": "boolean" }, "show_incident_started_at": { "type": "boolean" }, "show_incident_view_details_link": { "type": "boolean" } }, "required": [ "component_ids", "name" ], "type": "object" }, "models.IntArray": { "items": { "type": "integer" }, "type": "array" }, "models.NotificationChannel": { "enum": [ "email", "sms", "webhook", "rss" ], "type": "string" }, "models.StringArray": { "items": { "type": "string" }, "type": "array" }, "service.SubscriptionPreferenceInput": { "properties": { "channel": { "$ref": "#/components/schemas/models.NotificationChannel" }, "destination": { "type": "string" }, "enabled": { "type": "boolean" }, "incident_events": { "items": { "type": "string" }, "type": "array" }, "maintenance_events": { "items": { "type": "string" }, "type": "array" }, "min_severity": { "type": "string" }, "scope_ref": { "type": "string" }, "scope_type": { "type": "string" } }, "type": "object" } }, "securitySchemes": { "MagicToken": { "description": "Delegated, short-lived credential sent by a StatiBeat management or verification link.", "in": "header", "name": "X-Magic-Token", "type": "apiKey" } } }, "info": { "contact": { "name": "StatiBeat support" }, "description": "Public-page management operations authenticated with a page- or resource-specific MagicToken. This is separate from the unauthenticated Visitor API.", "license": { "name": "Proprietary" }, "title": "StatiBeat Delegated Public Management API", "version": "1.0.0" }, "openapi": "3.0.3", "paths": { "/api/v1/pages/by-public-slug/{public_slug}/feeds/{code}": { "delete": { "description": "Authentication: magic token required.", "operationId": "rssFeed_DeleteFeed_delete_pages_by_public_slug_public_slug_feeds_code", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Delete Feed", "tags": [ "feeds" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "put": { "description": "Authentication: magic token required.", "operationId": "rssFeed_UpdateFeed_put_pages_by_public_slug_public_slug_feeds_code", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.updateFeedRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Update Feed", "tags": [ "feeds" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/feeds/{code}/managers": { "get": { "description": "Authentication: magic token required.", "operationId": "rssFeed_GetManagers_get_pages_by_public_slug_public_slug_feeds_code_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/api.CapabilityManager" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Get Managers", "tags": [ "feeds" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "post": { "description": "Authentication: magic token required.", "operationId": "rssFeed_AddManager_post_pages_by_public_slug_public_slug_feeds_code_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.managerEmailRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Add Manager", "tags": [ "feeds" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/feeds/{code}/managers/{email}": { "delete": { "description": "Authentication: magic token required.", "operationId": "rssFeed_RemoveManager_delete_pages_by_public_slug_public_slug_feeds_code_managers_email", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } }, { "description": "email", "in": "path", "name": "email", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Remove Manager", "tags": [ "feeds" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources": { "get": { "description": "Authentication: magic token required.", "operationId": "management_ListResources_get_pages_by_public_slug_public_slug_manage_resources", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_views": [ { "name": "API Consumers", "short_code": "api-consumers", "url": "https://status.example.com/views/api-consumers" } ], "email": "ops@example.com", "rss_feeds": [ { "name": "Platform incidents feed", "short_code": "platform-feed", "url": "https://status.example.com/feeds/platform-feed" } ], "subscriptions": [ { "email": "ops@example.com", "id": 101, "name": "Ops Team", "status": "active" } ] }, "schema": { "$ref": "#/components/schemas/api.CapabilityManagedResourceBundle" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "List Resources", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/feeds/{code}": { "put": { "description": "Authentication: magic token required.", "operationId": "management_UpdateRSSFeed_put_pages_by_public_slug_public_slug_manage_resources_feeds_code", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.updateFeedRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Update RSS Feed", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/feeds/{code}/managers": { "get": { "description": "Authentication: magic token required.", "operationId": "management_GetRSSFeedManagers_get_pages_by_public_slug_public_slug_manage_resources_feeds_code_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.RSSFeedManagersResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Get RSS Feed Managers", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "post": { "description": "Authentication: magic token required.", "operationId": "management_AddRSSFeedManager_post_pages_by_public_slug_public_slug_manage_resources_feeds_code_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.EmailRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Add RSS Feed Manager", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/feeds/{code}/managers/{email}": { "delete": { "description": "Authentication: magic token required.", "operationId": "management_RemoveRSSFeedManager_delete_pages_by_public_slug_public_slug_manage_resources_feeds_code_managers_email", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } }, { "description": "email", "in": "path", "name": "email", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Remove RSS Feed Manager", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/subscriptions/profiles": { "post": { "description": "Authentication: magic token required.", "operationId": "management_CreateSubscriptionProfile_post_pages_by_public_slug_public_slug_manage_resources_subscriptions_profiles", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.NameDescriptionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.ManagedProfileResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Create Subscription Profile", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/subscriptions/{id}/managers": { "get": { "description": "Authentication: magic token required.", "operationId": "management_GetSubscriptionManagers_get_pages_by_public_slug_public_slug_manage_resources_subscriptions_id_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriberManagersResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Get Subscription Managers", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "post": { "description": "Authentication: magic token required.", "operationId": "management_AddSubscriptionManager_post_pages_by_public_slug_public_slug_manage_resources_subscriptions_id_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.EmailRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Add Subscription Manager", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/subscriptions/{id}/managers/transfer-owner": { "post": { "description": "Authentication: magic token required.", "operationId": "management_TransferSubscriptionOwnership_post_pages_by_public_slug_public_slug_manage_resources_subscriptions_id_managers_transfer_owner", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.EmailTransferRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Transfer Subscription Ownership", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/subscriptions/{id}/managers/{email}": { "delete": { "description": "Authentication: magic token required.", "operationId": "management_RemoveSubscriptionManager_delete_pages_by_public_slug_public_slug_manage_resources_subscriptions_id_managers_email", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } }, { "description": "email", "in": "path", "name": "email", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Remove Subscription Manager", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/subscriptions/{id}/preferences": { "get": { "description": "Authentication: magic token required.", "operationId": "management_GetSubscriptionPreferences_get_pages_by_public_slug_public_slug_manage_resources_subscriptions_id_preferences", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriptionPreferencesResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Get Subscription Preferences", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "put": { "description": "Authentication: magic token required.", "operationId": "management_UpdateSubscriptionPreferences_put_pages_by_public_slug_public_slug_manage_resources_subscriptions_id_preferences", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriptionPreferencesUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriptionPreferencesUpdateResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Update Subscription Preferences", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/subscriptions/{id}/profile": { "put": { "description": "Authentication: magic token required.", "operationId": "management_UpdateSubscriptionProfile_put_pages_by_public_slug_public_slug_manage_resources_subscriptions_id_profile", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.NameDescriptionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriberResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Update Subscription Profile", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/views/{code}": { "put": { "description": "Authentication: magic token required.", "operationId": "management_UpdateCustomView_put_pages_by_public_slug_public_slug_manage_resources_views_code", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.updateViewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Update Custom View", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/views/{code}/managers": { "get": { "description": "Authentication: magic token required.", "operationId": "management_GetCustomViewManagers_get_pages_by_public_slug_public_slug_manage_resources_views_code_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.ViewManagersResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Get Custom View Managers", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "post": { "description": "Authentication: magic token required.", "operationId": "management_AddCustomViewManager_post_pages_by_public_slug_public_slug_manage_resources_views_code_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.EmailRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Add Custom View Manager", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/views/{code}/managers/transfer-owner": { "post": { "description": "Authentication: magic token required.", "operationId": "management_TransferCustomViewOwnership_post_pages_by_public_slug_public_slug_manage_resources_views_code_managers_transfer_owner", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.EmailTransferRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Transfer Custom View Ownership", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/manage/resources/views/{code}/managers/{email}": { "delete": { "description": "Authentication: magic token required.", "operationId": "management_RemoveCustomViewManager_delete_pages_by_public_slug_public_slug_manage_resources_views_code_managers_email", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } }, { "description": "email", "in": "path", "name": "email", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Remove Custom View Manager", "tags": [ "management" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/subscribers/follow/confirm": { "post": { "description": "Authentication: magic token required. Confirms email ownership and activates an email preference scoped to one active incident.", "operationId": "subscriber_ConfirmIncidentFollow_post_pages_by_public_slug_public_slug_subscribers_follow_confirm", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.tokenRequest" } } }, "description": "Confirmation token", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.incidentFollowConfirmationResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Confirm an incident follow request", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/subscribers/preferences": { "get": { "description": "Authentication: magic token required.", "operationId": "subscriber_GetPreferences_get_pages_by_public_slug_public_slug_subscribers_preferences", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriptionPreferencesResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Get Subscriber Preferences", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "put": { "description": "Authentication: magic token required.", "operationId": "subscriber_UpdatePreferences_put_pages_by_public_slug_public_slug_subscribers_preferences", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.updatePreferencesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriptionPreferencesUpdateResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Update Subscriber Preferences", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/subscribers/preferences/managers": { "get": { "description": "Authentication: magic token required.", "operationId": "subscriber_GetManagers_get_pages_by_public_slug_public_slug_subscribers_preferences_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriberManagersResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "List Subscriber Managers", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "post": { "description": "Authentication: magic token required.", "operationId": "subscriber_AddManager_post_pages_by_public_slug_public_slug_subscribers_preferences_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.subscriberManagerRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Add Subscriber Manager", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/subscribers/preferences/managers/transfer-owner": { "post": { "description": "Authentication: magic token required.", "operationId": "subscriber_TransferOwnership_post_pages_by_public_slug_public_slug_subscribers_preferences_managers_transfer_owner", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.subscriberManagerRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Transfer Subscription Ownership", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/subscribers/preferences/managers/{email}": { "delete": { "description": "Authentication: magic token required.", "operationId": "subscriber_RemoveManager_delete_pages_by_public_slug_public_slug_subscribers_preferences_managers_email", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "email", "in": "path", "name": "email", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Remove Subscriber Manager", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/subscribers/preferences/profile": { "put": { "description": "Authentication: magic token required.", "operationId": "subscriber_UpdateProfile_put_pages_by_public_slug_public_slug_subscribers_preferences_profile", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.subscriberProfileRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.SubscriberResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Update Subscriber Profile", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/subscribers/preferences/profiles": { "get": { "description": "Authentication: magic token required.", "operationId": "subscriber_ListProfiles_get_pages_by_public_slug_public_slug_subscribers_preferences_profiles", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.ManagedProfilesResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "List Managed Subscription Profiles", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "post": { "description": "Authentication: magic token required.", "operationId": "subscriber_CreateProfile_post_pages_by_public_slug_public_slug_subscribers_preferences_profiles", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.subscriberProfileRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.ManagedProfileResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Create Managed Subscription Profile", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/subscribers/unsubscribe": { "post": { "description": "Authentication: magic token required.", "operationId": "subscriber_Unsubscribe_post_pages_by_public_slug_public_slug_subscribers_unsubscribe", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.tokenRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Unsubscribe", "tags": [ "subscribers" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/views/{code}": { "delete": { "description": "Authentication: magic token required.", "operationId": "customView_DeleteView_delete_pages_by_public_slug_public_slug_views_code", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Delete View", "tags": [ "views" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "put": { "description": "Authentication: magic token required.", "operationId": "customView_UpdateView_put_pages_by_public_slug_public_slug_views_code", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.updateViewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Update View", "tags": [ "views" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/views/{code}/managers": { "get": { "description": "Authentication: magic token required.", "operationId": "customView_GetManagers_get_pages_by_public_slug_public_slug_views_code_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/api.CapabilityManager" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Get Managers", "tags": [ "views" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" }, "post": { "description": "Authentication: magic token required.", "operationId": "customView_AddManager_post_pages_by_public_slug_public_slug_views_code_managers", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.managerEmailRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Add Manager", "tags": [ "views" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/views/{code}/managers/transfer-owner": { "post": { "description": "Authentication: magic token required.", "operationId": "customView_TransferOwnership_post_pages_by_public_slug_public_slug_views_code_managers_transfer_owner", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.managerTransferRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Transfer View Ownership", "tags": [ "views" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } }, "/api/v1/pages/by-public-slug/{public_slug}/views/{code}/managers/{email}": { "delete": { "description": "Authentication: magic token required.", "operationId": "customView_RemoveManager_delete_pages_by_public_slug_public_slug_views_code_managers_email", "parameters": [ { "description": "Public status page URL prefix", "in": "path", "name": "public_slug", "required": true, "schema": { "type": "string" } }, { "description": "code", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } }, { "description": "email", "in": "path", "name": "email", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "MagicToken": [] } ], "summary": "Remove Manager", "tags": [ "views" ], "x-statibeat-audience": "product-or-service", "x-statibeat-auth": "magic-token", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "public-management" } } }, "servers": [ { "description": "Use your status page or custom domain as the API host.", "url": "https://{page_host}", "variables": { "page_host": { "default": "status.example.com", "description": "Replace with your page host, for example status.example.com or status.your-company.com." } } } ], "tags": [ { "description": "Create and manage RSS or Atom status feeds.", "name": "feeds" }, { "description": "Operations for the management capability.", "name": "management" }, { "description": "Subscribe visitors and manage notification preferences.", "name": "subscribers" }, { "description": "Create and manage custom visitor views.", "name": "views" } ], "x-tagGroups": [ { "name": "Delegated Public Management", "tags": [ "feeds", "management", "subscribers", "views" ] } ] }