{ "openapi": "3.1.0", "info": { "description": "Welcome to the official [Status.io](https://status.io) Developer API. This API is designed to help you seamlessly integrate your existing tools with your status page.\n\n# API Testing\n\n## Live Sandbox\n\nUse the built-in API client to test and debug API calls, and view example requests in multiple programming languages.\n\n**Caution:** These are live API calls and will make real changes to your status page. We strongly recommend creating a separate status page for testing purposes.\n\n# Authentication\n\nInclude **x-api-id** and **x-api-key** in the header of every request.\n\nAPI credentials are available in the API tab of your Dashboard.\n\n**Note:** Each team member has their own unique API credentials.\n\n# Error Handling\n\nAll API responses include a status object.\n\nCheck the **status.error** field (\"yes\" or \"no\") and refer to **status.message** for details.\n\n## Success Example\n\n```\n {\"status\":\n {\n \"error\": \"no\",\n \"message\": \"OK\"\n }\n }\n```\n\n## Failure Example\n\n```\n {\"status\":\n {\n \"error\": \"yes\",\n \"message\": \"Authentication failed\"\n }\n }\n```\n\n## Invalid URLs\n\nIf an invalid URL or HTTP method is used, the API will respond with a **403 Forbidden** error.\n\n## Validation Errors\n\nIf input parameters are of the wrong type or missing, the API will return a **400 Bad Request** error.\n\n# Client Libraries\n\nWe provide official client libraries in several languages to help you get started quickly:\n\nGo - [statusio-go](https://github.com/statusio/statusio-go)\n\nNode.js - [statusio-node](https://github.com/statusio/statusio-node)\n\nPHP - [statusio-php](https://github.com/statusio/statusio-php)\n\nPython - [statusio-python](https://github.com/statusio/statusio-python)\n\nRuby - [statusio-ruby](https://github.com/statusio/statusio-ruby)\n\nRust - [statusio](https://github.com/SecurityInsanity/statusio) (Created and maintained by a third-party developer.)\n\n# Data Format\n\nAll requests and responses use JSON.\n\nInclude the following header in all requests:\n\n```\nContent-Type: application/json\n```\n\n## Dates and Times\n\nAll timestamps returned by the API are in UTC.\n\nHowever, custom time zone settings are automatically applied for viewers of your status page.\n\n# Best Practices\n\n## Use Caching\n\nWhenever possible, cache API responses server-side.\n\nAvoid making a new API call for every page hit, especially under load, as this can cause your connection to be throttled.\n\nIf the data doesn’t change frequently, caching will improve performance and reliability.\n\n## Use Reasonable Polling Intervals\n\nAvoid checking for updates too frequently. For example, polling every second for a status update offers no real benefit since the highest meaningful resolution is one minute. Requests more frequent than this may be rate-limited or blocked.\n\n## Only Send Meaningful Updates\n\nSend updates only when status changes occur. Avoid repeatedly reporting the same status, such as continuously reporting that a component is operational when no change has occurred.\n\n## Limit Concurrent Requests\n\nOnly send **one API request at a time**. If you need to send multiple updates, queue them and send them sequentially, waiting at least **1 second between requests** to avoid triggering rate limits.\n\n## Expect Network Issues\n\nNetwork connectivity can be intermittent. Design your integration to handle timeouts and failures gracefully. Always implement proper error handling and retry logic. Never assume every request will succeed.\n\n# Support\n\nWe are here to help. If you encounter any issues or have suggestions for improvement, please reach out: hello@status.io\n\n# Security\n\nWe support and appreciate responsible disclosure.\n\nTo report a security issue, contact our security team at: security@status.io.\n\nIf you’re sharing sensitive information, please encrypt it using our [PGP key](https://status.io/public_key.txt).", "title": "Status.io API v2", "version": "" }, "servers": [ { "url": "https://api.status.io/v2" } ], "paths": { "/component/list/{statuspage_id}": { "get": { "operationId": "get-component-list-statuspage-id", "summary": "List Components", "description": "List all components and their associated containers for a status page.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "53d75690483cd492cf000008" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": [ { "__v": 0, "_id": "53d75690483cd492cf000008", "containers": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "name": "Database", "position": 2, "statuspage": "53d74690383cd493cf000008" }, { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" }, { "__v": 0, "_id": "52e5e2d6b799555038000009", "location": "ap-northeast-1", "name": "Tokyo" } ], "name": "Website", "position": 1, "statuspage": "53d74690383cd493cf000008" } ], "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } }, "required": [ "__v", "_id", "name", "location" ], "type": "object" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } }, "required": [ "__v", "_id", "containers", "name", "position", "statuspage" ], "type": "object" } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": [ { "__v": 0, "_id": "53d75690483cd492cf000008", "containers": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "name": "Database", "position": 2, "statuspage": "53d74690383cd493cf000008" }, { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" }, { "__v": 0, "_id": "52e5e2d6b799555038000009", "location": "ap-northeast-1", "name": "Tokyo" } ], "name": "Website", "position": 1, "statuspage": "53d74690383cd493cf000008" } ], "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Components" ] } }, "/component/status/update": { "post": { "operationId": "post-component-status-update", "summary": "Update Component Status", "description": "Update the status of a component without creating an incident.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "component", "container", "details", "current_status" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page", "example": "52e5e0e0893548543700000b" }, "component": { "type": "string", "description": "ID of the component whose status you are updating.", "example": "53d7459705ddbc753f000bbd" }, "container": { "type": "string", "description": "ID of the container. The container must be attached to the specified component.", "example": "53d7455aedd0ac2340000600" }, "current_status": { "type": "number", "description": "Numeric status level code. Custom labels and colors on your status page do not change these codes.", "enum": [ 100, 200, 300, 400, 500, 600 ], "x-enum-descriptions": { "100": "Operational", "200": "Planned maintenance", "300": "Degraded performance", "400": "Partial service disruption", "500": "Service disruption", "600": "Security issue" }, "example": 500 }, "details": { "type": "string", "description": "Short message shown with this status change (what subscribers and visitors should know).", "example": "Database server is experiencing connectivity issues" } }, "examples": [ { "component": "53d7459705ddbc753f000bbd", "container": "53d7455aedd0ac2340000600", "current_status": 500, "details": "Database server is experiencing connectivity issues", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Components" ] } }, "/incident/list/active/{statuspage_id}": { "get": { "operationId": "get-incident-list-active-statuspage-id", "summary": "List Active Incidents", "description": "List active incidents.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "page", "in": "query", "description": "Page number to navigate through results", "required": true, "schema": { "type": "string" }, "example": "2" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [ "Incidents" ] } }, "/incident/list/resolved/{statuspage_id}": { "get": { "operationId": "get-incident-list-resolved-statuspage-id", "summary": "List Resolved Incidents", "description": "List resolved incidents.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "page", "in": "query", "description": "Page number to navigate through results", "required": true, "schema": { "type": "string" }, "example": "2" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [ "Incidents" ] } }, "/incident/list/{statuspage_id}": { "get": { "operationId": "get-incident-list-statuspage-id", "summary": "List Incidents (Deprecated)", "description": "**DEPRECATED**\n\nList all active and resolved incidents for a status page. Limited to 100 results.\n\n**Warning:** This method will be removed in future versions. Use the *incident/list/active* and *incident/list/resolved* methods instead.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "active_incidents": [ { "__v": 0, "_id": "52e5ebd1e32578623900000c", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" }, { "__v": 0, "_id": "52e5e2d6b799555038000009", "location": "ap-northeast-1", "name": "Tokyo" } ], "datetime_open": "2014-01-27T05:17:05.089Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "incident", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5ebd1e32578623900000d", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "datetime": "2014-01-27T05:17:05.185Z", "details": "We are currently investigating the issue and working to identify the root cause.", "incident": "52e5ebd1e32578623900000c", "ip": "203.0.113.42", "source": "Dashboard", "state": 100, "status": 300, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Elevated Web Error Rate", "statuspage": "52e5e0e0893548543700000b" } ], "resolved_incidents": [] }, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "active_incidents": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "components_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "containers_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } }, "required": [ "__v", "_id", "name", "location" ], "type": "object" } }, "datetime_open": { "type": "string" }, "infrastructure_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "component": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } } }, "container": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "location_geo": { "type": "object", "properties": { "coords": { "type": "array", "items": {} } } }, "name": { "type": "string" }, "position": { "type": "number" } } } }, "type": "object" } }, "kind": { "type": "string" }, "messages": { "type": "array", "items": { "properties": { "components": { "items": { "type": "string" }, "type": "array" }, "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "datetime": { "type": "string" }, "details": { "type": "string" }, "incident": { "type": "string" }, "ip": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "name": { "type": "string" }, "statuspage": { "type": "string" } }, "type": "object" } }, "resolved_incidents": { "type": "array", "items": {} } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "active_incidents": [ { "__v": 0, "_id": "52e5ebd1e32578623900000c", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" }, { "__v": 0, "_id": "52e5e2d6b799555038000009", "location": "ap-northeast-1", "name": "Tokyo" } ], "datetime_open": "2014-01-27T05:17:05.089Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "incident", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5ebd1e32578623900000d", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "datetime": "2014-01-27T05:17:05.185Z", "details": "We are currently investigating the issue and working to identify the root cause.", "incident": "52e5ebd1e32578623900000c", "ip": "203.0.113.42", "source": "Dashboard", "state": 100, "status": 300, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Elevated Web Error Rate", "statuspage": "52e5e0e0893548543700000b" } ], "resolved_incidents": [] }, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Incidents" ] } }, "/incidents/{statuspage_id}": { "get": { "operationId": "get-incidents-statuspage-id", "summary": "List Incidents", "description": "Retrieve the IDs for all active and resolved incidents. This endpoint is useful for quickly checking which incidents exist without fetching full incident details.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [ "Incidents" ] } }, "/incident/{statuspage_id}/{incident_id}": { "get": { "operationId": "get-incident-statuspage-id-incident-id", "summary": "Get Incident", "description": "Retrieve the full details of a specific incident. This endpoint provides comprehensive information about an incident, including its components, containers, infrastructure, messages, and more.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "incident_id", "in": "path", "description": "ID of the incident", "required": true, "schema": { "type": "string" }, "example": "52e5ebd1e32578623900000c" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [ "Incidents" ] } }, "/incident/message/{statuspage_id}/{message_id}": { "get": { "operationId": "get-incident-message-statuspage-id-message-id", "summary": "Get Incident Message", "description": "Retrieve the full details of a specific incident message.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "message_id", "in": "path", "description": "ID of the message", "required": true, "schema": { "type": "string" }, "example": "52e5ebd1e32578623900000d" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5ebd1e32578623900000d", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-08-24T05:00:13.025Z", "details": "We are investigating elevated database error rates affecting our primary data center.", "incident": "52e5ebd1e32578623900000c", "ip": "203.0.113.42", "social": "0", "source": "API", "state": 100, "status": 300, "statuspage": "52e5e0e0893548543700000b", "user_email": "admin@acme-corp.com", "user_full_name": "John Smith" }, "status": { "error": "no", "message": "Get incident message success" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "components": { "items": { "type": "string" }, "type": "array" }, "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "datetime": { "type": "string" }, "details": { "type": "string" }, "incident": { "type": "string" }, "ip": { "type": "string" }, "social": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" }, "statuspage": { "type": "string" }, "user_email": { "type": "string" }, "user_full_name": { "type": "string" } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5ebd1e32578623900000d", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-08-24T05:00:13.025Z", "details": "We are investigating elevated database error rates affecting our primary data center.", "incident": "52e5ebd1e32578623900000c", "ip": "203.0.113.42", "social": "0", "source": "API", "state": 100, "status": 300, "statuspage": "52e5e0e0893548543700000b", "user_email": "admin@acme-corp.com", "user_full_name": "John Smith" }, "status": { "error": "no", "message": "Get incident message success" } } ] } } } } }, "tags": [ "Incidents" ] } }, "/incident/create": { "post": { "operationId": "post-incident-create", "summary": "Create Incident", "description": "Create a new incident.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "incident_name", "incident_details", "current_status", "current_state", "all_infrastructure_affected", "infrastructure_affected", "social" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "all_infrastructure_affected": { "type": "string", "description": "Apply to all components and containers. Set to `1` to affect all infrastructure, `0` to use specific infrastructure_affected list (default: `0`)." }, "infrastructure_affected": { "type": "array", "items": { "type": "string", "description": "Array of component-container ID pairs in the format `component_id-container_id`" } }, "incident_name": { "type": "string", "description": "Descriptive title for the incident" }, "incident_details": { "type": "string", "description": "Message describing this incident" }, "current_status": { "type": "number", "description": "The status of the components and containers affected by this incident.", "enum": [ 100, 300, 400, 500, 600 ], "x-enum-descriptions": { "100": "Operational", "300": "Degraded performance", "400": "Partial service disruption", "500": "Service disruption", "600": "Security issue" } }, "current_state": { "type": "number", "description": "The state of this incident.", "enum": [ 100, 200, 300, 400 ], "x-enum-descriptions": { "100": "Investigating", "200": "Identified", "300": "Monitoring", "400": "Resolved" } }, "social": { "type": "string", "description": "Automatically post this update to Twitter/X. Set to `1` to post a message, `0` to skip." }, "notify_email": { "type": "string", "description": "Notify email subscribers. Set to `1` to send notification, `0` to skip." }, "notify_sms": { "type": "string", "description": "Notify SMS subscribers. Set to `1` to send notification, `0` to skip." }, "notify_webhook": { "type": "string", "description": "Notify webhook subscribers. Set to `1` to send notification, `0` to skip." }, "irc": { "type": "string", "description": "Notify IRC channel. Set to `1` to send notification, `0` to skip." }, "msteams": { "type": "string", "description": "Notify Microsoft Teams channels. Set to `1` to send notification, `0` to skip." }, "slack": { "type": "string", "description": "Notify Slack channels. Set to `1` to send notification, `0` to skip." }, "message_subject": { "type": "string", "description": "The message subject for email notifications. [How to use variables in the message subject](http://kb.status.io/notifications/message-subject-variables/)" } }, "examples": [ { "all_infrastructure_affected": "0", "current_status": 300, "current_state": 100, "incident_details": "We are investigating database connection issues affecting our primary data center. Some users may experience intermittent service disruptions.", "incident_name": "Database Connection Issues", "infrastructure_affected": [ "53d746c0383cd493cf00001a-53d746c0383cd493cf00001b", "53d746c0383cd493cf00001a-53d746c8383cd493cf00001e" ], "irc": "0", "message_subject": "Service Incident: Database Connection Issues", "msteams": "0", "notify_email": "0", "notify_sms": "1", "notify_webhook": "0", "slack": "0", "social": "0", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": "52e5e0e3290548543700000b", "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "string" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": "52e5e0e3290548543700000b", "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Incidents" ] } }, "/incident/update": { "post": { "operationId": "post-incident-update", "summary": "Update Incident", "description": "Update an existing incident.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "incident_id", "incident_details", "current_status", "current_state", "social" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "incident_id": { "type": "string", "description": "ID of the incident" }, "incident_details": { "type": "string", "description": "Message describing this incident update" }, "current_status": { "type": "number", "description": "The status of the components and containers affected by this incident.", "enum": [ 100, 300, 400, 500, 600 ], "x-enum-descriptions": { "100": "Operational", "300": "Degraded performance", "400": "Partial service disruption", "500": "Service disruption", "600": "Security issue" } }, "current_state": { "type": "number", "description": "The state of this incident.", "enum": [ 100, 200, 300, 400 ], "x-enum-descriptions": { "100": "Investigating", "200": "Identified", "300": "Monitoring", "400": "Resolved" } }, "social": { "type": "string", "description": "Automatically post this update to Twitter/X. Set to `1` to post a message, `0` to skip." }, "notify_email": { "type": "string", "description": "Notify email subscribers. Set to `1` to send notification, `0` to skip." }, "notify_sms": { "type": "string", "description": "Notify SMS subscribers. Set to `1` to send notification, `0` to skip." }, "notify_webhook": { "type": "string", "description": "Notify webhook subscribers. Set to `1` to send notification, `0` to skip." }, "irc": { "type": "string", "description": "Notify IRC channel. Set to `1` to send notification, `0` to skip." }, "msteams": { "type": "string", "description": "Notify Microsoft Teams channels. Set to `1` to send notification, `0` to skip." }, "slack": { "type": "string", "description": "Notify Slack channels. Set to `1` to send notification, `0` to skip." }, "message_subject": { "type": "string", "description": "The message subject for email notifications. [How to use variables in the message subject](http://kb.status.io/notifications/message-subject-variables/)" } }, "examples": [ { "current_state": 200, "current_status": 300, "incident_details": "We have implemented a temporary workaround and are monitoring the situation closely. Service should be restored shortly.", "incident_id": "52e5ebd1e32578623900000c", "irc": "0", "message_subject": "Service Incident Update: Database Connection Issues", "msteams": "0", "notify_email": "0", "notify_sms": "0", "notify_webhook": "0", "slack": "0", "social": "0", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Incidents" ] } }, "/incident/resolve": { "post": { "operationId": "post-incident-resolve", "summary": "Resolve Incident", "description": "Resolve an existing incident.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "incident_id", "incident_details", "social" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "incident_id": { "type": "string", "description": "ID of the incident" }, "incident_details": { "type": "string", "description": "Message describing this incident" }, "social": { "type": "string", "description": "Automatically post this update to Twitter/X. Set to `1` to post a message, `0` to skip." }, "notify_email": { "type": "string", "description": "Notify email subscribers. Set to `1` to send notification, `0` to skip." }, "notify_sms": { "type": "string", "description": "Notify SMS subscribers. Set to `1` to send notification, `0` to skip." }, "notify_webhook": { "type": "string", "description": "Notify webhook subscribers. Set to `1` to send notification, `0` to skip." }, "irc": { "type": "string", "description": "Notify IRC channel. Set to `1` to send notification, `0` to skip." }, "msteams": { "type": "string", "description": "Notify Microsoft Teams channels. Set to `1` to send notification, `0` to skip." }, "slack": { "type": "string", "description": "Notify Slack channels. Set to `1` to send notification, `0` to skip." }, "message_subject": { "type": "string", "description": "The message subject for email notifications. [How to use variables in the message subject](http://kb.status.io/notifications/message-subject-variables/)" } }, "examples": [ { "incident_details": "The issue has been resolved. All systems are now operating normally. We apologize for any inconvenience this may have caused.", "incident_id": "52e5ebd1e32578623900000c", "irc": "0", "message_subject": "Service Incident Resolved: Database Connection Issues", "msteams": "0", "notify_email": "0", "notify_sms": "1", "notify_webhook": "0", "slack": "0", "social": "0", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Incidents" ] } }, "/incident/delete": { "post": { "operationId": "post-incident-delete", "summary": "Delete Incident", "description": "Delete an existing incident.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "incident_id" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "incident_id": { "type": "string", "description": "ID of the incident" } }, "examples": [ { "statuspage_id": "52e5e0e0893548543700000b", "incident_id": "52e5ebd1e32578623900000c" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "Successfully deleted incident" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "Successfully deleted incident" } } ] } } } } }, "tags": [ "Incidents" ] } }, "/incident/history/create": { "post": { "operationId": "post-incident-history-create", "summary": "Create Historic Incident", "description": "Create a historic incident.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "incident_name", "incident_details_start", "incident_details_resolve", "incident_start_date", "incident_start_time", "incident_end_date", "incident_end_time", "current_status" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "all_infrastructure_affected": { "type": "string", "description": "Apply to all components and containers. Set to `1` to affect all infrastructure, `0` to use specific infrastructure_affected list (default: `0`)." }, "infrastructure_affected": { "type": "array", "items": { "type": "string", "description": "Array of component-container ID pairs in the format `component_id-container_id`" } }, "incident_details_start": { "type": "string", "description": "Message describing the start of this incident" }, "incident_name": { "type": "string", "description": "Descriptive title for the incident" }, "incident_details_resolve": { "type": "string", "description": "Message describing the resolution of this incident" }, "current_status": { "type": "number", "description": "The original status of the components and containers affected by this incident.", "enum": [ 100, 300, 400, 500, 600 ], "x-enum-descriptions": { "100": "Operational", "300": "Degraded performance", "400": "Partial service disruption", "500": "Service disruption", "600": "Security issue" } }, "incident_start_date": { "type": "string", "description": "Incident start date (MM/dd/yyyy)" }, "incident_start_time": { "type": "string", "description": "Incident start time (HH:mm)" }, "incident_end_date": { "type": "string", "description": "Incident end date (MM/dd/yyyy)" }, "incident_end_time": { "type": "string", "description": "Incident end time (HH:mm)" } }, "examples": [ { "all_infrastructure_affected": "0", "current_status": 300, "incident_details_resolve": "This issue has been resolved. The connection errors were caused by a failing node that was not automatically removed from the cluster. All systems are now operating normally.", "incident_details_start": "We are investigating API connection errors affecting our service endpoints. Some API requests may experience delays or timeouts.", "incident_end_date": "05/01/2015", "incident_end_time": "03:15", "incident_name": "API Service Disruption", "incident_start_date": "05/01/2015", "incident_start_time": "03:00", "infrastructure_affected": [ "53d746c0383cd493cf00001a-53d746c0383cd493cf00001b", "53d746c0383cd493cf00001a-53d746c8383cd493cf00001e" ], "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": "52e5e0e3290548543700000b", "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "string" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": "52e5e0e3290548543700000b", "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Incidents" ] } }, "/maintenance/list/pending/{statuspage_id}": { "get": { "operationId": "get-maintenance-list-pending-statuspage-id", "summary": "List Pending Maintenance", "description": "List pending maintenance activities.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "page", "in": "query", "description": "Page number to navigate through results", "required": false, "schema": { "type": "string" }, "example": "2" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": [ { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" } ], "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "components_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "containers_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "datetime_open": { "type": "string" }, "datetime_planned_end": { "type": "string" }, "datetime_planned_start": { "type": "string" }, "infrastructure_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "component": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } } }, "container": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "location_geo": { "type": "object", "properties": { "coords": { "type": "array", "items": {} } } }, "name": { "type": "string" }, "position": { "type": "number" } } } }, "type": "object" } }, "kind": { "type": "string" }, "messages": { "type": "array", "items": { "properties": { "components": { "items": { "type": "string" }, "type": "array" }, "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "datetime": { "type": "string" }, "details": { "type": "string" }, "ip": { "type": "string" }, "maintenance": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "name": { "type": "string" }, "statuspage": { "type": "string" } }, "type": "object" } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": [ { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" } ], "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/list/active/{statuspage_id}": { "get": { "operationId": "get-maintenance-list-active-statuspage-id", "summary": "List Active Maintenance", "description": "List active maintenance activities.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "page", "in": "query", "description": "Page number to navigate through results", "required": false, "schema": { "type": "string" }, "example": "2" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": [ { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" } ], "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "components_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "containers_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "datetime_open": { "type": "string" }, "datetime_planned_end": { "type": "string" }, "datetime_planned_start": { "type": "string" }, "infrastructure_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "component": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } } }, "container": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "location_geo": { "type": "object", "properties": { "coords": { "type": "array", "items": {} } } }, "name": { "type": "string" }, "position": { "type": "number" } } } }, "type": "object" } }, "kind": { "type": "string" }, "messages": { "type": "array", "items": { "properties": { "components": { "items": { "type": "string" }, "type": "array" }, "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "datetime": { "type": "string" }, "details": { "type": "string" }, "ip": { "type": "string" }, "maintenance": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "name": { "type": "string" }, "statuspage": { "type": "string" } }, "type": "object" } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": [ { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" } ], "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/list/closed/{statuspage_id}": { "get": { "operationId": "get-maintenance-list-closed-statuspage-id", "summary": "List Closed Maintenance", "description": "List closed maintenance activities.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "page", "in": "query", "description": "Page number to navigate through results", "required": false, "schema": { "type": "string" }, "example": "2" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": [ { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" } ], "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "components_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "containers_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "datetime_open": { "type": "string" }, "datetime_planned_end": { "type": "string" }, "datetime_planned_start": { "type": "string" }, "infrastructure_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "component": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } } }, "container": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "location_geo": { "type": "object", "properties": { "coords": { "type": "array", "items": {} } } }, "name": { "type": "string" }, "position": { "type": "number" } } } }, "type": "object" } }, "kind": { "type": "string" }, "messages": { "type": "array", "items": { "properties": { "components": { "items": { "type": "string" }, "type": "array" }, "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "datetime": { "type": "string" }, "details": { "type": "string" }, "ip": { "type": "string" }, "maintenance": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "name": { "type": "string" }, "statuspage": { "type": "string" } }, "type": "object" } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": [ { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" } ], "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/list/{statuspage_id}": { "get": { "operationId": "get-maintenance-list-statuspage-id", "summary": "List Maintenance (Deprecated)", "description": "**DEPRECATED**\n\nRetrieve all active, resolved, and upcoming maintenance events. Limited to 100 results.\n\n**Warning:** This method will be removed in future versions. Use the *maintenance/list/pending*, *maintenance/list/active* and *maintenance/list/closed* methods instead.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "active_maintenances": [], "resolved_maintenances": [], "upcoming_maintenances": [ { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" } ] }, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "active_maintenances": { "type": "array", "items": {} }, "resolved_maintenances": { "type": "array", "items": {} }, "upcoming_maintenances": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "components_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "containers_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "datetime_open": { "type": "string" }, "datetime_planned_end": { "type": "string" }, "datetime_planned_start": { "type": "string" }, "infrastructure_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "component": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } } }, "container": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "location_geo": { "type": "object", "properties": { "coords": { "type": "array", "items": {} } } }, "name": { "type": "string" }, "position": { "type": "number" } } } }, "type": "object" } }, "kind": { "type": "string" }, "messages": { "type": "array", "items": { "properties": { "components": { "items": { "type": "string" }, "type": "array" }, "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "datetime": { "type": "string" }, "details": { "type": "string" }, "ip": { "type": "string" }, "maintenance": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "name": { "type": "string" }, "statuspage": { "type": "string" } }, "type": "object" } } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "active_maintenances": [], "resolved_maintenances": [], "upcoming_maintenances": [ { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" } ] }, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenances/{statuspage_id}": { "get": { "operationId": "get-maintenances-statuspage-id", "summary": "List Maintenance", "description": "Retrieve the IDs for all active, resolved, and upcoming maintenance events. This endpoint is useful for quickly checking which maintenance events exist without fetching full details.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "active_maintenances": [], "resolved_maintenances": [], "upcoming_maintenances": [ "52e5eacc908cdc5e39000009" ] }, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "active_maintenances": { "type": "array", "items": {} }, "resolved_maintenances": { "type": "array", "items": {} }, "upcoming_maintenances": { "type": "array", "items": { "type": "string" } } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "active_maintenances": [], "resolved_maintenances": [], "upcoming_maintenances": [ "52e5eacc908cdc5e39000009" ] }, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/{statuspage_id}/{maintenance_id}": { "get": { "operationId": "get-maintenance-statuspage-id-maintenance-id", "summary": "Get Maintenance", "description": "Retrieve a single maintenance event, including all messages and affected infrastructure.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "maintenance_id", "in": "path", "description": "ID of the maintenance event", "required": true, "schema": { "type": "string" }, "example": "52e5eacc908cdc5e39000009" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" }, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "components_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "containers_affected": { "type": "array", "items": { "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "datetime_open": { "type": "string" }, "datetime_planned_end": { "type": "string" }, "datetime_planned_start": { "type": "string" }, "infrastructure_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "component": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "position": { "type": "number" }, "statuspage": { "type": "string" } } }, "container": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "location": { "type": "string" }, "location_geo": { "type": "object", "properties": { "coords": { "type": "array", "items": {} } } }, "name": { "type": "string" }, "position": { "type": "number" } } } }, "type": "object" } }, "kind": { "type": "string" }, "messages": { "type": "array", "items": { "properties": { "components": { "items": { "type": "string" }, "type": "array" }, "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "datetime": { "type": "string" }, "details": { "type": "string" }, "ip": { "type": "string" }, "maintenance": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" }, "statuspage": { "type": "string" } }, "type": "object" } }, "name": { "type": "string" }, "statuspage": { "type": "string" } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "__v": 0, "_id": "52e5eacc908cdc5e39000009", "components_affected": [ { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" } ], "containers_affected": [ { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "name": "Amsterdam" } ], "datetime_open": "2014-01-27T05:12:44.880Z", "datetime_planned_end": "2013-12-30T12:00:00.000Z", "datetime_planned_start": "2014-01-05T12:00:00.000Z", "infrastructure_affected": [ { "_id": "5a1b41edb4546d046c8efa06", "component": { "__v": 0, "_id": "52e5e0e0893548543700001a", "containers": [ "52e5e0e08935485437000019", "52e5e2d6b799555038000009" ], "name": "Website", "position": 1, "statuspage": "52e5e0e0893548543700000b" }, "container": { "__v": 0, "_id": "52e5e0e08935485437000019", "location": "do-ams-2", "location_geo": { "coords": [] }, "name": "Amsterdam", "position": 1 } } ], "kind": "maintenance", "messages": [ { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-01-27T05:12:44.937Z", "details": "Scheduled maintenance has been planned for the Website component in the Amsterdam data center. This maintenance is expected to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 100, "status": 200, "statuspage": "52e5e0e0893548543700000b" } ], "name": "Scheduled Database Maintenance", "statuspage": "52e5e0e0893548543700000b" }, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/message/{statuspage_id}/{message_id}": { "get": { "operationId": "get-maintenance-message-statuspage-id-message-id", "summary": "Get Maintenance Message", "description": "Retrieve a single maintenance message.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "message_id", "in": "path", "description": "ID of the message", "required": true, "schema": { "type": "string" }, "example": "52e5eacc908cdc5e3900000a" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-06-07T03:08:41.233Z", "details": "Maintenance activities have commenced. We are deploying updates to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 200, "statuspage": "52e5e0e0893548543700000b" }, "status": { "error": "no", "message": "Get maintenance message success" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "components": { "items": { "type": "string" }, "type": "array" }, "v": { "type": "number" }, "id": { "type": "string" }, "containers": { "type": "array", "items": { "type": "string" } }, "datetime": { "type": "string" }, "details": { "type": "string" }, "ip": { "type": "string" }, "maintenance": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "number" }, "statuspage": { "type": "string" } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "components": [ "52e5e0e0893548543700001a" ], "__v": 0, "_id": "52e5eacc908cdc5e3900000a", "containers": [ "52e5e0e08935485437000019" ], "datetime": "2014-06-07T03:08:41.233Z", "details": "Maintenance activities have commenced. We are deploying updates to improve system performance and reliability.", "ip": "203.0.113.42", "maintenance": "52e5eacc908cdc5e39000009", "source": "Dashboard", "state": 200, "statuspage": "52e5e0e0893548543700000b" }, "status": { "error": "no", "message": "Get maintenance message success" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/schedule": { "post": { "operationId": "post-maintenance-schedule", "summary": "Schedule Maintenance", "description": "Schedule a new maintenance event.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "all_infrastructure_affected", "infrastructure_affected", "maintenance_name", "maintenance_details", "date_planned_start", "time_planned_start", "date_planned_end", "time_planned_end", "maintenance_notify_now", "maintenance_notify_72_hr", "maintenance_notify_24_hr", "maintenance_notify_1_hr", "automation" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "all_infrastructure_affected": { "type": "string", "description": "Apply to all components and containers. Set to `1` to affect all infrastructure, `0` to use specific infrastructure_affected list (default: `0`)." }, "infrastructure_affected": { "type": "array", "items": { "type": "string", "description": "Array of component-container ID pairs in the format `component_id-container_id`" } }, "maintenance_name": { "type": "string", "description": "Descriptive title for this maintenance event" }, "maintenance_details": { "type": "string", "description": "Message describing this maintenance" }, "date_planned_start": { "type": "string", "description": "Scheduled maintenance start date in MM/dd/yyyy format" }, "time_planned_start": { "type": "string", "description": "Scheduled maintenance start time in HH:mm format (24-hour)" }, "date_planned_end": { "type": "string", "description": "Scheduled maintenance end date in MM/dd/yyyy format" }, "time_planned_end": { "type": "string", "description": "Scheduled maintenance end time in HH:mm format (24-hour)" }, "maintenance_notify_now": { "type": "string", "description": "Notify subscribers immediately. Set to `1` to send notification, `0` to skip." }, "maintenance_notify_72_hr": { "type": "string", "description": "Notify subscribers 72 hours before scheduled maintenance start time. Set to `1` to send notification, `0` to skip." }, "maintenance_notify_24_hr": { "type": "string", "description": "Notify subscribers 24 hours before scheduled maintenance start time. Set to `1` to send notification, `0` to skip." }, "maintenance_notify_1_hr": { "type": "string", "description": "Notify subscribers 1 hour before scheduled maintenance start time. Set to `1` to send notification, `0` to skip." }, "message_subject": { "type": "string", "description": "The message subject for email notifications. [How to use variables in the message subject](http://kb.status.io/notifications/message-subject-variables/)" }, "automation": { "type": "string", "description": "Automatically start and end the maintenance. Set to `1` to enable automation, `0` to disable (default: `0`)." }, "automation_start_text": { "type": "string", "description": "Message content when maintenance starts" }, "automation_stop_text": { "type": "string", "description": "Message content when maintenance ends" }, "automation_notify_start_email": { "type": "string", "description": "Notify email subscribers at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_start_sms": { "type": "string", "description": "Notify SMS subscribers at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_start_webhook": { "type": "string", "description": "Notify webhook subscribers at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_start_twitter": { "type": "string", "description": "Post to Twitter/X at the start of the maintenance. Set to `1` to send tweet, `0` to skip (default: `0`)." }, "automation_notify_start_irc": { "type": "string", "description": "Notify IRC channel at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_start_msteams": { "type": "string", "description": "Notify Microsoft Teams channels at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_start_slack": { "type": "string", "description": "Notify Slack channels at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_stop_email": { "type": "string", "description": "Notify email subscribers at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_stop_sms": { "type": "string", "description": "Notify SMS subscribers at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_stop_webhook": { "type": "string", "description": "Notify webhook subscribers at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_stop_twitter": { "type": "string", "description": "Post to Twitter/X at the end of the maintenance. Set to `1` to send tweet, `0` to skip (default: `0`)." }, "automation_notify_stop_irc": { "type": "string", "description": "Notify IRC channel at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_stop_msteams": { "type": "string", "description": "Notify Microsoft Teams channels at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." }, "automation_notify_stop_slack": { "type": "string", "description": "Notify Slack channels at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`)." } }, "examples": [ { "all_infrastructure_affected": "0", "automation": "0", "date_planned_end": "05/07/2014", "date_planned_start": "05/07/2014", "infrastructure_affected": [ "53d746c0383cd493cf00001a-53d746c0383cd493cf00001b", "53d746c0383cd493cf00001a-53d746c8383cd493cf00001e" ], "maintenance_details": "We will be upgrading router firmware to version 12.0.7 to improve network performance and security. No service downtime is expected during this maintenance window.", "maintenance_name": "Network Infrastructure Upgrade", "maintenance_notify_1_hr": "0", "maintenance_notify_24_hr": "0", "maintenance_notify_72_hr": "0", "maintenance_notify_now": "0", "message_subject": "Scheduled Maintenance: Network Infrastructure Upgrade", "statuspage_id": "52e5e0e0893548543700000b", "time_planned_end": "23:30", "time_planned_start": "23:00" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": "52e5e0e3290548543700000b", "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "string" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": "52e5e0e3290548543700000b", "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/start": { "post": { "operationId": "post-maintenance-start", "summary": "Start Maintenance", "description": "Start a scheduled maintenance event immediately. This moves the maintenance from pending to active status.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "maintenance_id", "maintenance_details", "social" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "maintenance_id": { "type": "string", "description": "ID of the maintenance event" }, "maintenance_details": { "type": "string", "description": "Message describing this maintenance update" }, "social": { "type": "string", "description": "Automatically post this update to Twitter/X. Set to `1` to post a message, `0` to skip." }, "notify_email": { "type": "string", "description": "Notify email subscribers. Set to `1` to send notification, `0` to skip." }, "notify_sms": { "type": "string", "description": "Notify SMS subscribers. Set to `1` to send notification, `0` to skip." }, "notify_webhook": { "type": "string", "description": "Notify webhook subscribers. Set to `1` to send notification, `0` to skip." }, "irc": { "type": "string", "description": "Notify IRC channel. Set to `1` to send notification, `0` to skip." }, "msteams": { "type": "string", "description": "Notify Microsoft Teams channels. Set to `1` to send notification, `0` to skip." }, "slack": { "type": "string", "description": "Notify Slack channels. Set to `1` to send notification, `0` to skip." }, "message_subject": { "type": "string", "description": "The message subject for email notifications. [How to use variables in the message subject](http://kb.status.io/notifications/message-subject-variables/)" } }, "examples": [ { "irc": "0", "maintenance_details": "Scheduled maintenance has begun. We are performing the planned infrastructure upgrades. Service may experience brief interruptions during this time.", "maintenance_id": "52e5eacc908cdc5e39000009", "message_subject": "Maintenance Started: Network Infrastructure Upgrade", "msteams": "0", "notify_email": "0", "notify_sms": "1", "notify_webhook": "0", "slack": "0", "social": "0", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/update": { "post": { "operationId": "post-maintenance-update", "summary": "Update Maintenance", "description": "Update an active maintenance event with a new status message.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "maintenance_id", "maintenance_details", "social" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "maintenance_id": { "type": "string", "description": "ID of the maintenance event" }, "maintenance_details": { "type": "string", "description": "Message describing this maintenance update" }, "social": { "type": "string", "description": "Automatically post this update to Twitter/X. Set to `1` to post a message, `0` to skip." }, "notify_email": { "type": "string", "description": "Notify email subscribers. Set to `1` to send notification, `0` to skip." }, "notify_sms": { "type": "string", "description": "Notify SMS subscribers. Set to `1` to send notification, `0` to skip." }, "notify_webhook": { "type": "string", "description": "Notify webhook subscribers. Set to `1` to send notification, `0` to skip." }, "irc": { "type": "string", "description": "Notify IRC channel. Set to `1` to send notification, `0` to skip." }, "msteams": { "type": "string", "description": "Notify Microsoft Teams channels. Set to `1` to send notification, `0` to skip." }, "slack": { "type": "string", "description": "Notify Slack channels. Set to `1` to send notification, `0` to skip." }, "message_subject": { "type": "string", "description": "The message subject for email notifications. [How to use variables in the message subject](http://kb.status.io/notifications/message-subject-variables/)" } }, "examples": [ { "irc": "0", "maintenance_details": "Maintenance is progressing as planned. Servers in Amsterdam Zone 1 have been successfully upgraded. We continue to work on the remaining infrastructure components.", "maintenance_id": "52e5eacc908cdc5e39000009", "message_subject": "Maintenance Update: Network Infrastructure Upgrade", "msteams": "0", "notify_email": "0", "notify_sms": "1", "notify_webhook": "0", "slack": "0", "social": "0", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/finish": { "post": { "operationId": "post-maintenance-finish", "summary": "Finish Maintenance", "description": "Complete an active maintenance event and move it to history. This marks the maintenance as finished and updates all affected components and containers.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "maintenance_id", "maintenance_details", "social" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "maintenance_id": { "type": "string", "description": "ID of the maintenance event" }, "maintenance_details": { "type": "string", "description": "Message describing this maintenance update" }, "social": { "type": "string", "description": "Automatically post this update to Twitter/X. Set to `1` to post a message, `0` to skip." }, "notify_email": { "type": "string", "description": "Notify email subscribers. Set to `1` to send notification, `0` to skip." }, "notify_sms": { "type": "string", "description": "Notify SMS subscribers. Set to `1` to send notification, `0` to skip." }, "notify_webhook": { "type": "string", "description": "Notify webhook subscribers. Set to `1` to send notification, `0` to skip." }, "irc": { "type": "string", "description": "Notify IRC channel. Set to `1` to send notification, `0` to skip." }, "msteams": { "type": "string", "description": "Notify Microsoft Teams channels. Set to `1` to send notification, `0` to skip." }, "slack": { "type": "string", "description": "Notify Slack channels. Set to `1` to send notification, `0` to skip." }, "message_subject": { "type": "string", "description": "The message subject for email notifications. [How to use variables in the message subject](http://kb.status.io/notifications/message-subject-variables/)" } }, "examples": [ { "irc": "0", "maintenance_details": "Maintenance has been completed successfully. All systems are operating normally. Thank you for your patience during this scheduled maintenance window.", "maintenance_id": "52e5eacc908cdc5e39000009", "message_subject": "Maintenance Completed: Network Infrastructure Upgrade", "msteams": "0", "notify_email": "0", "notify_sms": "1", "notify_webhook": "0", "slack": "0", "social": "0", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/delete": { "post": { "operationId": "post-maintenance-delete", "summary": "Delete Maintenance", "description": "Delete an existing maintenance. The maintenance will be deleted forever and cannot be recovered.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "maintenance_id" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "maintenance_id": { "type": "string", "description": "ID of the maintenance event" } }, "examples": [ { "maintenance_id": "52e5ebd1e32578623900000c", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/maintenance/history/create": { "post": { "operationId": "post-maintenance-history-create", "summary": "Create Historic Maintenance", "description": "Create a historic maintenance.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "all_infrastructure_affected", "infrastructure_affected", "maintenance_name", "maintenance_details_schedule", "maintenance_details_start", "maintenance_details_end", "maintenance_start_date", "maintenance_start_time", "maintenance_end_date", "maintenance_end_time" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page" }, "all_infrastructure_affected": { "type": "string", "description": "Apply to all components and containers. Set to `1` to affect all infrastructure, `0` to use specific infrastructure_affected list (default: `0`)." }, "infrastructure_affected": { "type": "array", "items": { "type": "string", "description": "Array of component-container ID pairs in the format `component_id-container_id`" } }, "maintenance_name": { "type": "string", "description": "Descriptive title for the maintenance event" }, "maintenance_details_schedule": { "type": "string", "description": "Message describing the scheduling of this maintenance" }, "maintenance_details_start": { "type": "string", "description": "Message describing the start of this maintenance" }, "maintenance_details_end": { "type": "string", "description": "Message describing the end of this maintenance" }, "maintenance_start_date": { "type": "string", "description": "Maintenance start date in MM/dd/yyyy format" }, "maintenance_start_time": { "type": "string", "description": "Maintenance start time in HH:mm format (24-hour)" }, "maintenance_end_date": { "type": "string", "description": "Maintenance end date in MM/dd/yyyy format" }, "maintenance_end_time": { "type": "string", "description": "Maintenance end time in HH:mm format (24-hour)" } }, "examples": [ { "all_infrastructure_affected": "0", "infrastructure_affected": [ "53d746c0383cd493cf00001a-53d746c0383cd493cf00001b", "53d746c0383cd493cf00001a-53d746c8383cd493cf00001e" ], "maintenance_details_end": "Maintenance has been completed successfully. All database servers are operating normally with improved performance and capacity.", "maintenance_details_schedule": "We will be upgrading hardware for the main database server to improve performance and capacity. No service downtime is expected during this maintenance window.", "maintenance_details_start": "Scheduled maintenance has begun. We are performing hardware upgrades on the database server infrastructure.", "maintenance_end_date": "05/01/2015", "maintenance_end_time": "03:15", "maintenance_name": "Database Server Hardware Upgrade", "maintenance_start_date": "05/01/2015", "maintenance_start_time": "03:00", "statuspage_id": "52e5e0e0893548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": "52e5e0e3290548543700000b", "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "string" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": "52e5e0e3290548543700000b", "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Maintenance" ] } }, "/metric/update": { "post": { "operationId": "post-metric-update", "summary": "Update Metric Data", "description": "Update custom metric data with day, week, and month averages and values. Metrics must be created in the Dashboard before they can be updated via the API.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "metric_id", "day_avg", "day_start", "day_dates", "day_values", "week_avg", "week_start", "week_dates", "week_values", "month_avg", "month_start", "month_dates", "month_values" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page", "example": "52e5e0e0893548543700000b" }, "metric_id": { "type": "string", "description": "ID of the metric", "example": "52e5e0e0893548542400000b" }, "day_avg": { "type": "string", "description": "Average value for past 24 hours", "example": "22.58" }, "day_start": { "type": "string", "description": "UNIX timestamp for start of metric timeframe", "example": "1395981878000" }, "day_dates": { "type": "array", "items": { "type": "string" }, "description": "An array of timestamps for the past 24 hours", "example": ["2014-03-28T05:43:00+00:00", "2014-03-28T06:43:00+00:00", "2014-03-28T07:43:00+00:00", "2014-03-28T08:43:00+00:00", "2014-03-28T09:43:00+00:00", "2014-03-28T10:43:00+00:00", "2014-03-28T11:43:00+00:00", "2014-03-28T12:43:00+00:00", "2014-03-28T13:43:00+00:00", "2014-03-28T14:43:00+00:00", "2014-03-28T15:43:00+00:00", "2014-03-28T16:43:00+00:00", "2014-03-28T17:43:00+00:00", "2014-03-28T18:43:00+00:00", "2014-03-28T19:43:00+00:00", "2014-03-28T20:43:00+00:00", "2014-03-28T21:43:00+00:00", "2014-03-28T22:43:00+00:00", "2014-03-28T23:43:00+00:00", "2014-03-29T00:43:00+00:00", "2014-03-29T01:43:00+00:00", "2014-03-29T02:43:00+00:00", "2014-03-29T03:43:00+00:00"] }, "day_values": { "type": "array", "items": { "type": "string" }, "description": "An array of values matching the timestamps. Must contain exactly 24 values.", "example": ["20.70", "20.00", "19.20", "19.80", "19.90", "20.10", "21.40", "23.00", "27.40", "28.70", "27.50", "29.30", "28.50", "27.20", "28.60", "28.70", "25.90", "23.40", "22.40", "21.40", "19.80", "19.50", "20.00"] }, "week_avg": { "type": "string", "description": "Average value for past 7 days", "example": "20.07" }, "week_start": { "type": "string", "description": "UNIX timestamp for start of metric timeframe", "example": "1395463478000" }, "week_dates": { "type": "array", "items": { "type": "string" }, "description": "An array of timestamps for the past 7 days", "example": ["2014-03-22T04:43:00+00:00", "2014-03-23T04:43:00+00:00", "2014-03-24T04:43:00+00:00", "2014-03-25T04:43:00+00:00", "2014-03-26T04:43:00+00:00", "2014-03-27T04:43:00+00:00", "2014-03-28T04:43:00+00:00"] }, "week_values": { "type": "array", "items": { "type": "string" }, "description": "An array of values matching the timestamps. Must contain exactly 7 values.", "example": ["23.10", "22.10", "22.20", "22.30", "22.10", "18.70", "17.00"] }, "month_avg": { "type": "string", "description": "Average value for past 30 days", "example": "10.63" }, "month_start": { "type": "string", "description": "UNIX timestamp for start of metric timeframe", "example": "1393476280000" }, "month_dates": { "type": "array", "items": { "type": "string" }, "description": "An array of timestamps for the past 30 days", "example": ["2014-02-28T04:43:00+00:00", "2014-03-01T04:43:00+00:00", "2014-03-02T04:43:00+00:00", "2014-03-03T04:43:00+00:00", "2014-03-04T04:43:00+00:00", "2014-03-05T04:43:00+00:00", "2014-03-06T04:43:00+00:00", "2014-03-07T04:43:00+00:00", "2014-03-08T04:43:00+00:00", "2014-03-09T04:43:00+00:00", "2014-03-10T04:43:00+00:00", "2014-03-11T04:43:00+00:00", "2014-03-12T04:43:00+00:00", "2014-03-13T04:43:00+00:00", "2014-03-14T04:43:00+00:00", "2014-03-15T04:43:00+00:00", "2014-03-16T04:43:00+00:00", "2014-03-17T04:43:00+00:00", "2014-03-18T04:43:00+00:00", "2014-03-19T04:43:00+00:00", "2014-03-20T04:43:00+00:00", "2014-03-21T04:43:00+00:00", "2014-03-22T04:43:00+00:00", "2014-03-23T04:43:00+00:00", "2014-03-24T04:43:00+00:00", "2014-03-25T04:43:00+00:00", "2014-03-26T04:43:00+00:00", "2014-03-27T04:43:00+00:00", "2014-03-28T04:43:00+00:00"] }, "month_values": { "type": "array", "items": { "type": "string" }, "description": "An array of values matching the timestamps. Must contain exactly 30 values.", "example": ["0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "18.50", "18.60", "18.40", "16.60", "16.80", "17.90", "19.90", "21.30", "22.80", "20.00", "17.30", "19.10", "21.50", "22.40", "22.50", "22.00", "21.80"] } }, "examples": [ { "day_avg": "22.58", "day_dates": [ "2014-03-28T05:43:00+00:00", "2014-03-28T06:43:00+00:00", "2014-03-28T07:43:00+00:00", "2014-03-28T08:43:00+00:00", "2014-03-28T09:43:00+00:00", "2014-03-28T10:43:00+00:00", "2014-03-28T11:43:00+00:00", "2014-03-28T12:43:00+00:00", "2014-03-28T13:43:00+00:00", "2014-03-28T14:43:00+00:00", "2014-03-28T15:43:00+00:00", "2014-03-28T16:43:00+00:00", "2014-03-28T17:43:00+00:00", "2014-03-28T18:43:00+00:00", "2014-03-28T19:43:00+00:00", "2014-03-28T20:43:00+00:00", "2014-03-28T21:43:00+00:00", "2014-03-28T22:43:00+00:00", "2014-03-28T23:43:00+00:00", "2014-03-29T00:43:00+00:00", "2014-03-29T01:43:00+00:00", "2014-03-29T02:43:00+00:00", "2014-03-29T03:43:00+00:00" ], "day_start": "1395981878000", "day_values": [ "20.70", "20.00", "19.20", "19.80", "19.90", "20.10", "21.40", "23.00", "27.40", "28.70", "27.50", "29.30", "28.50", "27.20", "28.60", "28.70", "25.90", "23.40", "22.40", "21.40", "19.80", "19.50", "20.00" ], "metric_id": "52e5e0e0893548542400000b", "month_avg": "10.63", "month_dates": [ "2014-02-28T04:43:00+00:00", "2014-03-01T04:43:00+00:00", "2014-03-02T04:43:00+00:00", "2014-03-03T04:43:00+00:00", "2014-03-04T04:43:00+00:00", "2014-03-05T04:43:00+00:00", "2014-03-06T04:43:00+00:00", "2014-03-07T04:43:00+00:00", "2014-03-08T04:43:00+00:00", "2014-03-09T04:43:00+00:00", "2014-03-10T04:43:00+00:00", "2014-03-11T04:43:00+00:00", "2014-03-12T04:43:00+00:00", "2014-03-13T04:43:00+00:00", "2014-03-14T04:43:00+00:00", "2014-03-15T04:43:00+00:00", "2014-03-16T04:43:00+00:00", "2014-03-17T04:43:00+00:00", "2014-03-18T04:43:00+00:00", "2014-03-19T04:43:00+00:00", "2014-03-20T04:43:00+00:00", "2014-03-21T04:43:00+00:00", "2014-03-22T04:43:00+00:00", "2014-03-23T04:43:00+00:00", "2014-03-24T04:43:00+00:00", "2014-03-25T04:43:00+00:00", "2014-03-26T04:43:00+00:00", "2014-03-27T04:43:00+00:00", "2014-03-28T04:43:00+00:00" ], "month_start": "1393476280000", "month_values": [ "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "0.00", "18.50", "18.60", "18.40", "16.60", "16.80", "17.90", "19.90", "21.30", "22.80", "20.00", "17.30", "19.10", "21.50", "22.40", "22.50", "22.00", "21.80" ], "statuspage_id": "52e5e0e0893548543700000b", "week_avg": "20.07", "week_dates": [ "2014-03-22T04:43:00+00:00", "2014-03-23T04:43:00+00:00", "2014-03-24T04:43:00+00:00", "2014-03-25T04:43:00+00:00", "2014-03-26T04:43:00+00:00", "2014-03-27T04:43:00+00:00", "2014-03-28T04:43:00+00:00" ], "week_start": "1395463478000", "week_values": [ "23.10", "22.10", "22.20", "22.30", "22.10", "18.70", "17.00" ] } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "Updated metric successfully" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "Updated metric successfully" } } ] } } } } }, "tags": [ "Metrics" ] } }, "/status/summary/{statuspage_id}": { "get": { "operationId": "get-status-summary-statuspage-id", "summary": "Status Summary", "description": "Retrieve a summary of the current status of all components and containers.\n\nThis method returns the same data structure as the public status API endpoint that you can provide to your API consumers. The Public Status API endpoint for your status page is available in the API tab of your Dashboard.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "incidents": [ { "_id": "59b709b105ae230bc72ec241", "components_affected": [ { "_id": "5334ebfae64cf90000000008", "name": "Database" } ], "containers_affected": [ { "_id": "5332766bf678630000000016", "name": "Primary Data Center" } ], "datetime_open": "2015-06-28T17:14:44.798Z", "messages": [ { "datetime": "2015-06-28T17:14:44.798Z", "details": "We are investigating database errors affecting our primary data center. Some users may experience intermittent service disruptions.", "state": 100, "status": 500 }, { "datetime": "2015-06-28T17:16:44.798Z", "details": "The root cause has been identified and a temporary fix has been applied. We are monitoring the situation closely to ensure stability.", "state": 200, "status": 300 } ], "name": "Database Connection Issues" } ], "maintenance": { "active": [], "upcoming": [ { "_id": "5a597a34095336047fd1f874", "components_affected": [ { "_id": "5332766bf678630000000017", "name": "Website" } ], "containers_affected": [ { "_id": "5332766bf678630000000016", "name": "Primary Data Center" } ], "datetime_open": "2015-04-02T03:17:08.971Z", "datetime_planned_end": "2015-09-26T23:00:00.000Z", "datetime_planned_start": "2015-09-26T22:00:00.000Z", "messages": [ { "datetime": "2015-04-02T03:17:08.971Z", "details": "Scheduled maintenance has been planned to increase memory capacity for web servers. This upgrade will improve performance and reliability.", "state": 100, "status": 200 } ], "name": "Web Server Hardware Upgrade" } ] }, "status": [ { "containers": [ { "id": "5334ebefe64cf90000000007", "name": "DC 3", "status": "Partial Service Disruption", "status_code": 400, "updated": "2015-06-28T17:16:44.798Z" }, { "id": "5332766bf678630000000016", "name": "Primary Data Center", "status": "Security Event", "status_code": 600, "updated": "2015-06-28T17:16:44.798Z" } ], "id": "5334ebfae64cf90000000008", "name": "Database", "status": "Security Event", "status_code": 600, "updated": "2015-06-28T17:16:44.798Z" }, { "containers": [ { "id": "5332766bf678630000000016", "name": "Primary Data Center", "status": "Operational", "status_code": 100, "updated": "2015-06-28T17:16:44.798Z" } ], "id": "5332766bf678630000000017", "name": "Website", "status": "Operational", "status_code": 100, "updated": "2015-06-28T17:16:44.798Z" } ], "status_overall": { "status": "Security Event", "status_code": 600, "updated": "2015-06-28T17:16:44.798Z" } }, "status": { "error": "no", "message": "Get public api status successfully" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "incidents": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "components_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "containers_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "datetime_open": { "type": "string" }, "messages": { "type": "array", "items": { "properties": { "datetime": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" } }, "required": [ "details", "state", "status", "datetime" ], "type": "object" } }, "name": { "type": "string" } }, "type": "object" } }, "maintenance": { "type": "object", "properties": { "active": { "type": "array", "items": {} }, "upcoming": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "components_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "containers_affected": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "datetime_open": { "type": "string" }, "datetime_planned_end": { "type": "string" }, "datetime_planned_start": { "type": "string" }, "messages": { "type": "array", "items": { "properties": { "datetime": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "number" }, "status": { "type": "number" } }, "type": "object" } }, "name": { "type": "string" } }, "type": "object" } } } }, "status": { "type": "array", "items": { "properties": { "containers": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "status_code": { "type": "number" }, "updated": { "type": "string" } }, "required": [ "id", "name", "updated", "status", "status_code" ], "type": "object" } }, "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "status_code": { "type": "number" }, "updated": { "type": "string" } }, "required": [ "id", "name", "updated", "status", "status_code", "containers" ], "type": "object" } }, "status_overall": { "type": "object", "properties": { "status": { "type": "string" }, "status_code": { "type": "number" }, "updated": { "type": "string" } } } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "incidents": [ { "_id": "59b709b105ae230bc72ec241", "components_affected": [ { "_id": "5334ebfae64cf90000000008", "name": "Database" } ], "containers_affected": [ { "_id": "5332766bf678630000000016", "name": "Primary Data Center" } ], "datetime_open": "2015-06-28T17:14:44.798Z", "messages": [ { "datetime": "2015-06-28T17:14:44.798Z", "details": "We are investigating database errors affecting our primary data center. Some users may experience intermittent service disruptions.", "state": 100, "status": 500 }, { "datetime": "2015-06-28T17:16:44.798Z", "details": "The root cause has been identified and a temporary fix has been applied. We are monitoring the situation closely to ensure stability.", "state": 200, "status": 300 } ], "name": "Database Connection Issues" } ], "maintenance": { "active": [], "upcoming": [ { "_id": "5a597a34095336047fd1f874", "components_affected": [ { "_id": "5332766bf678630000000017", "name": "Website" } ], "containers_affected": [ { "_id": "5332766bf678630000000016", "name": "Primary Data Center" } ], "datetime_open": "2015-04-02T03:17:08.971Z", "datetime_planned_end": "2015-09-26T23:00:00.000Z", "datetime_planned_start": "2015-09-26T22:00:00.000Z", "messages": [ { "datetime": "2015-04-02T03:17:08.971Z", "details": "Scheduled maintenance has been planned to increase memory capacity for web servers. This upgrade will improve performance and reliability.", "state": 100, "status": 200 } ], "name": "Web Server Hardware Upgrade" } ] }, "status": [ { "containers": [ { "id": "5334ebefe64cf90000000007", "name": "DC 3", "status": "Partial Service Disruption", "status_code": 400, "updated": "2015-06-28T17:16:44.798Z" }, { "id": "5332766bf678630000000016", "name": "Primary Data Center", "status": "Security Event", "status_code": 600, "updated": "2015-06-28T17:16:44.798Z" } ], "id": "5334ebfae64cf90000000008", "name": "Database", "status": "Security Event", "status_code": 600, "updated": "2015-06-28T17:16:44.798Z" }, { "containers": [ { "id": "5332766bf678630000000016", "name": "Primary Data Center", "status": "Operational", "status_code": 100, "updated": "2015-06-28T17:16:44.798Z" } ], "id": "5332766bf678630000000017", "name": "Website", "status": "Operational", "status_code": 100, "updated": "2015-06-28T17:16:44.798Z" } ], "status_overall": { "status": "Security Event", "status_code": 600, "updated": "2015-06-28T17:16:44.798Z" } }, "status": { "error": "no", "message": "Get public api status successfully" } } ] } } } } }, "tags": [ "Status" ] } }, "/subscriber/list/{statuspage_id}": { "get": { "operationId": "get-subscriber-list-statuspage-id", "summary": "List Subscribers", "description": "Retrieve all subscribers for a status page, organized by notification method.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [ "Subscribers" ] } }, "/subscriber/add": { "post": { "operationId": "post-subscriber-add", "summary": "Add Subscriber", "description": "Add a new subscriber to receive incident and maintenance notifications.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["statuspage_id", "address", "method"], "properties": { "statuspage_id": { "description": "ID of the status page", "example": "52e5e0e0873548543700000b", "type": "string" }, "method": { "description": "Communication method of subscriber. Valid methods are **email**, **sms**, or **webhook**", "example": "email", "type": "string" }, "address": { "description": "Subscriber address (SMS numbers must include country code, e.g., +1)", "example": "alerts@acme-corp.com", "type": "string" }, "silent": { "description": "Suppress welcome message: 1 = skip, 0 = send", "example": "1", "type": "string" }, "granular": { "description": "Choose which components and data centers to receive notifications for. Comma-separated list of component_container combinations.", "example": "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008,54d44a36fc9259df10000005_54d3162f750e87b398000015", "type": "string" } }, "examples": [ { "address": "alerts@acme-corp.com", "granular": "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008,54d44a36fc9259df10000005_54d3162f750e87b398000015", "method": "email", "silent": "1", "statuspage_id": "52e5e0e0873548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" }, "subscriber_id": "5511b3cbb066c9d14e000005" } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } }, "subscriber_id": { "type": "string" } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" }, "subscriber_id": "5511b3cbb066c9d14e000005" } ] } } } } }, "tags": [ "Subscribers" ] } }, "/subscriber/update": { "patch": { "operationId": "patch-subscriber-update", "summary": "Update Subscriber", "description": "Update an existing subscriber's address or granular notification preferences.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["statuspage_id", "subscriber_id"], "properties": { "statuspage_id": { "description": "ID of the status page", "example": "52e5e0e0873548543700000b", "type": "string" }, "subscriber_id": { "description": "ID of the subscriber", "example": "54bd87a0e01eb0079d000005", "type": "string" }, "address": { "description": "Subscriber address (SMS numbers must include country code, e.g., +1)", "example": "alerts@acme-corp.com", "type": "string" }, "granular": { "description": "Choose which components and data centers to receive notifications for. Comma-separated list of component_container combinations.", "example": "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008,54d44a36fc9259df10000005_54d3162f750e87b398000015", "type": "string" } }, "examples": [ { "address": "alerts@acme-corp.com", "granular": "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008,54d44a36fc9259df10000005_54d3162f750e87b398000015", "statuspage_id": "52e5e0e0873548543700000b", "subscriber_id": "5511b3cbb066c9d14e000005" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "__v": 0, "_id": "54bd87a0e01eb0079d000005", "active": true, "address": "alerts@acme-corp.com", "granular": [ "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008", "54d44a36fc9259df10000005_54d3162f750e87b398000015" ], "join_date": "2015-09-19T22:39:28.476Z", "method": "email", "statuspage": "52e5e0e0873548543700000b", "subscriber_id": "5511b3cbb066c9d14e000005" }, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "v": { "type": "number" }, "id": { "type": "string" }, "active": { "type": "boolean" }, "address": { "type": "string" }, "granular": { "type": "array", "items": { "type": "string" } }, "join_date": { "type": "string" }, "method": { "type": "string" }, "statuspage": { "type": "string" } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "__v": 0, "_id": "5511b3cbb066c9d14e000005", "active": true, "address": "alerts@acme-corp.com", "granular": [ "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008", "54d44a36fc9259df10000005_54d3162f750e87b398000015" ], "join_date": "2015-09-19T22:39:28.476Z", "method": "email", "statuspage": "52e5e0e0873548543700000b", "subscriber_id": "5511b3cbb066c9d14e000005" }, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Subscribers" ] } }, "/subscriber/remove/{statuspage_id}/{subscriber_id}": { "delete": { "operationId": "delete-subscriber-remove-statuspage-id-subscriber-id", "summary": "Delete Subscriber", "description": "Delete a subscriber. All data for subscriber will be permanently removed and cannot be recovered.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" }, { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "subscriber_id", "in": "path", "description": "ID of the subscriber", "required": true, "schema": { "type": "string" }, "example": "5511b3cbb066c9d14e000005" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "Successfully deleted subscriber" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "Successfully deleted subscriber" } } ] } } } } }, "tags": [ "Subscribers" ] } }, "/admin/ip_access_control/list/{statuspage_id}": { "get": { "operationId": "get-admin-ip-access-control-list-statuspage-id", "summary": "IP Access Control List", "description": "List the allowed IP addresses (IPv4 and IPv6) configured for IP access control.", "parameters": [ { "name": "statuspage_id", "in": "path", "description": "ID of the status page", "required": true, "schema": { "type": "string" }, "example": "52e5e0e0893548543700000b" }, { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": { "ipv4": "192.168.1.0/24,192.168.5.1/32", "ipv6": "2001:db8:8086:6502::/64,2001:db8:1234::/48" }, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "ipv_4": { "type": "string" }, "ipv_6": { "type": "string" } } }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": { "ipv4": "192.168.1.0/24,192.168.5.1/32", "ipv6": "2001:db8:8086:6502::/64,2001:db8:1234::/48" }, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Admin" ] } }, "/admin/ip_access_control/update/ipv4": { "post": { "operationId": "post-admin-ip-access-control-update-ipv-4", "summary": "IP Access Control - Update IPv4 Addresses", "description": "Update the list of allowed IPv4 addresses to access the status page.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "allow_ips" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page", "example": "52e5e0e0873548543700000b" }, "allow_ips": { "type": "string", "description": "IP addresses in CIDR notation separated by commas", "example": "192.168.1.0/24,192.168.5.1/32" } }, "examples": [ { "allow_ips": "192.168.1.0/24,192.168.5.1/32", "statuspage_id": "52e5e0e0873548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Admin" ] } }, "/admin/ip_access_control/update/ipv6": { "post": { "operationId": "post-admin-ip-access-control-update-ipv-6", "summary": "IP Access Control - Update IPv6 Addresses", "description": "Update the list of allowed IPv6 addresses to access the status page.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "allow_ips" ], "properties": { "allow_ips": { "type": "string", "description": "IP addresses in CIDR notation separated by commas", "example": "2001:db8:8086:6502::/64,2001:db8:1234::/48", "required": true }, "statuspage_id": { "type": "string", "description": "ID of the status page", "example": "52e5e0e0873548543700000b", "required": true } }, "examples": [ { "allow_ips": "2001:db8:8086:6502::/64,2001:db8:1234::/48", "statuspage_id": "52e5e0e0873548543700000b" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Admin" ] } }, "/admin/ssl_cert/update": { "post": { "operationId": "post-admin-ssl-cert-update", "summary": "SSL Certificate - Update", "description": "Update the SSL certificate, certificate chain, and private key for a status page's custom domain. \n\n**Note:** This endpoint is only for updating or renewing an existing certificate. The first certificate must be configured through the dashboard.", "parameters": [ { "name": "x-api-id", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-ID" }, { "name": "x-api-key", "in": "header", "description": "", "required": true, "schema": { "type": "string" }, "example": "YOUR-API-KEY" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statuspage_id", "ssl_cert", "ssl_cert_chain", "ssl_cert_key" ], "properties": { "statuspage_id": { "type": "string", "description": "ID of the status page", "example": "52e5e0e0873548543700000b", "required": true }, "ssl_cert": { "type": "string", "description": "SSL certificate (PEM format)", "example": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "required": true }, "ssl_cert_chain": { "type": "string", "description": "SSL certificate chain (PEM format)", "example": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "required": true }, "ssl_cert_key": { "type": "string", "description": "SSL certificate private key (PEM format)", "example": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----", "required": true } }, "examples": [ { "statuspage_id": "52e5e0e0873548543700000b", "ssl_cert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "ssl_cert_chain": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", "ssl_cert_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----" } ] } } } }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "examples": { "response": { "value": { "result": true, "status": { "error": "no", "message": "OK" } } } }, "schema": { "type": "object", "properties": { "result": { "type": "boolean" }, "status": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } }, "examples": [ { "result": true, "status": { "error": "no", "message": "OK" } } ] } } } } }, "tags": [ "Admin" ] } } }, "tags": [ { "description": "**Components** represent core system functions (e.g., website, API).\n\n**Containers** can function as sub-components or as logical groups used to organize components by location or service type.", "name": "Components" }, { "description": "Manage and track incidents.", "name": "Incidents" }, { "description": "Manage planned maintenance activities.", "name": "Maintenance" }, { "description": "Manage your custom metrics. Create new custom metrics in the [Dashboard](https://app.status.io/dashboard).", "name": "Metrics" }, { "description": "Retrieve current status information for your status page.", "name": "Status" }, { "description": "Manage your status page subscribers.", "name": "Subscribers" }, { "description": "Manage admin settings for your status page.", "name": "Admin" } ] }