{ "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 maintenance windows for temporarily overriding alert routing during planned maintenance.\n\nMaintenance windows allow you to suppress or redirect alerts during scheduled maintenance periods, preventing unnecessary escalations and noise.", "name": "MaintenanceWindows V1" } ], "paths": { "/v1/maintenance_windows": { "get": { "description": "List maintenance windows for your organisation.", "operationId": "MaintenanceWindows V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of maintenance windows to return per page", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of maintenance windows to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "The ID of the last maintenance window on the previous page", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "The ID of the last maintenance window on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter by window status: active (start_at <= now < end_at), upcoming (now < start_at), or past (end_at <= now)", "example": "active", "in": "query", "name": "status", "schema": { "description": "Filter by window status: active (start_at <= now < end_at), upcoming (now < start_at), or past (end_at <= now)", "enum": [ "active", "upcoming", "past" ], "example": "active", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "maintenance_windows": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsListResultV1" } } }, "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": [ "MaintenanceWindows V1" ], "x-docs-display-name": "List", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_windows.view` scope." }, "x-rbac-scopes": [ "maintenance_windows.view" ] }, "post": { "description": "Create a new maintenance window.", "operationId": "MaintenanceWindows V1_Create", "requestBody": { "content": { "application/json": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsCreateResultV1" } } }, "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": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_window.create` scope." }, "x-rbac-scopes": [ "maintenance_window.create" ] } }, "/v1/maintenance_windows/{id}": { "delete": { "description": "Archives a maintenance window. Set force to archive an active window.", "operationId": "MaintenanceWindows V1_Delete", "parameters": [ { "allowEmptyValue": true, "description": "Archives the window even if it is active. This ends the window immediately. Its resolve_on_end and reroute_on_end actions do not run, so the alerts it is holding stay as they are. To run those actions, use Update to set end_at, then delete the window once it has ended.", "example": true, "in": "query", "name": "force", "schema": { "default": false, "description": "Archives the window even if it is active. This ends the window immediately. Its resolve_on_end and reroute_on_end actions do not run, so the alerts it is holding stay as they are. To run those actions, use Update to set end_at, then delete the window once it has ended.", "example": true, "type": "boolean" } }, { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "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": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_window.destroy` scope." }, "x-rbac-scopes": [ "maintenance_window.destroy" ] }, "get": { "description": "Show a particular maintenance window.", "operationId": "MaintenanceWindows V1_Show", "parameters": [ { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsShowResultV1" } } }, "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": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_windows.view` scope." }, "x-rbac-scopes": [ "maintenance_windows.view" ] }, "put": { "description": "Update an existing maintenance window.", "operationId": "MaintenanceWindows V1_Update", "parameters": [ { "description": "Unique identifier of the maintenance window", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsUpdateResultV1" } } }, "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": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_window.update` scope." }, "x-rbac-scopes": [ "maintenance_window.update" ] } } }, "components": { "schemas": { "MaintenanceWindowsListResultV1": { "example": { "maintenance_windows": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "maintenance_windows": { "example": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "maintenance_windows", "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" }, "MaintenanceWindowsCreatePayloadV1": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "end_at": { "description": "When the maintenance window should end", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetPayloadV1" }, "type": "array" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelPayloadV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "owning_team_ids": { "description": "IDs of teams that own this maintenance window. Omit to leave ownership unchanged, or pass an empty list to clear it.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window should start", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "lead", "start_at", "end_at", "alert_condition_groups", "show_in_sidebar" ], "type": "object" }, "MaintenanceWindowsCreateResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "MaintenanceWindowsShowResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "MaintenanceWindowsUpdatePayloadV1": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "end_at": { "description": "When the maintenance window should end", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetPayloadV1" }, "type": "array" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelPayloadV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "owning_team_ids": { "description": "IDs of teams that own this maintenance window. Omit to leave ownership unchanged, or pass an empty list to clear it.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window should start", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "lead", "start_at", "end_at", "alert_condition_groups", "show_in_sidebar" ], "type": "object" }, "MaintenanceWindowsUpdateResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "MaintenanceWindowV1": { "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "archived_at": { "description": "When this maintenance window was archived, if it has been", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When this maintenance window was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "end_at": { "description": "When the maintenance window ends", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetV1" }, "type": "array" }, "id": { "description": "Unique identifier for this maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/ActorV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "owning_team_ids": { "description": "IDs of teams that own this maintenance window. Owning teams control who can manage the window, and restrict it to holding alerts belonging to those teams or their descendants in the team hierarchy.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window starts", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "updated_at": { "description": "When this maintenance window was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "lead", "start_at", "end_at", "alert_condition_groups", "resolve_on_end", "reroute_on_end", "show_in_sidebar", "created_at", "updated_at" ], "type": "object" }, "PaginationMetaResultV1": { "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" }, "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" }, "ConditionGroupPayloadV2": { "example": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] }, "properties": { "conditions": { "description": "All conditions in this list must be satisfied for the group to be satisfied", "example": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "items": { "$ref": "#/components/schemas/ConditionPayloadV2" }, "type": "array" } }, "required": [ "conditions" ], "type": "object" }, "MaintenanceWindowEscalationTargetPayloadV1": { "example": { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "users": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "type": "object" }, "UserReferencePayloadV2": { "example": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "properties": { "email": { "description": "The user's email address, matching the email on their Slack account", "example": "bob@example.com", "type": "string" }, "id": { "description": "The incident.io ID of a user", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "slack_user_id": { "description": "The ID of the user's Slack account.", "example": "USER123", "type": "string" } }, "type": "object" }, "MaintenanceWindowNotifyChannelPayloadV1": { "description": "A channel to receive notifications about this maintenance window", "example": { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" }, "properties": { "channel_id": { "description": "The external provider channel ID (e.g. Slack channel ID)", "example": "C0ACTHQMHS8", "type": "string" }, "channel_name": { "description": "Human readable name of the channel", "example": "general", "type": "string" }, "channel_type": { "description": "The type of channel (e.g. public, private)", "example": "public", "type": "string" } }, "required": [ "channel_id", "channel_type" ], "type": "object" }, "ConditionGroupV2": { "example": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] }, "properties": { "conditions": { "description": "All conditions in this list must be satisfied for the group to be satisfied", "example": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/ConditionV2" }, "type": "array" } }, "required": [ "conditions" ], "type": "object" }, "MaintenanceWindowEscalationTargetV1": { "example": { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "users": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "type": "object" }, "ActorV2": { "example": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertActorV2" }, "api_key": { "$ref": "#/components/schemas/APIKeyActorV2" }, "user": { "$ref": "#/components/schemas/UserV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowActorV2" } }, "type": "object" }, "MaintenanceWindowNotifyChannelV1": { "description": "A channel that will receive notifications about this maintenance window", "example": { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false }, "properties": { "channel_id": { "description": "The external provider channel ID (e.g. Slack channel ID)", "example": "C0ACTHQMHS8", "type": "string" }, "channel_name": { "description": "Human readable name of the channel", "example": "general", "type": "string" }, "channel_type": { "description": "The type of channel (e.g. public, private)", "example": "public", "type": "string" }, "is_private": { "description": "Whether the channel is private", "example": false, "type": "boolean" } }, "required": [ "channel_id", "channel_type" ], "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" }, "ConditionPayloadV2": { "example": { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" }, "properties": { "operation": { "description": "The name of the operation on the subject", "example": "one_of", "type": "string" }, "param_bindings": { "description": "List of parameter bindings", "example": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "type": "array" }, "subject": { "description": "The reference of the subject in the trigger scope", "example": "incident.severity", "type": "string" } }, "required": [ "subject", "operation", "param_bindings" ], "type": "object" }, "EngineParamBindingPayloadV2": { "example": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If set, this is the array value of the step parameter", "example": [ { "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "type": "array" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" } }, "type": "object" }, "ConditionV2": { "example": { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } }, "properties": { "operation": { "$ref": "#/components/schemas/ConditionOperationV2" }, "param_bindings": { "description": "Bindings for the operation parameters", "example": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "type": "array" }, "subject": { "$ref": "#/components/schemas/ConditionSubjectV2" } }, "required": [ "subject", "operation", "param_bindings" ], "type": "object" }, "EngineParamBindingV2": { "example": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If array_value is set, this helps render the values", "example": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "type": "array" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValueV2" } }, "type": "object" }, "AlertActorV2": { "example": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "properties": { "id": { "description": "The ID of this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "title": { "description": "The title of the alert, parsed from the alert payload according to the alert source configuration", "example": "*errors.withMessage: PG::Error failed to connect", "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "APIKeyActorV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "properties": { "id": { "description": "Unique identifier for this API key", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of the API key, for the user's reference", "example": "My test API key", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "UserV2": { "example": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "properties": { "email": { "description": "Email address of the user.", "example": "lisa@incident.io", "type": "string" }, "id": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the user", "example": "Lisa Karlin Curtis", "type": "string" }, "role": { "description": "DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.", "enum": [ "viewer", "responder", "administrator", "owner", "unset" ], "example": "owner", "type": "string" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "role", "id", "name" ], "type": "object" }, "WorkflowActorV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" }, "properties": { "id": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "EngineParamBindingValuePayloadV2": { "example": { "literal": "SEV123", "reference": "incident.severity" }, "properties": { "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "If set, this is the reference into the trigger scope that is the value of this parameter", "example": "incident.severity", "type": "string" } }, "type": "object" }, "ConditionOperationV2": { "example": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "properties": { "label": { "description": "Human readable label to be displayed for user to select", "example": "Lawrence Jones", "type": "string" }, "value": { "description": "Unique identifier for this option", "example": "01FCQSP07Z74QMMYPDDGQB9FTG", "type": "string" } }, "required": [ "label", "value" ], "type": "object" }, "ConditionSubjectV2": { "example": { "label": "Incident Severity", "reference": "incident.severity" }, "properties": { "label": { "description": "Human readable identifier for the subject", "example": "Incident Severity", "type": "string" }, "reference": { "description": "Reference into the scope for the value of the subject", "example": "incident.severity", "type": "string" } }, "required": [ "label", "reference" ], "type": "object" }, "EngineParamBindingValueV2": { "example": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "properties": { "label": { "description": "Human readable label to be displayed for user to select", "example": "Lawrence Jones", "type": "string" }, "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "If set, this is the reference into the trigger scope that is the value of this parameter", "example": "incident.severity", "type": "string" } }, "required": [ "label" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key from your incident.io dashboard (Settings → API keys)" } } } }