{ "openapi": "3.0.3", "info": { "description": "This is the API reference for incident.io.\n\nIt documents available API endpoints, provides examples of how to use it, and\ninstructions around things like authentication and error handling.\n\nThe API is hosted at:\n\n- https://api.incident.io/\n\nAnd you will need to create an API key via your [incident.io\ndashboard](https://app.incident.io/settings/api-keys) to make requests.\n\n# Making requests\n\nHere are the key concepts required to make requests to the incident.io API.\n\n## Authentication\n\nFor all requests made to the incident.io API, you'll need an API key.\n\nTo create an API key, head to the incident dashboard and visit [API\nkeys](https://app.incident.io/settings/api-keys). When you create the key, you'll be able to choose what actions it\ncan take for your account: choose carefully, as those roles can only be set\nwhen you first create the key. We'll only show you the token once, so make sure\nyou store it somewhere safe.\n\nAPI keys are global to your incident.io account, and can be managed by anyone\nwho has the right permissions. We display the user that created the API key,\nand the API key will remain valid if that user becomes deactivated.\n\nOnce you have the key, you should make requests to the API that set the\n`Authorization` request header using a \"Bearer\" authentication scheme:\n\n```\nAuthorization: Bearer \n```\n\n## Rate Limits\n\nThe incident.io API enforces rate limits to ensure consistent performance for all users.\n\nThe default rate limit is 1200 requests/minute per API key. This limit applies to most endpoints across the API.\n\nLimits are token buckets that refill continuously rather than resetting on a fixed window boundary. The default\nbucket holds 1200 requests and refills at 20 per second, so you can burst up to the full bucket and then sustain\n20 requests/second indefinitely. There is no boundary at which your quota resets to full in one step.\n\nSome endpoints have lower rate limits, particularly those that interact with external third-party systems that impose\ntheir own limitations. These specific limits vary by endpoint.\n\n### Rate limit headers\n\nResponses to requests authenticated with an API key carry your current allowance, so you can pace yourself rather\nthan waiting to be throttled:\n\n```\nX-RateLimit-Limit: 60, 1200;window=60, 60;window=60\nX-RateLimit-Remaining: 59\nX-RateLimit-Used: 1\nX-RateLimit-Reset: 1785173199\n```\n\n| Header | Meaning |\n| --- | --- |\n| `X-RateLimit-Limit` | The quota that binds this request, followed by every limit that applied and the window it applies over |\n| `X-RateLimit-Remaining` | Requests you can make right now against the binding limit |\n| `X-RateLimit-Used` | Requests you have spent against it |\n| `X-RateLimit-Reset` | Unix timestamp (seconds) at which that limit will be back to full |\n\nMore than one limit can apply to a request: your API key's overall limit, and for some endpoints a lower limit of\ntheir own. `X-RateLimit-Limit` lists all of them, each with its window, so `1200;window=60` means 1200 requests per\nminute. Because our limits refill continuously rather than resetting on a boundary, that window is what tells you\nthe rate you can sustain: 1200 per 60 seconds is 20 requests/second indefinitely.\n\n`Remaining`, `Used` and `Reset` describe whichever limit has the least allowance left, since that is the one you\nwill hit first.\n\n`X-RateLimit-Remaining` may lag by a small number of requests under high concurrency, and can move by more than the\nrequests you made, because limits scoped to your whole organisation are shared with your other API keys.\n\nHeaders are omitted rather than guessed if we cannot determine your allowance for a request.\n\n### Exceeding a rate limit\n\nWhen you exceed a rate limit the API responds with `429 Too Many Requests` and a `Retry-After` header giving the\nnumber of seconds to wait:\n\n```\nX-RateLimit-Limit: 1200, 1200;window=60\nX-RateLimit-Remaining: 0\nX-RateLimit-Used: 1200\nX-RateLimit-Reset: 1785173199\nRetry-After: 1\n```\n\nPrefer `Retry-After` over `X-RateLimit-Reset` when deciding how long to back off. `Retry-After` is when a single\nrequest will succeed; `X-RateLimit-Reset` is the later point at which your whole allowance has returned. It is a\nduration rather than a timestamp, so it does not depend on your clock agreeing with ours.\n\nThe 429 also carries a JSON body with the same information:\n\n```json\n{\n \"type\": \"too_many_requests\",\n \"status\": 429,\n \"request_id\": \"b839a403-7704-41c1-bf6a-39a2d68caefa\",\n \"rate_limit\": {\n \"name\": \"api_key_name\",\n \"limit\": 1200,\n \"remaining\": 0,\n \"retry_after\": \"2025-04-17T11:17:18Z\"\n },\n \"errors\": [\n {\n \"code\": \"too_many_requests\",\n \"message\": \"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"\n }\n ]\n}\n```\n\nThe response includes:\n* The name of the API key (`name`)\n* The bucket limit (`limit`)\n* The number of requests remaining (`remaining`)\n* When you can retry requests (`retry_after`), as an RFC3339 timestamp\n\n## Errors\n\nWe use standard HTTP response codes to indicate the status or failure of API\nrequests.\n\nThe API response body will be JSON, and contain more detailed information on the\nnature of the error.\n\nAn example error when a request is made without an API key:\n\n```json\n{\n \"type\": \"authentication_error\",\n \"status\": 401,\n \"request_id\": \"8e3cc412-b49d-4957-9073-2c19d2c61804\",\n \"errors\": [\n {\n \"code\": \"missing_authorization_material\",\n \"message\": \"No authorization material provided in request\"\n }\n ]\n}\n```\n\nNote that the error:\n\n- Contains the HTTP status (`401`)\n- References the type of error (`authentication_error`)\n- Includes a `request_id` that can be provided to incident.io support to help\n\tdebug questions with your API request\n- Provides a list of individual errors, which go into detail about why the error\n\toccurred\n\nThe most common error will be a 422 Validation Error, which is returned when the\nrequest was rejected due to failing validations.\n\nThese errors look like this:\n\n```json\n{\n \"type\": \"validation_error\",\n \"status\": 422,\n \"request_id\": \"631766c4-4afd-4803-997c-cd700928fa4b\",\n \"errors\": [\n {\n \"code\": \"is_required\",\n \"message\": \"A severity is required to open an incident\",\n \"source\": {\n \"field\": \"severity_id\"\n }\n }\n ]\n}\n```\n\nThis error is caused by not providing a severity identifier, which should be at\nthe `severity_id` field of the request payload. Errors like these can be mapped to\nforms, should you be integrating with the API from a user-interface.\n\n## Compatibility\n\nWe won't make breaking changes to existing API services or endpoints, but will\nexpect integrators to upgrade themselves to the latest API endpoints within 3\nmonths of us deprecating the old service.\n\nWe will make changes that are considered backwards compatible, which include:\n\n- Adding new API endpoints and services\n- Adding new properties to responses from existing API endpoints\n- Reordering properties returned from existing API endpoints\n- Adding optional request parameters to existing API endpoints\n- Altering the format or length of IDs\n- Adding new values to enums\n\nIt is important that clients are robust to these changes, to ensure reliable\nintegrations.\n\nAs an example, if you are generating a client using an openapi-generator, ensure\nthe generated client is configured to support unknown enum values, often\nconfigured via the `enumUnknownDefaultCase` parameter.\n\nWhen breaking changes are unavoidable, we'll create a new service version on a\nseparate path, and run them in parallel.\n\nFor example:\n\n- https://api.incident.io/v1/incidents\n- https://api.incident.io/v2/incidents\n\nFor any questions, email support@incident.io.\n", "title": "incident.io", "version": "1.0.0" }, "servers": [ { "url": "https://api.incident.io" } ], "security": [ { "BearerAuth": [] } ], "tags": [ { "description": "Manage and publish to status pages.\n\nBefore using these endpoints, you must create a status page in the incident.io dashboard (find Status Pages in the left navigation bar). You can then use the ListStatusPages endpoint to find your status page IDs, and the ShowStatusPageStructure endpoint to find component IDs and group IDs for your status page.\n\nFor read-only access (listing status pages, viewing structure, incidents, maintenance windows, and component availability), any valid API key will work. For write requests (creating incidents, maintenance windows, and publishing updates), you will need an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.\n", "name": "Status Page Maintenances V2" } ], "paths": { "/v2/status_page_maintenances": { "get": { "description": "List status page maintenances.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2_ListStatusPageMaintenances", "parameters": [ { "allowEmptyValue": true, "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "status_page_id", "required": true, "schema": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "query", "name": "component_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "in": "query", "name": "group_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "in": "query", "name": "sub_page_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "start_at", "schema": { "description": "Filter status page maintenance windows to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "end_at", "schema": { "description": "Filter status page maintenance windows to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_maintenances": [ { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListStatusPageMaintenancesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Status Page Maintenances V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2" }, "post": { "description": "Schedule a Status Page maintenance window.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_CreateStatusPageMaintenance", "requestBody": { "content": { "application/json": { "example": { "affected_component_ids": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "automate_maintenance_status": true, "end_at": "2025-01-28T12:00:00Z", "idempotency_key": "maintenance-12345-abcde", "maintenance_status": "maintenance_scheduled", "message": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "name": "Routine infrastructure upgrade", "notify_subscribers": true, "start_at": "2025-01-28T10:00:00Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenancePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenanceResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Status Page Maintenances V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } }, "/v2/status_page_maintenances/{status_page_maintenance_id}": { "delete": { "description": "Delete a Status Page maintenance window.\n\nThe maintenance window and its updates stop appearing on your public status page, links to it stop working, and a window that has not yet run publishes no further automated updates. This cannot be undone.\n\nSubscribers are not told the window has been deleted, so anyone already emailed about it will have updates for a maintenance window they can no longer find.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_DeleteStatusPageMaintenance", "parameters": [ { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_maintenance_id", "required": true, "schema": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Status Page Maintenances V2" ], "x-display-name": "Delete", "x-docs-display-name": "Delete", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] }, "get": { "description": "Show a status page maintenance window.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2_ShowStatusPageMaintenance", "parameters": [ { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_maintenance_id", "required": true, "schema": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesShowStatusPageMaintenanceResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Status Page Maintenances V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2" }, "put": { "description": "Update the name and scheduled window of a Status Page maintenance window.\n\nThe new start_at and end_at apply to every component this maintenance window affects.\n\nThis does not publish an update to your status page and does not notify subscribers. Automated updates only move a window forwards, so one that has already started or completed will not move back to an earlier status. To move a status backwards, or to tell subscribers the schedule has changed, post a maintenance update to POST /status_page_maintenance_updates.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_UpdateStatusPageMaintenance", "parameters": [ { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_maintenance_id", "required": true, "schema": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "end_at": "2025-01-28T12:00:00Z", "name": "Routine infrastructure upgrade", "start_at": "2025-01-28T10:00:00Z" }, "schema": { "$ref": "#/components/schemas/StatusPagesUpdateStatusPageMaintenancePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesUpdateStatusPageMaintenanceResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Status Page Maintenances V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } } }, "components": { "schemas": { "StatusPagesListStatusPageMaintenancesResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_maintenances": [ { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "status_page_maintenances": { "example": [ { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" }, "type": "array" } }, "required": [ "status_page_maintenances", "pagination_meta" ], "type": "object" }, "ErrorResponse": { "example": { "debug": { "message": "Something broke: and something else: and something else", "stacktrace": [ "thing.go:123" ] }, "errors": [ { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } } ], "rate_limit": { "limit": 100, "name": "client_ip", "remaining": 98, "retry_after": "2020-01-01T00:00:00Z" }, "request_id": "2T1p0e3j", "status": 408, "type": "invalid_request_error" }, "properties": { "debug": { "$ref": "#/components/schemas/ErrorDebug" }, "errors": { "description": "List of errors that caused this request to fail", "example": [ { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } } ], "items": { "$ref": "#/components/schemas/ErrorSingle" }, "type": "array" }, "rate_limit": { "$ref": "#/components/schemas/ErrorRateLimit" }, "request_id": { "description": "Unique identifier of the request", "example": "2T1p0e3j", "type": "string" }, "status": { "description": "HTTP status of the response", "example": 408, "format": "int64", "type": "integer" }, "type": { "description": "Machine-readable identifier for the general category of error", "enum": [ "invalid_request_error", "authentication_error", "resource_forbidden", "not_found", "not_acceptable", "method_not_allowed", "request_timeout", "conflict", "precondition_failed", "payload_too_large", "validation_error", "too_many_requests", "api_error", "rate_limit_reached", "client_timeout" ], "example": "invalid_request_error", "type": "string" } }, "required": [ "type", "status", "request_id", "errors" ], "type": "object" }, "StatusPagesCreateStatusPageMaintenancePayloadV2": { "example": { "affected_component_ids": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "automate_maintenance_status": true, "end_at": "2025-01-28T12:00:00Z", "idempotency_key": "maintenance-12345-abcde", "maintenance_status": "maintenance_scheduled", "message": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "name": "Routine infrastructure upgrade", "notify_subscribers": true, "start_at": "2025-01-28T10:00:00Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "affected_component_ids": { "description": "An array of IDs of component affected by the maintenance window", "example": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "automate_maintenance_status": { "description": "Whether to publish updates automatically, moving this maintenance window to in progress at start_at and to complete at end_at. Defaults to false, which means you publish those updates yourself. When notify_subscribers is true, the automated updates notify subscribers too. Publishing your own update that sets maintenance_status turns automation off.", "example": true, "type": "boolean" }, "end_at": { "description": "The time the maintenance window ends", "example": "2025-01-28T12:00:00Z", "format": "date-time", "type": "string" }, "idempotency_key": { "description": "A unique key to de-duplicate requests. If you send a request with an idempotency_key that was already used, the original response will be returned.", "example": "maintenance-12345-abcde", "type": "string" }, "maintenance_status": { "description": "Current status for this status page maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string" }, "message": { "description": "Markdown initial update on this status page maintenance window", "example": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "maxLength": 4096, "type": "string" }, "name": { "description": "A title for the maintenance window", "example": "Routine infrastructure upgrade", "maxLength": 200, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status page maintenance. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "start_at": { "description": "The time the maintenance window starts", "example": "2025-01-28T10:00:00Z", "format": "date-time", "type": "string" }, "status_page_id": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "status_page_id", "name", "maintenance_status", "idempotency_key", "affected_component_ids", "start_at", "end_at", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageMaintenanceResultV2": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_maintenance": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" } }, "type": "object" }, "StatusPagesShowStatusPageMaintenanceResultV2": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_maintenance": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" } }, "type": "object" }, "StatusPagesUpdateStatusPageMaintenancePayloadV2": { "example": { "end_at": "2025-01-28T12:00:00Z", "name": "Routine infrastructure upgrade", "start_at": "2025-01-28T10:00:00Z" }, "properties": { "end_at": { "description": "The time the maintenance window ends", "example": "2025-01-28T12:00:00Z", "format": "date-time", "type": "string" }, "name": { "description": "A title for the maintenance window", "example": "Routine infrastructure upgrade", "maxLength": 200, "type": "string" }, "start_at": { "description": "The time the maintenance window starts", "example": "2025-01-28T10:00:00Z", "format": "date-time", "type": "string" } }, "required": [ "name", "start_at", "end_at" ], "type": "object" }, "StatusPagesUpdateStatusPageMaintenanceResultV2": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_maintenance": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" } }, "type": "object" }, "PaginationMetaResultV2": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "StatusPageMaintenanceV2": { "properties": { "automate_maintenance_status": { "description": "Whether updates are published automatically, moving this maintenance window to in progress at its start time and to complete at its end time", "example": true, "type": "boolean" }, "component_maintenance_periods": { "description": "A list of time periods where components were under maintenance during this status page maintenance window", "example": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceComponentMaintenancePeriodV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "maintenance_status": { "description": "Current status for this maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "A title for the maintenance window", "example": "Routine infrastructure upgrade", "type": "string" }, "published_at": { "description": "When this status page maintenance window was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_id": { "description": "The ID of the corresponding status page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "updates": { "description": "A list of updates posted to this status page maintenance window", "example": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceUpdateV2" }, "type": "array" } }, "required": [ "id", "status_page_id", "name", "published_at", "maintenance_status", "updates", "component_maintenance_periods", "automate_maintenance_status" ], "type": "object" }, "ErrorDebug": { "example": { "message": "Something broke: and something else: and something else", "stacktrace": [ "thing.go:123" ] }, "properties": { "message": { "description": "Original internal error message", "example": "Something broke: and something else: and something else", "type": "string" }, "stacktrace": { "description": "Stacktrace of the error, if applicable", "example": [ "thing.go:123" ], "items": { "example": "thing.go:123", "type": "string" }, "type": "array" } }, "required": [ "message", "stacktrace" ], "type": "object" }, "ErrorSingle": { "example": { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } }, "properties": { "code": { "description": "Machine-readable identifier for this specific error", "example": "trial_expired", "type": "string" }, "message": { "description": "Human readable description of the error", "example": "Default incident call link must be a valid URL", "type": "string" }, "metadata": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Additional metadata about the error, keyed by a string identifier", "example": { "abc123": "abc123" }, "type": "object" }, "source": { "$ref": "#/components/schemas/ErrorSource" } }, "required": [ "code", "message" ], "type": "object" }, "ErrorRateLimit": { "example": { "limit": 100, "name": "client_ip", "remaining": 98, "retry_after": "2020-01-01T00:00:00Z" }, "properties": { "limit": { "description": "The maximum number of requests that the consumer is permitted to make per minute", "example": 100, "format": "int64", "type": "integer" }, "name": { "description": "Which rate limit was exceeded", "example": "client_ip", "type": "string" }, "remaining": { "description": "The number of requests remaining in the current rate limit window", "example": 98, "format": "int64", "type": "integer" }, "retry_after": { "description": "When the client can retry, as an RFC3339 timestamp in UTC. Prefer the Retry-After response header, which carries the same instant as a number of seconds", "example": "2020-01-01T00:00:00Z", "type": "string" } }, "required": [ "name", "limit", "remaining", "retry_after" ], "type": "object" }, "StatusPageMaintenanceComponentMaintenancePeriodV2": { "example": { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01GW7P4ES31Q6V1ZQH321T0GJN", "type": "string" }, "end_at": { "description": "When the component stopped being under maintenance. If this is null, the impact is ongoing.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "start_at": { "description": "When the component started being under maintenance", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "component_id", "start_at" ], "type": "object" }, "StatusPageMaintenanceUpdateV2": { "properties": { "component_statuses": { "description": "The updated statuses of affected components", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceAffectedComponentV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page maintenance update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "maintenance_status": { "description": "Current status for this maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string", "x-public-api-version": "v2" }, "message": { "description": "Markdown update on what's changed about this status page maintenance window", "example": "abc123", "type": "string" }, "published_at": { "description": "When this status page maintenance update was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_maintenance_id": { "description": "The ID of the corresponding status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "id", "status_page_maintenance_id", "published_at", "message", "maintenance_status", "component_statuses" ], "type": "object" }, "ErrorSource": { "example": { "field": "default_call_url", "pointer": "/settings/default_call_url" }, "properties": { "field": { "description": "Field name that is the source of the error", "example": "default_call_url", "type": "string" }, "pointer": { "description": "JSON pointer to the request field that is the source of the error", "example": "/settings/default_call_url", "type": "string" } }, "required": [ "field", "pointer" ], "type": "object" }, "StatusPageMaintenanceAffectedComponentV2": { "example": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" }, "component_status": { "description": "The status of the relevant component in a status page maintenance window", "enum": [ "operational", "under_maintenance" ], "example": "operational", "type": "string", "x-public-api-version": "v2" } }, "required": [ "component_id", "component_status" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key from your incident.io dashboard (Settings → API keys)" } } } }