{ "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": "Read your alerts in incident.io.\n\nAlerts are events ingested from third parties by alert sources. They can trigger incidents and escalations, as configured in alert routes.\nTo view your alerts, you can list all alerts, or show a single alert. \nIf you'd like to view only alerts that are currently firing, you can filter by status. \nTo view the alert that was created for an event in your external system, filter by deduplication key. \n\nIf you'd like to view alerts connected to a particular incident, you can list incident alerts. You can filter by incident_id to find all alerts attached to a particular incident, or by alert_id to find the incident that a particular alert triggered. \n", "name": "Alerts V2" } ], "paths": { "/v2/alerts": { "get": { "description": "List all alerts for your account.\n```bash\n\n```\nThis endpoint supports a number of filters, which can help find alerts matching certain\ncriteria. These filters work similarly to the filters on the incidents endpoint, where \na field is specified alongside a comparison operator in the query string.\n\nNote that:\n- Filters may be used together, and the result will be alerts that match all filters.\n- All query parameters must be URI encoded.\n\n### By deduplication_key\n\nFind all alerts with deduplication_key ABC:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'deduplication_key[is]=ABC'\n```\n\n### By status\n\nFind all alerts in a firing state:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'status[one_of]=firing'\n```\n\n### By alert_source\n\nFind all alerts from a specific alert source (by alert source ID):\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'alert_source[one_of]=01GBSQF3FHF7FWZQNWGHAVQ804'\n```\n\nFind all alerts not from a specific alert source:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'alert_source[not_in]=01GBSQF3FHF7FWZQNWGHAVQ804'\n```\n\n### By alert_group_id\n\nFind all alerts in a specific alert group:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'alert_group_id[one_of]=01GBSQF3FHF7FWZQNWGHAVQ804'\n```\n\n### By created_at\nFind all alerts that follow specified date parameters for created_at field.\nPossible values are \"gte\" (greater than or equal to), \"lte\" (less than or equal to), and \n\"date_range\" (between two dates). The following example finds all alerts created after \n2025-01-01:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'created_at[gte]=2025-01-01'\n```\n\nTo find alerts created within a specific date range, use the date_range option with \ntilde-separated dates:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'created_at[date_range]=2024-12-02~2024-12-08'\n```\n\n### By updated_at\nFind all alerts that follow specified date parameters for updated_at field, using the same\n\"gte\", \"lte\" and \"date_range\" operators as created_at. This is useful for incrementally\nsyncing alerts: poll with updated_at[gte] set to your last sync time instead of re-fetching\nthe full history. Note that updated_at moves whenever the alert row is written, which can\nhappen without a visible change to the alert payload, so treat matches as candidates to\nre-fetch rather than guaranteed changes — and overlap your sync window by a few minutes to\nallow for writes that commit out of timestamp order:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'updated_at[gte]=2025-01-01T00:00:00Z'\n```\n\n### By has_notes\n\nFind all alerts that have notes attached:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'has_notes[is]=true'\n```\n\nFind all alerts that have no notes attached:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'has_notes[is]=false'\n```\n\n### By tags\n\nFilter by tag name, matched case-insensitively.\n\nFind all alerts that have any of the given tags:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'tags[one_of]=known issue'\n```\n\nFind all alerts that have all of the given tags:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'tags[all_of]=known issue' \\\n--data 'tags[all_of]=customer impacting'\n```\n\nFind all alerts that do not have any of the given tags. Untagged alerts are included:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'tags[not_in]=known issue'\n```\n\n### By attributes\n\nAlerts can be filtered by their attribute values. Each filter is keyed by the alert\nattribute ID, followed by an operator and the values to match. The accepted operators\ndepend on the attribute's type.\n\nFind all alerts where attribute 01GBSQF3FHF7FWZQNWGHAVQ804 is one of two catalog entries:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'attributes[01GBSQF3FHF7FWZQNWGHAVQ804][one_of]=01GBSQF3FHF7FWZQNWGHAVQ804' \\\n--data 'attributes[01GBSQF3FHF7FWZQNWGHAVQ804][one_of]=01ET65M7ZARSFZ6TFDFVQDN9AA'\n```\n\nYou can filter on multiple attributes at once, and the result will be alerts that match\nall of them.\n\n### Maintenance windows\nBy default, all alerts are returned including those held by a maintenance window.\nTo exclude alerts that are held by a maintenance window:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'include_maintenance_window[is]=false'\n\n```", "operationId": "Alerts V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of alerts to return per page", "example": 25, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "Number of alerts to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "after", "schema": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on alert deduplication key. The accepted operator is 'is'.", "example": { "is": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "deduplication_key", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert deduplication key. The accepted operator is 'is'.", "example": { "is": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "firing" ] }, "in": "query", "name": "status", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "firing" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert source by ID. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "alert_source", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert source by ID. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert group ID. Returns alerts that belong to any of the specified groups. The accepted operator is 'one_of'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "alert_group_id", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert group ID. Returns alerts that belong to any of the specified groups. The accepted operator is 'one_of'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert updated at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "updated_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert updated at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on an alerts attributes. Alert attribute ID should be sent, followed by the operator and values. Accepted operator will depend on the attribute type.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "in": "query", "name": "attributes", "schema": { "additionalProperties": { "additionalProperties": { "example": [ "value" ], "items": { "example": "value", "type": "string" }, "type": "array" }, "example": { "abc123": [ "value" ] }, "type": "object" }, "description": "Filter on an alerts attributes. Alert attribute ID should be sent, followed by the operator and values. Accepted operator will depend on the attribute type.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on whether an alert has notes. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "in": "query", "name": "has_notes", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on whether an alert has notes. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the tags applied to an alert, by tag name. The accepted operators are 'one_of', 'all_of' and 'not_in'.", "example": { "one_of": [ "known issue" ] }, "in": "query", "name": "tags", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the tags applied to an alert, by tag name. The accepted operators are 'one_of', 'all_of' and 'not_in'.", "example": { "one_of": [ "known issue" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on whether to include maintenance window alerts. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "in": "query", "name": "include_maintenance_window", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on whether to include maintenance window alerts. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alerts": [ { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertsListResultV2" } } }, "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": [ "Alerts V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.view` scope." }, "x-rbac-scopes": [ "alerts.view" ] } }, "/v2/alerts/{id}": { "get": { "description": "Show a single alert for your account", "operationId": "Alerts V2_Show", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsShowResultV2" } } }, "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": [ "Alerts V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.view` scope." }, "x-rbac-scopes": [ "alerts.view" ] } }, "/v2/alerts/{id}/actions/add_tags": { "post": { "description": "Add tags to an alert without changing its existing tags.\n\nEach tag is a name. A name that does not exist is created, except on private alerts,\nwhere only names already in the organisation's tag vocabulary can be used. Tags that are\nalready present are ignored.", "operationId": "Alerts V2_AddTags", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tags": [ "known issue", "customer impacting" ] }, "schema": { "$ref": "#/components/schemas/AlertsAddTagsPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsAddTagsResultV2" } } }, "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": "Add tags", "tags": [ "Alerts V2" ], "x-docs-display-name": "Add tags", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] } }, "/v2/alerts/{id}/actions/remove_tags": { "post": { "description": "Remove tags from an alert without changing its other tags.\n\nEach tag is a name. Tags that are not present on the alert are ignored.", "operationId": "Alerts V2_RemoveTags", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tags": [ "known issue", "customer impacting" ] }, "schema": { "$ref": "#/components/schemas/AlertsRemoveTagsPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsRemoveTagsResultV2" } } }, "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": "Remove tags", "tags": [ "Alerts V2" ], "x-docs-display-name": "Remove tags", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] } }, "/v2/alerts/{id}/actions/resolve": { "post": { "description": "Resolve a currently firing alert.\n\nThis marks the alert as resolved with the current time, attributing the resolution to the API key that made the request. Resolving an already-resolved alert is a no-op and returns the alert unchanged.\n\nSome alert sources are 'externally resolved' (for example, Datadog) — those alerts can only be resolved by the third-party system itself, and this endpoint will return a 422 explaining that.\n\nPrivate alerts: an API key without the 'view all alerts' scope can only resolve non-private alerts; private alerts will return a 404. Grant the API key a role that includes the global alerts access scope to resolve private alerts.\n", "operationId": "Alerts V2_Resolve", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsResolveResultV2" } } }, "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": "Resolve", "tags": [ "Alerts V2" ], "x-docs-display-name": "Resolve", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.resolve` scope." }, "x-rbac-scopes": [ "alerts.resolve" ] } }, "/v2/alerts/{id}/actions/set_tags": { "post": { "description": "Replace all tags on an alert.\n\nEach tag is a name. A name that does not exist is created, except on private alerts,\nwhere only names already in the organisation's tag vocabulary can be used. Passing an\nempty list removes every tag.", "operationId": "Alerts V2_SetTags", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tags": [ "known issue", "customer impacting" ] }, "schema": { "$ref": "#/components/schemas/AlertsSetTagsPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsSetTagsResultV2" } } }, "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": "Set tags", "tags": [ "Alerts V2" ], "x-docs-display-name": "Set tags", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] } } }, "components": { "schemas": { "AlertsListResultV2": { "example": { "alerts": [ { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "alerts": { "example": [ { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/AlertV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "alerts", "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" }, "AlertsShowResultV2": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsAddTagsPayloadV2": { "example": { "tags": [ "known issue", "customer impacting" ] }, "properties": { "tags": { "description": "Tag names to add to this alert", "example": [ "known issue", "customer impacting" ], "items": { "example": "abc123", "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "AlertsAddTagsResultV2": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsRemoveTagsPayloadV2": { "example": { "tags": [ "known issue", "customer impacting" ] }, "properties": { "tags": { "description": "Tag names to remove from this alert", "example": [ "known issue", "customer impacting" ], "items": { "example": "abc123", "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "AlertsRemoveTagsResultV2": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsResolveResultV2": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsSetTagsPayloadV2": { "example": { "tags": [ "known issue", "customer impacting" ] }, "properties": { "tags": { "description": "The complete set of tag names for this alert", "example": [ "known issue", "customer impacting" ], "items": { "example": "abc123", "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "AlertsSetTagsResultV2": { "example": { "alert": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertV2": { "properties": { "alert_group_ids": { "description": "The IDs of every alert group this alert belongs to. Empty when the alert is not part of any group.", "example": [ "01GW2G3V0S59R238FAHPDS1R66" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "alert_source_id": { "description": "The ID of the alert source this alert fired on", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "attributes": { "description": "Attribute values parsed from the alerts payload", "example": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "items": { "$ref": "#/components/schemas/AlertAttributeEntryV2" }, "type": "array" }, "created_at": { "description": "When this entry was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "deduplication_key": { "description": "A deduplication key which uniquely references this alert from your alert source. For newly created HTTP sources, this field is required.\nIf you send an event with the same deduplication_key multiple times, only one alert will be created in incident.io for this alert source config.\nYou can filter on this field to find the alert created by an event you've sent us.", "example": "4293868629", "type": "string" }, "description": { "description": "The description of the alert", "example": "CPU on the payments service has exceeded 75 percent for 5 minutes", "type": "string" }, "id": { "description": "The ID of this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "resolved_at": { "description": "When this alert was resolved", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "source_url": { "description": "If applicable, a link to the alert in the upstream system", "example": "https://www.my-alerting-platform.com/alerts/my-alert-123", "type": "string" }, "status": { "description": "Statuses of an alert", "enum": [ "firing", "resolved" ], "example": "firing", "type": "string", "x-public-api-version": "v2" }, "tags": { "description": "Tags someone has applied to this alert", "example": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "items": { "$ref": "#/components/schemas/AlertTagV2" }, "type": "array" }, "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" }, "updated_at": { "description": "When this alert was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "alert_source_id", "deduplication_key", "status", "title", "attributes", "created_at", "updated_at" ], "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" }, "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" }, "AlertAttributeEntryV2": { "example": { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } }, "properties": { "array_value": { "description": "The value of the attribute if it is an array", "example": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "items": { "$ref": "#/components/schemas/AlertAttributeValueV2" }, "type": "array" }, "attribute": { "$ref": "#/components/schemas/AlertAttributeV2" }, "value": { "$ref": "#/components/schemas/AlertAttributeValueV2" } }, "required": [ "attribute" ], "type": "object" }, "AlertTagV2": { "properties": { "id": { "description": "Unique identifier for the tag", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "name": { "description": "The tag name", "example": "noisy", "type": "string" } }, "required": [ "id", "name" ], "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" }, "AlertAttributeValueV2": { "example": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/AlertAttributeCatalogEntryV2" }, "label": { "description": "The human readable label of this value for convenience. Will match the literal if this is a primitive type, or be the name of the catalog entry if this is a catalog entry", "example": "Payments Team", "type": "string" }, "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" } }, "type": "object" }, "AlertAttributeV2": { "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "emoji": { "description": "The emoji to display alongside this attribute in chat messages, stored without colons", "example": "fire", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "name": { "description": "Unique name of this attribute", "example": "service", "type": "string" }, "required": { "description": "Whether this attribute is required. If this field is not set, the existing setting will be preserved.", "example": false, "type": "boolean" }, "type": { "description": "Engine resource name for this attribute", "example": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]", "type": "string" } }, "required": [ "id", "name", "type", "array", "required" ], "type": "object" }, "AlertAttributeCatalogEntryV2": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "properties": { "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" } }, "required": [ "id", "catalog_type_id", "name" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key from your incident.io dashboard (Settings → API keys)" } } } }