{ "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 incident actions.\n\nThese endpoints have been deprecated in favour of Actions V2 and Follow-ups V2, as these\nconcepts have become increasingly separate.\n\nIncidents have two types of actions associated to them:\n\n- Actions, used during an incident response as ephemeral todo lists\n- Follow-ups, actions which are for after the incident and can be exported to external\n\tissue trackers\n\nYou can manage actions in the incident Slack channel with /incident actions, or on\nthe incident homepage.\n\nExporting follow-ups to external issue trackers can be done in the incident homepage.\n", "name": "Actions V1" }, { "description": "Manage incident actions.\n\nThese endpoints have been deprecated in favour of Actions V3, which returns the same\naction payload, and will be removed on 31 December 2026. The V3 List endpoint is paginated\nand supports filtering by created_at and updated_at, so use it instead of re-fetching the\nfull list.\n\nIncident actions are used during an incident, to track work such as 'restart the database' or 'contact the customer'.\n\nYou can manage actions in the incident Slack channel with /incident actions, or on\nthe incident homepage.\n", "name": "Actions V2" }, { "description": "Configure your alert routes in incident.io.\n\nAlert routes define how alerts from different sources are processed, grouped, and routed to the right teams and people.", "name": "Alert Routes V2" }, { "description": "Manage and browse catalog resources.\n\nThese endpoints have been deprecated in favour of CatalogV3. The only breaking change is\nthat the 'manual' attribute mode is now split into 'api' and 'dashboard'. We also removed\nthe usage of some types that were deprecated in the V2 API. \n\nUse the incident.io catalog to track services, teams, product features and anything\nelse that helps build a map of your organisation. These different categories of thing\nbecome catalog types, and each instance (like a particular service or team) is a\ncatalog entry.\n\nEach type is made up of a series of attributes, and each attribute has a type. Types\ncan even have attributes that refer to other catalog types.\n\nWe automatically create catalog types when you connect an integration, such as GitHub\nrepositories or PagerDuty services and teams. You can use this API to create custom\ntypes, that are specifically tailored to your organisation.\n\nExamples might be a 'Service' type with an 'Alert channel' which you can point at a\nSlack channel, or 'Team' which specifies its 'Manager' and 'Technical Lead' as Slack\nusers. You can then use these types to create powerful new workflows.\n\nConsider using our official [catalog importer](https://github.com/incident-io/catalog-importer).\nIt can be used to sync catalog data from sources like local files or GitHub and push\nthem into the incident.io catalog without having to directly interact with our public API.\n", "name": "Catalog V2" }, { "description": "Manage custom fields.\n\nCustom fields are used to attach metadata to incidents, which you can use when searching\nfor incidents in the dashboard, triggering workflows, building announcement rules or for\nyour own data needs.\n\nEach field has a type:\n\n- Single-select, single value selected from a predefined list of options (e.g. Detection Method)\n- Multi-select, as above but you can pick more than one option (e.g. Affected Teams)\n- Text, freeform text field (e.g. Customer ID)\n- Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)\n- Number, integer or fractional numbers (e.g. # Customers Affected)\n\nWe may add more custom field types in the future - we'd love to hear any other types you'd like to use!\n", "name": "Custom Fields V1" }, { "description": "Manage incident follow-ups.\n\nThese endpoints have been deprecated in favour of Follow-ups V3, which returns the same\nfollow-up payload, and will be removed on 31 December 2026. The V3 List endpoint is\npaginated and supports filtering by created_at and updated_at, so use it instead of\nre-fetching the full list.\n\nIncidents can have follow-ups associated with them, which track work that should be done\nafter an incident (e.g. improving some documentation, or upgrading a dependency). They can\nalso be exported to external issue trackers.\n\nYou can manage follow-ups in the incident Slack channel with /incident follow-ups, or on\nthe incident homepage.\n", "name": "Follow-ups V2" }, { "description": "Manage incident roles.\n\nDuring an incident, you can assign responders to one of the incident roles that are\nconfigured in your organisation settings.\n\nEvery organisation will have a special 'lead' role, which signifies the incident lead or\ncommander. This role cannot be deleted, but can be renamed in the incident.io dashboard.\n", "name": "Incident Roles V1" }, { "description": "Create and read incidents.\n\nIncidents are a core resource, on which many other resources (actions, etc) are created.\n\nCare should be taken around these endpoints, as automation that creates duplicate\nincidents can be distracting, and impact reporting.\n\nThe maximum page size that can be requested is 250.\n", "name": "Incidents V1" } ], "paths": { "/v1/actions": { "get": { "deprecated": true, "description": "List all actions for an organisation.", "operationId": "Actions V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Find actions related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to actions marked as being follow up actions", "example": true, "in": "query", "name": "is_follow_up", "schema": { "description": "Filter to actions marked as being follow up actions", "example": true, "type": "boolean" } }, { "allowEmptyValue": true, "description": "Filter to actions from incidents of the given mode. If not set, only actions from `real` incidents are returned", "examples": { "default": { "summary": "default", "value": "real" } }, "in": "query", "name": "incident_mode", "schema": { "description": "Filter to actions from incidents of the given mode. If not set, only actions from `real` incidents are returned", "enum": [ "real", "test", "tutorial" ], "example": "real", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/ActionsListResultV1" } } }, "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": [ "Actions V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Actions V1", "x-docs-resource-type": "ActionV1", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] } }, "/v1/actions/{id}": { "get": { "deprecated": true, "description": "Get a single incident action.", "operationId": "Actions V1_Show", "parameters": [ { "description": "Unique identifier for the action", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsShowResultV1" } } }, "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": [ "Actions V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Actions V1", "x-docs-resource-type": "ActionV1", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] } }, "/v2/actions": { "get": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use GET /v3/actions instead.\n\nList all actions for an organisation.", "operationId": "Actions V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Find actions related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to actions from incidents of the given mode. If not set, only actions from `standard` and `retrospective` incidents are returned", "examples": { "default": { "summary": "default", "value": "standard" } }, "in": "query", "name": "incident_mode", "schema": { "description": "Filter to actions from incidents of the given mode. If not set, only actions from `standard` and `retrospective` incidents are returned", "enum": [ "standard", "retrospective", "test", "tutorial", "stream" ], "example": "standard", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/ActionsListResultV2" } } }, "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": [ "Actions V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Actions V2", "x-docs-resource-type": "ActionV2", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] }, "post": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use POST /v3/actions instead.\n\nCreate a new incident action.", "operationId": "Actions V2_Create", "requestBody": { "content": { "application/json": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H" }, "schema": { "$ref": "#/components/schemas/ActionsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsCreateResultV2" } } }, "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": [ "Actions V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Actions V2", "x-docs-resource-type": "ActionV2", "x-mint": { "content": "🔑 Requires the `actions.create` scope." }, "x-rbac-scopes": [ "actions.create" ] } }, "/v2/actions/{id}": { "delete": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use DELETE /v3/actions/{id} instead.\n\nDelete an incident action.", "operationId": "Actions V2_Delete", "parameters": [ { "description": "Unique identifier for the action", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "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": [ "Actions V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Actions V2", "x-docs-resource-type": "ActionV2", "x-mint": { "content": "🔑 Requires the `actions.destroy` scope." }, "x-rbac-scopes": [ "actions.destroy" ] }, "get": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use GET /v3/actions/{id} instead.\n\nGet a single incident action.", "operationId": "Actions V2_Show", "parameters": [ { "description": "Unique identifier for the action", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsShowResultV2" } } }, "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": [ "Actions V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Actions V2", "x-docs-resource-type": "ActionV2", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] }, "put": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use PUT /v3/actions/{id} instead.\n\nUpdate an existing incident action.", "operationId": "Actions V2_Update", "parameters": [ { "description": "Unique identifier for the action", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "status": "outstanding" }, "schema": { "$ref": "#/components/schemas/ActionsUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsUpdateResultV2" } } }, "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": [ "Actions V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Actions V2", "x-docs-resource-type": "ActionV2", "x-mint": { "content": "🔑 Requires the `actions.update` scope." }, "x-rbac-scopes": [ "actions.update" ] } }, "/v2/alert_routes": { "get": { "description": "List all alert routes in your account.", "operationId": "Alert Routes V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of alert routes to return per page", "example": 25, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "Number of alert routes to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "The ID of the last alert route on the previous page", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "The ID of the last alert route on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_routes": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesListResultV2" } } }, "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": [ "Alert Routes V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2", "x-mint": { "content": "🔑 Requires the `alert_routes.view` scope." }, "x-rbac-scopes": [ "alert_routes.view" ] }, "post": { "description": "Create a new alert route in your account.", "operationId": "Alert Routes V2_Create", "requestBody": { "content": { "application/json": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z" }, "schema": { "$ref": "#/components/schemas/AlertRoutesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] } ], "channel_config": [ { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "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" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "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" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesCreateResultV2" } } }, "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": [ "Alert Routes V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2", "x-mint": { "content": "🔑 Requires the `alert_route.create` scope." }, "x-rbac-scopes": [ "alert_route.create" ] } }, "/v2/alert_routes/{id}": { "delete": { "description": "Delete an existing alert route in your account.", "operationId": "Alert Routes V2_Delete", "parameters": [ { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "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": [ "Alert Routes V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2", "x-mint": { "content": "🔑 Requires the `alert_route.destroy` scope." }, "x-rbac-scopes": [ "alert_route.destroy" ] }, "get": { "description": "Load details about a specific alert route in your account.", "operationId": "Alert Routes V2_Show", "parameters": [ { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] } ], "channel_config": [ { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "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" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "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" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesShowResultV2" } } }, "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": [ "Alert Routes V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2", "x-mint": { "content": "🔑 Requires the `alert_routes.view` scope." }, "x-rbac-scopes": [ "alert_routes.view" ] }, "put": { "description": "Update an existing alert route in your account.", "operationId": "Alert Routes V2_Update", "parameters": [ { "description": "Unique identifier of the alert route", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "schema": { "$ref": "#/components/schemas/AlertRoutesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] } ], "channel_config": [ { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "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" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "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" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesUpdateResultV2" } } }, "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": [ "Alert Routes V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2", "x-mint": { "content": "🔑 Requires the `alert_route.update` scope." }, "x-rbac-scopes": [ "alert_route.update" ] } }, "/v2/catalog_entries": { "get": { "deprecated": true, "description": "List entries for a catalog type.", "operationId": "Catalog V2_ListEntries", "parameters": [ { "allowEmptyValue": true, "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "catalog_type_id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_entries": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" }, "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/CatalogListEntriesResultV2" } } }, "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": [ "Catalog V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2", "x-mint": { "content": "🔑 Requires the `catalog_entries.view` scope." }, "x-rbac-scopes": [ "catalog_entries.view" ] }, "post": { "deprecated": true, "description": "Create an entry within the catalog. We support a maximum of 50,000 entries per type.\n\nIf you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated.", "operationId": "Catalog V2_CreateEntry", "requestBody": { "content": { "application/json": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "schema": { "$ref": "#/components/schemas/CatalogCreateEntryPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogCreateEntryResultV2" } } }, "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": [ "Catalog V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2", "x-mint": { "content": "🔑 Requires the `catalog_entries.create` scope." }, "x-rbac-scopes": [ "catalog_entries.create" ] } }, "/v2/catalog_entries/{id}": { "delete": { "deprecated": true, "description": "Archives a catalog entry.", "operationId": "Catalog V2_DestroyEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "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": [ "Catalog V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2", "x-mint": { "content": "🔑 Requires the `catalog_entries.destroy` scope." }, "x-rbac-scopes": [ "catalog_entries.destroy" ] }, "get": { "deprecated": true, "description": "Show a single catalog entry.", "operationId": "Catalog V2_ShowEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogShowEntryResultV2" } } }, "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": [ "Catalog V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2", "x-mint": { "content": "🔑 Requires the `catalog_entries.view` scope." }, "x-rbac-scopes": [ "catalog_entries.view" ] }, "put": { "deprecated": true, "description": "Updates an existing catalog entry.", "operationId": "Catalog V2_UpdateEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "schema": { "$ref": "#/components/schemas/CatalogUpdateEntryPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateEntryResultV2" } } }, "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": [ "Catalog V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2", "x-mint": { "content": "🔑 Requires the `catalog_entries.edit` scope." }, "x-rbac-scopes": [ "catalog_entries.edit" ] } }, "/v2/catalog_resources": { "get": { "deprecated": true, "description": "List available engine resources for the catalog.\n\nA resource represents a type of data that can be held within the catalog, so this\nendpoint can be used to see what attribute types can be used when updating the\nschema of a catalog type.\n", "operationId": "Catalog V2_ListResources", "responses": { "200": { "content": { "application/json": { "example": { "resources": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "Custom[\"Team\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website" } ] }, "schema": { "$ref": "#/components/schemas/CatalogListResourcesResultV2" } } }, "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": [ "Catalog V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Catalog Resources V2", "x-docs-resource-type": "CatalogResourceV2", "x-mint": { "content": "🔑 Requires the `catalog_types.view` scope." }, "x-rbac-scopes": [ "catalog_types.view" ] } }, "/v2/catalog_types": { "get": { "deprecated": true, "description": "List all catalog types for an organisation, including those synced from external resources.", "operationId": "Catalog V2_ListTypes", "responses": { "200": { "content": { "application/json": { "example": { "catalog_types": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/CatalogListTypesResultV2" } } }, "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": [ "Catalog V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2", "x-mint": { "content": "🔑 Requires the `catalog_types.view` scope." }, "x-rbac-scopes": [ "catalog_types.view" ] }, "post": { "deprecated": true, "description": "Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint.", "operationId": "Catalog V2_CreateType", "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]" }, "schema": { "$ref": "#/components/schemas/CatalogCreateTypePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogCreateTypeResultV2" } } }, "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": [ "Catalog V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2", "x-mint": { "content": "🔑 Requires the `catalog_types.create` scope." }, "x-rbac-scopes": [ "catalog_types.create" ] } }, "/v2/catalog_types/{id}": { "delete": { "deprecated": true, "description": "Archives a catalog type and associated entries.", "operationId": "Catalog V2_DestroyType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "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": [ "Catalog V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2", "x-mint": { "content": "🔑 Requires the `catalog_types.destroy` scope." }, "x-rbac-scopes": [ "catalog_types.destroy" ] }, "get": { "deprecated": true, "description": "Show a single catalog type.", "operationId": "Catalog V2_ShowType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogShowTypeResultV2" } } }, "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": [ "Catalog V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2", "x-mint": { "content": "🔑 Requires the `catalog_types.view` scope." }, "x-rbac-scopes": [ "catalog_types.view" ] }, "put": { "deprecated": true, "description": "Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint.", "operationId": "Catalog V2_UpdateType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog" }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeResultV2" } } }, "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 Type", "tags": [ "Catalog V2" ], "x-docs-display-name": "Update Type", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2", "x-mint": { "content": "🔑 Requires the `catalog_types.edit` scope." }, "x-rbac-scopes": [ "catalog_types.edit" ] } }, "/v2/catalog_types/{id}/actions/update_schema": { "post": { "deprecated": true, "description": "Update an existing catalog types schema, adding or removing attributes.\n\nUpdating the schema is handled separately from creating and updating types, so that you don't\nhave to worry about dependencies between types. For example, if type A has an attribute that\nrelies on type B, you would have to create type B first.\n\nBy allowing the creation of types without a schema, they can be created in any order, but it\nmeans that you need to make a separate call to this endpoint to update the schema.", "operationId": "Catalog V2_UpdateTypeSchema", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeSchemaPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeSchemaResultV2" } } }, "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 Type Schema", "tags": [ "Catalog V2" ], "x-docs-display-name": "Update Type Schema", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2", "x-mint": { "content": "🔑 Requires the `catalog_types.edit` scope." }, "x-rbac-scopes": [ "catalog_types.edit" ] } }, "/v1/custom_fields": { "get": { "deprecated": true, "description": "List all custom fields for an organisation.", "operationId": "Custom Fields V1_List", "responses": { "200": { "content": { "application/json": { "example": { "custom_fields": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/CustomFieldsListResultV1" } } }, "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": [ "Custom Fields V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1", "x-mint": { "content": "🔑 Requires the `custom_fields.view` scope." }, "x-rbac-scopes": [ "custom_fields.view" ] }, "post": { "deprecated": true, "description": "Create a new custom field", "operationId": "Custom Fields V1_Create", "requestBody": { "content": { "application/json": { "example": { "description": "Which team is impacted by this issue", "field_type": "single_select", "name": "Affected Team", "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true }, "schema": { "$ref": "#/components/schemas/CustomFieldsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsCreateResultV1" } } }, "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": [ "Custom Fields V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v1/custom_fields/{id}": { "delete": { "deprecated": true, "description": "Delete a custom field", "operationId": "Custom Fields V1_Delete", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "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": [ "Custom Fields V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] }, "get": { "deprecated": true, "description": "Get a single custom field.", "operationId": "Custom Fields V1_Show", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsShowResultV1" } } }, "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": [ "Custom Fields V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1", "x-mint": { "content": "🔑 Requires the `custom_fields.view` scope." }, "x-rbac-scopes": [ "custom_fields.view" ] }, "put": { "deprecated": true, "description": "Update the details of a custom field", "operationId": "Custom Fields V1_Update", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Which team is impacted by this issue", "name": "Affected Team", "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true }, "schema": { "$ref": "#/components/schemas/CustomFieldsUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsUpdateResultV1" } } }, "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": [ "Custom Fields V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v2/follow_ups": { "get": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use GET /v3/follow_ups instead.\n\nList all follow-ups for an organisation.", "operationId": "Follow-ups V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Find follow-ups related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to follow-ups from incidents of the given mode. If not set, only follow-ups from `standard` and `retrospective` incidents are returned", "example": "standard", "in": "query", "name": "incident_mode", "schema": { "description": "Filter to follow-ups from incidents of the given mode. If not set, only follow-ups from `standard` and `retrospective` incidents are returned", "enum": [ "standard", "retrospective", "test", "tutorial", "stream" ], "example": "standard", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter follow-ups that are assigned to the given team", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "assignee_team_id", "schema": { "description": "Filter follow-ups that are assigned to the given team", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "follow_ups": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/FollowUpsListResultV2" } } }, "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": [ "Follow-ups V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Follow-ups V2", "x-docs-resource-type": "FollowUpV2", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] }, "post": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use POST /v3/follow_ups instead.\n\nCreate a new incident follow-up.", "operationId": "Follow-ups V2_Create", "requestBody": { "content": { "application/json": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "external_issue_reference_id": "01FCNDV6P870EA6S7TK1DSYDG0", "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "labels": [ "bug", "urgent" ], "title": "Add alerting on replica lag" }, "schema": { "$ref": "#/components/schemas/FollowUpsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/FollowUpsCreateResultV2" } } }, "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": [ "Follow-ups V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Follow-ups V2", "x-docs-resource-type": "FollowUpV2", "x-mint": { "content": "🔑 Requires the `follow_ups.create` scope." }, "x-rbac-scopes": [ "follow_ups.create" ] } }, "/v2/follow_ups/{id}": { "delete": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use DELETE /v3/follow_ups/{id} instead.\n\nDelete an incident follow-up.", "operationId": "Follow-ups V2_Delete", "parameters": [ { "description": "Unique identifier for the follow-up", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "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": [ "Follow-ups V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Follow-ups V2", "x-docs-resource-type": "FollowUpV2", "x-mint": { "content": "🔑 Requires the `follow_ups.destroy` scope." }, "x-rbac-scopes": [ "follow_ups.destroy" ] }, "get": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use GET /v3/follow_ups/{id} instead.\n\nGet a single incident follow-up.", "operationId": "Follow-ups V2_Show", "parameters": [ { "description": "Unique identifier for the follow-up", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/FollowUpsShowResultV2" } } }, "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": [ "Follow-ups V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Follow-ups V2", "x-docs-resource-type": "FollowUpV2", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] }, "put": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use PUT /v3/follow_ups/{id} instead.\n\nUpdate an existing incident follow-up.", "operationId": "Follow-ups V2_Update", "parameters": [ { "description": "Unique identifier for the follow-up", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "labels": [ "bug", "urgent" ], "status": "outstanding", "title": "Add alerting on replica lag" }, "schema": { "$ref": "#/components/schemas/FollowUpsUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/FollowUpsUpdateResultV2" } } }, "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": [ "Follow-ups V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Follow-ups V2", "x-docs-resource-type": "FollowUpV2", "x-mint": { "content": "🔑 Requires the `follow_ups.update` scope." }, "x-rbac-scopes": [ "follow_ups.update" ] } }, "/v2/follow_ups/{id}/actions/connect_external_issue": { "post": { "deprecated": true, "description": "Deprecated: this endpoint will be removed on 31 December 2026. Use POST /v3/follow_ups/{id}/actions/connect_external_issue instead.\n\nConnect a follow-up to an existing issue in an issue tracker, using the URL of the issue.\n\nThis will not work if the follow-up is already connected to an external issue.\n", "operationId": "Follow-ups V2_ConnectExternalIssue", "parameters": [ { "description": "Unique identifier for the follow-up", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "provider": "linear", "url": "https://linear.app/incident/issue/INC-123" }, "schema": { "$ref": "#/components/schemas/FollowUpsConnectExternalIssuePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/FollowUpsConnectExternalIssueResultV2" } } }, "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": "Connect external issue", "tags": [ "Follow-ups V2" ], "x-docs-display-name": "Connect external issue", "x-docs-group-name": "Follow-ups V2", "x-docs-resource-type": "FollowUpV2", "x-mint": { "content": "🔑 Requires the `follow_ups.connect_external_issue` scope." }, "x-rbac-scopes": [ "follow_ups.connect_external_issue" ] } }, "/v1/incident_roles": { "get": { "deprecated": true, "description": "List all incident roles for an organisation.", "operationId": "Incident Roles V1_List", "responses": { "200": { "content": { "application/json": { "example": { "incident_roles": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/IncidentRolesListResultV1" } } }, "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": [ "Incident Roles V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1", "x-mint": { "content": "🔑 Requires the `incident_roles.view` scope." }, "x-rbac-scopes": [ "incident_roles.view" ] }, "post": { "deprecated": true, "description": "Create a new incident role", "operationId": "Incident Roles V1_Create", "requestBody": { "content": { "application/json": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "shortform": "lead" }, "schema": { "$ref": "#/components/schemas/IncidentRolesCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesCreateResultV1" } } }, "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": [ "Incident Roles V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v1/incident_roles/{id}": { "delete": { "deprecated": true, "description": "Removes an existing role", "operationId": "Incident Roles V1_Delete", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "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": [ "Incident Roles V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] }, "get": { "deprecated": true, "description": "Get a single incident role.", "operationId": "Incident Roles V1_Show", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesShowResultV1" } } }, "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": [ "Incident Roles V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1", "x-mint": { "content": "🔑 Requires the `incident_roles.view` scope." }, "x-rbac-scopes": [ "incident_roles.view" ] }, "put": { "deprecated": true, "description": "Update an existing incident role", "operationId": "Incident Roles V1_Update", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "shortform": "lead" }, "schema": { "$ref": "#/components/schemas/IncidentRolesUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesUpdateResultV1" } } }, "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": [ "Incident Roles V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v1/incidents": { "get": { "deprecated": true, "description": "List all incidents for an organisation.", "operationId": "Incidents V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 500, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter for incidents in these statuses", "examples": { "default": { "summary": "default", "value": [ "declined" ] } }, "in": "query", "name": "status", "schema": { "description": "Filter for incidents in these statuses", "example": [ "declined" ], "items": { "example": "declined", "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incidents": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "schema": { "$ref": "#/components/schemas/IncidentsListResultV1" } } }, "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": [ "Incidents V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incidents V1", "x-docs-resource-type": "IncidentV1", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] }, "post": { "deprecated": true, "description": "Create a new incident.", "operationId": "Incidents V1_Create", "requestBody": { "content": { "application/json": { "example": { "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "idempotency_key": "alert-uuid", "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "mode": "real", "name": "Our database is sad", "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "slack_team_id": "T02A1FSLE8J", "source_message_channel_id": "C02AW36C1M5", "source_message_timestamp": "1653650280.526509", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "schema": { "$ref": "#/components/schemas/IncidentsCreatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } }, "schema": { "$ref": "#/components/schemas/IncidentsCreateResultV1" } } }, "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": "Create", "tags": [ "Incidents V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incidents V1", "x-docs-resource-type": "IncidentV1", "x-mint": { "content": "🔑 Requires the `incidents.create` scope." }, "x-rbac-scopes": [ "incidents.create" ] } }, "/v1/incidents/{id}": { "get": { "deprecated": true, "description": "Get a single incident.", "operationId": "Incidents V1_Show", "parameters": [ { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } }, "schema": { "$ref": "#/components/schemas/IncidentsShowResultV1" } } }, "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": [ "Incidents V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incidents V1", "x-docs-resource-type": "IncidentV1", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] } } }, "components": { "schemas": { "ActionsListResultV1": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "actions": { "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ActionV1" }, "type": "array" } }, "required": [ "actions" ], "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" }, "ActionsShowResultV1": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV1" } }, "required": [ "action" ], "type": "object" }, "ActionsListResultV2": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "actions": { "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ActionV2" }, "type": "array" } }, "required": [ "actions" ], "type": "object" }, "ActionsCreatePayloadV2": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H" }, "properties": { "assignee_id": { "description": "ID of the user this action is assigned to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the action. Supports Markdown.", "example": "Call the fire brigade", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the action belongs to", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, "required": [ "incident_id", "description" ], "type": "object" }, "ActionsCreateResultV2": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV2" } }, "required": [ "action" ], "type": "object" }, "ActionsShowResultV2": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV2" } }, "required": [ "action" ], "type": "object" }, "ActionsUpdatePayloadV2": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "status": "outstanding" }, "properties": { "assignee_id": { "description": "ID of the user this action is assigned to. Set to null to unassign.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the action. Supports Markdown.", "example": "Call the fire brigade", "type": "string" }, "status": { "description": "Status of the action. Setting this to `deleted` is not allowed; use the delete endpoint instead.", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" } }, "required": [ "description", "status" ], "type": "object" }, "ActionsUpdateResultV2": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV2" } }, "required": [ "action" ], "type": "object" }, "AlertRoutesListResultV2": { "example": { "alert_routes": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "alert_routes": { "example": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "items": { "$ref": "#/components/schemas/AlertRouteSlimV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "alert_routes", "pagination_meta" ], "type": "object" }, "AlertRoutesCreatePayloadV2": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_sources": { "description": "Which alert sources should this alert route match?", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "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/AlertRouteAlertSourcePayloadV2" }, "type": "array" }, "channel_config": { "description": "The channel configuration for this alert route", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "items": { "$ref": "#/components/schemas/AlertRouteChannelConfigPayloadV2" }, "type": "array" }, "condition_groups": { "description": "What condition groups must be true for this alert route to fire?", "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" }, "created_at": { "description": "The time of creation of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigPayloadV2" }, "expressions": { "description": "The expressions used in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigPayloadV2" }, "incident_template": { "$ref": "#/components/schemas/AlertRouteIncidentTemplatePayloadV2" }, "is_private": { "description": "Whether this alert route is private. Private alert routes will only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_template": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "updated_at": { "description": "The time of last update of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "condition_groups", "expressions", "is_private", "enabled", "escalation_config", "incident_config", "incident_template", "alert_sources", "channel_config" ], "type": "object" }, "AlertRoutesCreateResultV2": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] } ], "channel_config": [ { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "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" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "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" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV2" } }, "required": [ "alert_route" ], "type": "object" }, "AlertRoutesShowResultV2": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] } ], "channel_config": [ { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "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" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "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" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV2" } }, "required": [ "alert_route" ], "type": "object" }, "AlertRoutesUpdatePayloadV2": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "properties": { "alert_sources": { "description": "Which alert sources should this alert route match?", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "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/AlertRouteAlertSourcePayloadV2" }, "type": "array" }, "channel_config": { "description": "The channel configuration for this alert route", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "items": { "$ref": "#/components/schemas/AlertRouteChannelConfigPayloadV2" }, "type": "array" }, "condition_groups": { "description": "What condition groups must be true for this alert route to fire?", "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" }, "created_at": { "description": "The time of creation of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigPayloadV2" }, "expressions": { "description": "The expressions used in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigPayloadV2" }, "incident_template": { "$ref": "#/components/schemas/AlertRouteIncidentTemplatePayloadV2" }, "is_private": { "description": "Whether this alert route is private. Private alert routes will only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_template": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "updated_at": { "description": "The time of last update of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The version this update will create. It must be one more than the route's latest version, otherwise the update is rejected - guarding against concurrent edits.", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "version", "name", "condition_groups", "expressions", "is_private", "enabled", "escalation_config", "incident_config", "incident_template", "alert_sources", "channel_config" ], "type": "object" }, "AlertRoutesUpdateResultV2": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] } ], "channel_config": [ { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "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" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "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" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV2" } }, "required": [ "alert_route" ], "type": "object" }, "CatalogListEntriesResultV2": { "example": { "catalog_entries": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" }, "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "catalog_entries": { "example": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CatalogEntryV2" }, "type": "array" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "catalog_type", "catalog_entries", "pagination_meta" ], "type": "object" }, "CatalogCreateEntryPayloadV2": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "type": "object" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" } }, "required": [ "catalog_type_id", "name", "attribute_values" ], "type": "object" }, "CatalogCreateEntryResultV2": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV2" } }, "required": [ "catalog_entry" ], "type": "object" }, "CatalogShowEntryResultV2": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV2" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type", "catalog_entry" ], "type": "object" }, "CatalogUpdateEntryPayloadV2": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "type": "object" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" } }, "required": [ "name", "attribute_values" ], "type": "object" }, "CatalogUpdateEntryResultV2": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV2" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type", "catalog_entry" ], "type": "object" }, "CatalogListResourcesResultV2": { "example": { "resources": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "Custom[\"Team\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website" } ] }, "properties": { "resources": { "example": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "Custom[\"Team\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website" } ], "items": { "$ref": "#/components/schemas/CatalogResourceV2" }, "type": "array" } }, "required": [ "resources" ], "type": "object" }, "CatalogListTypesResultV2": { "example": { "catalog_types": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "catalog_types": { "example": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CatalogTypeV2" }, "type": "array" } }, "required": [ "catalog_types" ], "type": "object" }, "CatalogCreateTypePayloadV2": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "incident-template", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "type_name": { "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName\"]", "example": "Custom[\"BackstageGroup\"]", "type": "string" } }, "required": [ "name", "description" ], "type": "object" }, "CatalogCreateTypeResultV2": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogShowTypeResultV2": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogUpdateTypePayloadV2": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "incident-template", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" } }, "required": [ "name", "description" ], "type": "object" }, "CatalogUpdateTypeResultV2": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogUpdateTypeSchemaPayloadV2": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "properties": { "attributes": { "example": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePayloadV2" }, "type": "array" }, "version": { "example": 1, "format": "int64", "type": "integer" } }, "required": [ "attributes", "version" ], "type": "object" }, "CatalogUpdateTypeSchemaResultV2": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type" ], "type": "object" }, "CustomFieldsListResultV1": { "example": { "custom_fields": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "custom_fields": { "example": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CustomFieldV1" }, "type": "array" } }, "required": [ "custom_fields" ], "type": "object" }, "CustomFieldsCreatePayloadV1": { "example": { "description": "Which team is impacted by this issue", "field_type": "single_select", "name": "Affected Team", "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "required": { "description": "When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].", "enum": [ "never", "before_closure", "always" ], "example": "never", "type": "string" }, "required_v2": { "description": "When this custom field must be set during the incident lifecycle.", "enum": [ "never", "before_resolution", "always" ], "example": "never", "type": "string" }, "show_before_closure": { "description": "Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.", "example": true, "type": "boolean" }, "show_before_creation": { "description": "Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.", "example": true, "type": "boolean" }, "show_before_update": { "description": "Whether a custom field should be shown in the incident update modal.", "example": true, "type": "boolean" }, "show_in_announcement_post": { "description": "Whether a custom field should be shown in the list of fields as part of the announcement post when set.", "example": true, "type": "boolean" } }, "required": [ "name", "description", "field_type", "show_before_creation", "show_before_closure", "show_before_update" ], "type": "object" }, "CustomFieldsCreateResultV1": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV1" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsShowResultV1": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV1" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsUpdatePayloadV1": { "example": { "description": "Which team is impacted by this issue", "name": "Affected Team", "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "required": { "description": "When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].", "enum": [ "never", "before_closure", "always" ], "example": "never", "type": "string" }, "required_v2": { "description": "When this custom field must be set during the incident lifecycle.", "enum": [ "never", "before_resolution", "always" ], "example": "never", "type": "string" }, "show_before_closure": { "description": "Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.", "example": true, "type": "boolean" }, "show_before_creation": { "description": "Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.", "example": true, "type": "boolean" }, "show_before_update": { "description": "Whether a custom field should be shown in the incident update modal.", "example": true, "type": "boolean" }, "show_in_announcement_post": { "description": "Whether a custom field should be shown in the list of fields as part of the announcement post when set.", "example": true, "type": "boolean" } }, "required": [ "name", "description", "show_before_creation", "show_before_closure", "show_before_update" ], "type": "object" }, "CustomFieldsUpdateResultV1": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV1" } }, "required": [ "custom_field" ], "type": "object" }, "FollowUpsListResultV2": { "example": { "follow_ups": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "follow_ups": { "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/FollowUpV2" }, "type": "array" } }, "required": [ "follow_ups" ], "type": "object" }, "FollowUpsCreatePayloadV2": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "external_issue_reference_id": "01FCNDV6P870EA6S7TK1DSYDG0", "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "labels": [ "bug", "urgent" ], "title": "Add alerting on replica lag" }, "properties": { "assignee_id": { "description": "ID of the user this follow-up is assigned to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "assignee_team_id": { "description": "ID of the team this follow-up is assigned to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the follow-up. Supports Markdown.", "example": "Call the fire brigade", "type": "string" }, "external_issue_reference_id": { "description": "If this follow-up is related to an external issue, the ID of that issue", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "follow_up_category_id": { "description": "ID of the category for this follow-up", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "follow_up_priority_option_id": { "description": "ID of the priority for this follow-up", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the follow-up belongs to", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "labels": { "description": "Labels associated with this follow-up", "example": [ "bug", "urgent" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "title": { "description": "Title of the follow-up", "example": "Add alerting on replica lag", "type": "string" } }, "required": [ "incident_id", "title" ], "type": "object" }, "FollowUpsCreateResultV2": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV2" } }, "required": [ "follow_up" ], "type": "object" }, "FollowUpsShowResultV2": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV2" } }, "required": [ "follow_up" ], "type": "object" }, "FollowUpsUpdatePayloadV2": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "labels": [ "bug", "urgent" ], "status": "outstanding", "title": "Add alerting on replica lag" }, "properties": { "assignee_id": { "description": "ID of the user this follow-up is assigned to. Set to null to unassign.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "assignee_team_id": { "description": "ID of the team this follow-up is assigned to. Set to null to unassign.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the follow-up. Supports Markdown.", "example": "Call the fire brigade", "type": "string" }, "follow_up_category_id": { "description": "ID of the category for this follow-up", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "follow_up_priority_option_id": { "description": "ID of the priority for this follow-up", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "labels": { "description": "Labels associated with this follow-up", "example": [ "bug", "urgent" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "status": { "description": "Status of the follow-up. Setting this to `deleted` is not allowed; use the delete endpoint instead.", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "title": { "description": "Title of the follow-up", "example": "Add alerting on replica lag", "type": "string" } }, "required": [ "title", "status" ], "type": "object" }, "FollowUpsUpdateResultV2": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV2" } }, "required": [ "follow_up" ], "type": "object" }, "FollowUpsConnectExternalIssuePayloadV2": { "example": { "provider": "linear", "url": "https://linear.app/incident/issue/INC-123" }, "properties": { "provider": { "description": "The issue tracker provider the issue belongs to", "enum": [ "asana", "azure_devops", "click_up", "freshservice", "linear", "jira", "salesforce", "jira_server", "github", "gitlab", "service_now", "shortcut", "notion" ], "example": "linear", "type": "string" }, "url": { "description": "URL of the issue in the external provider", "example": "https://linear.app/incident/issue/INC-123", "type": "string" } }, "required": [ "provider", "url" ], "type": "object" }, "FollowUpsConnectExternalIssueResultV2": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV2" } }, "required": [ "follow_up" ], "type": "object" }, "IncidentRolesListResultV1": { "example": { "incident_roles": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incident_roles": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentRoleV1" }, "type": "array" } }, "required": [ "incident_roles" ], "type": "object" }, "IncidentRolesCreatePayloadV1": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "shortform": "lead" }, "properties": { "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "required": { "description": "DEPRECATED: this will always be false.", "example": false, "type": "boolean" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions", "required" ], "type": "object" }, "IncidentRolesCreateResultV1": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV1" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesShowResultV1": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV1" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesUpdatePayloadV1": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "shortform": "lead" }, "properties": { "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "required": { "description": "DEPRECATED: this will always be false.", "example": false, "type": "boolean" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions" ], "type": "object" }, "IncidentRolesUpdateResultV1": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV1" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentsListResultV1": { "example": { "incidents": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "properties": { "incidents": { "example": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } ], "items": { "$ref": "#/components/schemas/IncidentV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV1" } }, "required": [ "incidents" ], "type": "object" }, "IncidentsCreatePayloadV1": { "example": { "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "idempotency_key": "alert-uuid", "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "mode": "real", "name": "Our database is sad", "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "slack_team_id": "T02A1FSLE8J", "source_message_channel_id": "C02AW36C1M5", "source_message_timestamp": "1653650280.526509", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "properties": { "custom_field_entries": { "description": "Set the incident's custom fields to these values", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryPayloadV1" }, "type": "array" }, "idempotency_key": { "description": "Unique string used to de-duplicate incident create requests", "example": "alert-uuid", "type": "string" }, "incident_role_assignments": { "description": "Assign incident roles to these people", "example": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentPayloadV1" }, "type": "array" }, "incident_type_id": { "description": "Incident type to create this incident as", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" }, "mode": { "description": "Whether the incident is real or test", "enum": [ "real", "test" ], "example": "real", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "severity_id": { "description": "Severity to create incident as", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" }, "slack_team_id": { "description": "ID of the Slack team / workspace. This is only required if you are using a Slack Enterprise Grid with multiple teams.", "example": "T02A1FSLE8J", "type": "string" }, "source_message_channel_id": { "description": "Channel ID of the source message, if this incident was created from one", "example": "C02AW36C1M5", "type": "string" }, "source_message_timestamp": { "description": "Timestamp of the source message, if this incident was created from one", "example": "1653650280.526509", "type": "string" }, "status": { "description": "Current status of the incident", "enum": [ "triage", "investigating", "fixing", "monitoring", "closed", "declined" ], "example": "triage", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" } }, "required": [ "idempotency_key", "visibility" ], "type": "object" }, "IncidentsCreateResultV1": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV1" } }, "required": [ "incident" ], "type": "object" }, "IncidentsShowResultV1": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV1" } }, "required": [ "incident" ], "type": "object" }, "ActionV1": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV1" }, "completed_at": { "description": "When the action was completed", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the action", "example": "Call the fire brigade", "type": "string" }, "external_issue_reference": { "$ref": "#/components/schemas/ExternalIssueReferenceV1" }, "follow_up": { "description": "Whether an action is marked as follow-up", "example": true, "type": "boolean" }, "id": { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the action belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "status": { "description": "Status of the action", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "status", "follow_up", "created_at", "updated_at" ], "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" }, "ActionV2": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV2" }, "completed_at": { "description": "When the action was completed", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV2" }, "description": { "description": "Description of the action", "example": "Call the fire brigade", "type": "string" }, "id": { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the action belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "status": { "description": "Status of the action", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "creator", "description", "status", "created_at", "updated_at" ], "type": "object" }, "AlertRouteSlimV2": { "example": { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" }, "properties": { "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "id": { "description": "Unique identifier for this alert route config", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" } }, "required": [ "id", "name", "enabled" ], "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" }, "AlertRouteAlertSourcePayloadV2": { "example": { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "properties": { "alert_source_id": { "description": "The alert source ID that will match for the route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "condition_groups": { "description": "What conditions should alerts from this source meet to be included in this alert route?", "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" } }, "required": [ "alert_source_id", "condition_groups" ], "type": "object" }, "AlertRouteChannelConfigPayloadV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } }, "properties": { "condition_groups": { "description": "The conditions that must be met for this channel config to be used", "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" }, "ms_teams_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetPayloadV2" }, "slack_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetPayloadV2" } }, "required": [ "condition_groups" ], "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" }, "AlertRouteEscalationConfigPayloadV2": { "example": { "auto_cancel_escalations": false, "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" } } } ] }, "properties": { "auto_cancel_escalations": { "description": "Should we auto cancel escalations when all alerts are resolved?", "example": false, "type": "boolean" }, "escalation_targets": { "description": "Targets for escalation", "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/AlertRouteEscalationTargetPayloadV2" }, "type": "array" } }, "required": [ "auto_cancel_escalations", "escalation_targets" ], "type": "object" }, "ExpressionPayloadV2": { "example": { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" }, "properties": { "else_branch": { "$ref": "#/components/schemas/ExpressionElseBranchPayloadV2" }, "label": { "description": "The human readable label of the expression", "example": "Team Slack channel", "type": "string" }, "operations": { "example": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "items": { "$ref": "#/components/schemas/ExpressionOperationPayloadV2" }, "type": "array" }, "reference": { "description": "A short ID that can be used to reference the expression", "example": "abc123", "type": "string" }, "root_reference": { "description": "The root reference for this expression (i.e. where the expression starts)", "example": "incident.status", "type": "string" } }, "required": [ "label", "reference", "root_reference", "operations" ], "type": "object" }, "AlertRouteIncidentConfigPayloadV2": { "example": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "properties": { "auto_decline_enabled": { "description": "Should triage incidents be declined when alerts are resolved?", "example": false, "type": "boolean" }, "auto_relate_grouped_alerts": { "description": "Should grouped alerts automatically be related to active incidents without confirmation?", "example": false, "type": "boolean" }, "condition_groups": { "description": "What condition groups must be true for this alert route to create an incident?", "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" }, "defer_time_seconds": { "description": "How long should the escalation defer time be?", "example": 1, "format": "int32", "type": "integer" }, "enabled": { "description": "Whether incident creation is enabled for this alert route", "example": false, "type": "boolean" }, "grouping_keys": { "description": "Which attributes should this alert route use to group alerts?", "example": [ { "reference": "alert.title" } ], "items": { "$ref": "#/components/schemas/GroupingKeyV2" }, "type": "array" }, "grouping_window_seconds": { "description": "How large should the grouping window be?", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "auto_decline_enabled", "enabled", "condition_groups", "grouping_keys", "grouping_window_seconds", "defer_time_seconds" ], "type": "object" }, "AlertRouteIncidentTemplatePayloadV2": { "example": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "custom_fields": { "description": "Custom fields configuration", "example": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "items": { "$ref": "#/components/schemas/AlertRouteCustomFieldBindingPayloadV2" }, "type": "array" }, "incident_mode": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" }, "incident_type": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" }, "membership_teams": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" }, "name": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingPayloadV2" }, "severity": { "$ref": "#/components/schemas/AlertRouteSeverityBindingPayloadV2" }, "start_in_triage": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" }, "summary": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingPayloadV2" }, "workspace": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" } }, "required": [ "name" ], "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" }, "AlertRouteV2": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] } ], "channel_config": [ { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "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" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "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" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "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" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "properties": { "alert_sources": { "description": "Which alert sources should this alert route match?", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] } ], "items": { "$ref": "#/components/schemas/AlertRouteAlertSourceV2" }, "type": "array" }, "channel_config": { "description": "The channel configuration for this alert route", "example": [ { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "items": { "$ref": "#/components/schemas/AlertRouteChannelConfigV2" }, "type": "array" }, "condition_groups": { "description": "What condition groups must be true for this alert route to fire?", "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" }, "created_at": { "description": "The time of creation of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigV2" }, "expressions": { "description": "The expressions used in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "id": { "description": "Unique identifier for this alert route config", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigV2" }, "incident_template": { "$ref": "#/components/schemas/AlertRouteIncidentTemplateV2" }, "is_private": { "description": "Whether this alert route is private. Private alert routes will only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_template": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "updated_at": { "description": "The time of last update of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The version of this alert route config", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "condition_groups", "expressions", "is_private", "enabled", "escalation_config", "incident_config", "incident_template", "alert_sources", "channel_config", "version" ], "type": "object" }, "CatalogEntryV2": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "archived_at": { "description": "When this entry was archived", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingV2" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "type": "object" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "created_at": { "description": "When this entry was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "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" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" }, "updated_at": { "description": "When this entry was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "catalog_type_id", "name", "aliases", "rank", "attribute_values", "created_at", "updated_at" ], "type": "object" }, "CatalogTypeV2": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "custom", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "created_at": { "description": "When this type was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "dynamic_resource_parameter": { "description": "If this is a dynamic catalog type, this will be the unique parameter for identitfying this resource externally.", "example": "abc123", "type": "string" }, "estimated_count": { "description": "If populated, gives an estimated count of entries for this type", "example": 7, "format": "int64", "type": "integer" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "incident-template", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_editable": { "description": "Catalog types that are synced with external resources can't be edited", "example": false, "type": "boolean" }, "last_synced_at": { "description": "When this type was last synced (if it's ever been sync'd)", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "registry_type": { "description": "The registry resource this type is synced from, if any", "example": "PagerDutyService", "type": "string" }, "required_integrations": { "description": "If populated, the integrations required for this type", "example": [ "pager_duty" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "schema": { "$ref": "#/components/schemas/CatalogTypeSchemaV2" }, "semantic_type": { "description": "This type has been deprecated, and will always be empty.", "example": "abc123", "type": "string", "x-public-api-version": "v2" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "type_name": { "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName\"]", "example": "Custom[\"BackstageGroup\"]", "type": "string" }, "updated_at": { "description": "When this type was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "type_name", "semantic_type", "ranked", "schema", "icon", "categories", "color", "is_editable", "annotations", "created_at", "updated_at" ], "type": "object" }, "CatalogResourceV2": { "example": { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "Custom[\"Team\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website" }, "properties": { "category": { "description": "Which category of resource", "enum": [ "primitive", "custom", "external" ], "example": "custom", "type": "string" }, "description": { "description": "Human readable description for this resource", "example": "Boolean true or false value", "type": "string" }, "label": { "description": "Label for this catalog resource type", "example": "GitHub Repository", "type": "string" }, "type": { "description": "Catalog type name for this resource, as used when setting the type of a catalog type attribute", "example": "Custom[\"Team\"]", "type": "string" }, "value_docstring": { "description": "Documentation for the literal string value of this resource", "example": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website", "type": "string" } }, "required": [ "type", "label", "description", "value_docstring", "category" ], "type": "object" }, "CatalogTypeAttributePayloadV2": { "example": { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "backlink_attribute": { "description": "The attribute to use (if this is a backlink)", "example": "abc123", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "mode": { "description": "Controls how this attribute is modified", "enum": [ "", "manual", "external", "internal", "dynamic", "backlink", "path" ], "example": "", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "Unique name of this attribute", "example": "tier", "type": "string" }, "path": { "description": "The path to use (if this is an path)", "example": [ { "attribute_id": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePathItemPayloadV2" }, "type": "array" }, "type": { "description": "Catalog type name for this attribute", "example": "Custom[\"Service\"]", "type": "string" } }, "required": [ "name", "type", "array" ], "type": "object" }, "CustomFieldV1": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "catalog_type_id": { "description": "For catalog fields, the ID of the associated catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "id": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "options": { "description": "What options are available for this custom field, if this field has options", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "items": { "$ref": "#/components/schemas/CustomFieldOptionV1" }, "type": "array" }, "required": { "description": "When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].", "enum": [ "never", "before_closure", "always" ], "example": "never", "type": "string" }, "required_v2": { "description": "When this custom field must be set during the incident lifecycle.", "enum": [ "never", "before_resolution", "always" ], "example": "never", "type": "string" }, "show_before_closure": { "description": "Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.", "example": true, "type": "boolean" }, "show_before_creation": { "description": "Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.", "example": true, "type": "boolean" }, "show_before_update": { "description": "Whether a custom field should be shown in the incident update modal.", "example": true, "type": "boolean" }, "show_in_announcement_post": { "description": "Whether a custom field should be shown in the list of fields as part of the announcement post when set.", "example": true, "type": "boolean" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "field_type", "show_before_creation", "show_before_closure", "show_before_update", "options", "created_at", "updated_at" ], "type": "object" }, "FollowUpV2": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "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" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV2" }, "assignee_team": { "$ref": "#/components/schemas/TeamSlimV2" }, "completed_at": { "description": "When the follow-up was completed", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the follow-up was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV2" }, "description": { "description": "Description of the follow-up", "example": "Call the fire brigade", "type": "string" }, "external_issue_reference": { "$ref": "#/components/schemas/ExternalIssueReferenceV2" }, "id": { "description": "Unique identifier for the follow-up", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the follow-up belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "labels": { "description": "Labels associated with this follow-up", "example": [ "bug", "urgent" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "priority": { "$ref": "#/components/schemas/FollowUpPriorityV2" }, "status": { "description": "Status of the follow-up", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "title": { "description": "Title of the follow-up", "example": "Cat is stuck in the tree", "type": "string" }, "updated_at": { "description": "When the follow-up was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "creator", "title", "status", "labels", "created_at", "updated_at" ], "type": "object" }, "IncidentRoleV1": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When the role was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "required": { "description": "DEPRECATED: this will always be false.", "example": false, "type": "boolean" }, "role_type": { "description": "Type of incident role", "enum": [ "lead", "reporter", "custom" ], "example": "lead", "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" }, "updated_at": { "description": "When the role was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions", "id", "role_type", "created_at", "updated_at" ], "type": "object" }, "IncidentV1": { "example": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" }, "properties": { "call_url": { "description": "The call URL attached to this incident", "example": "https://zoom.us/foo", "type": "string" }, "created_at": { "description": "When the incident was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV1" }, "custom_field_entries": { "description": "Custom field entries for this incident", "example": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryV1" }, "type": "array" }, "id": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" }, "incident_role_assignments": { "description": "A list of who is assigned to each role for this incident", "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentV1" }, "type": "array" }, "incident_type": { "$ref": "#/components/schemas/IncidentTypeV1" }, "mode": { "description": "Whether the incident is real, a test, a tutorial, or importing as a retrospective incident", "enum": [ "real", "test", "tutorial" ], "example": "real", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "permalink": { "description": "A permanent link to the homepage for this incident", "example": "https://app.incident.io/incidents/123", "type": "string" }, "postmortem_document_url": { "description": "The URL of the incident post-mortem document", "example": "https://docs.google.com/my_doc_id", "type": "string" }, "reference": { "description": "Reference to this incident, as displayed across the product", "example": "INC-123", "type": "string" }, "severity": { "$ref": "#/components/schemas/SeverityV1" }, "slack_channel_id": { "description": "ID of the Slack channel in the organisation Slack workspace. Note that the channel is sometimes created asynchronously, so may not be present when the incident is just created.", "example": "C02AW36C1M5", "type": "string" }, "slack_channel_name": { "description": "Name of the slack channel", "example": "inc-165-green-parrot", "type": "string" }, "slack_team_id": { "description": "ID of the Slack team / workspace. This is only required if you are using a Slack Enterprise Grid with multiple teams.", "example": "T02A1FSLE8J", "type": "string" }, "status": { "description": "Current status of the incident", "enum": [ "triage", "investigating", "fixing", "monitoring", "closed", "declined" ], "example": "triage", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "timestamps": { "description": "Incident lifecycle events and when they last occurred", "example": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "items": { "$ref": "#/components/schemas/IncidentTimestampValueV1" }, "type": "array" }, "updated_at": { "description": "When the incident was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" } }, "required": [ "status", "id", "reference", "name", "visibility", "mode", "creator", "incident_role_assignments", "custom_field_entries", "slack_team_id", "slack_channel_id", "created_at", "updated_at" ], "type": "object" }, "PaginationMetaResultWithTotalV1": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "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" }, "total_record_count": { "description": "How many matching records were there in total, if known", "example": 238, "format": "int64", "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "CustomFieldEntryPayloadV1": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] }, "properties": { "custom_field_id": { "description": "ID of the custom field this entry is linked against", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "values": { "description": "List of values to associate with this entry. Use an empty array to unset the value of the custom field.", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ], "items": { "$ref": "#/components/schemas/CustomFieldValuePayloadV1" }, "type": "array" } }, "required": [ "custom_field_id", "values" ], "type": "object" }, "IncidentRoleAssignmentPayloadV1": { "example": { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserReferencePayloadV1" }, "incident_role_id": { "description": "Unique ID of an incident role. Note that the 'reporter' role can only be assigned when creating an incident.", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" } }, "required": [ "incident_role_id", "assignee" ], "type": "object" }, "UserV1": { "example": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "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": "viewer", "type": "string" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "role", "id", "name" ], "type": "object" }, "ExternalIssueReferenceV1": { "example": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "properties": { "issue_name": { "description": "Human readable ID for the issue", "example": "INC-123", "type": "string" }, "issue_permalink": { "description": "URL linking directly to the action in the issue tracker", "example": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "type": "string" }, "provider": { "description": "ID of the issue tracker provider", "enum": [ "asana", "azure_devops", "click_up", "freshservice", "linear", "jira", "salesforce", "jira_server", "github", "gitlab", "service_now", "shortcut", "notion" ], "example": "asana", "type": "string" } }, "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" }, "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" }, "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" }, "AlertRouteChannelTargetPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "channel_visibility": { "description": "The visibility of the channel", "example": "abc123", "type": "string" } }, "required": [ "binding", "channel_visibility" ], "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" }, "AlertRouteEscalationTargetPayloadV2": { "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" }, "ExpressionElseBranchPayloadV2": { "example": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "result": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "required": [ "result" ], "type": "object" }, "ExpressionOperationPayloadV2": { "example": { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } }, "properties": { "branches": { "$ref": "#/components/schemas/ExpressionBranchesOptsPayloadV2" }, "cast": { "$ref": "#/components/schemas/ExpressionCastOptsPayloadV2" }, "concatenate": { "$ref": "#/components/schemas/ExpressionConcatenateOptsPayloadV2" }, "filter": { "$ref": "#/components/schemas/ExpressionFilterOptsPayloadV2" }, "navigate": { "$ref": "#/components/schemas/ExpressionNavigateOptsPayloadV2" }, "operation_type": { "description": "The type of the operation", "enum": [ "navigate", "filter", "concatenate", "count", "min", "max", "sum", "random", "first", "parse", "branches", "cast" ], "example": "navigate", "type": "string" }, "parse": { "$ref": "#/components/schemas/ExpressionParseOptsPayloadV2" } }, "required": [ "operation_type" ], "type": "object" }, "GroupingKeyV2": { "example": { "reference": "alert.title" }, "properties": { "reference": { "description": "A reference to a property of the alert to group on", "example": "alert.title", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "AlertRouteCustomFieldBindingPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "custom_field_id": { "description": "ID of the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merge_strategy": { "description": "The strategy to use when multiple alerts match this route", "enum": [ "first-wins", "last-wins", "append" ], "example": "first-wins", "type": "string" } }, "required": [ "custom_field_id", "binding", "merge_strategy" ], "type": "object" }, "AlertRouteTemplateBindingPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "type": "object" }, "AlertRouteAutoGeneratedTemplateBindingPayloadV2": { "example": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "autogenerated": { "description": "Whether this attribute is autogenerated using AI or not", "example": false, "type": "boolean" }, "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "type": "object" }, "AlertRouteSeverityBindingPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "merge_strategy": { "description": "Strategy for merging severity when multiple alerts create/update the same incident", "enum": [ "first-wins", "max" ], "example": "first-wins", "type": "string" } }, "required": [ "merge_strategy" ], "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" }, "AlertRouteAlertSourceV2": { "example": { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } ] } ] }, "properties": { "alert_source_id": { "description": "The alert source ID that will match for the route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "condition_groups": { "description": "What conditions should alerts from this source meet to be included in this alert route?", "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" } }, "required": [ "alert_source_id", "condition_groups" ], "type": "object" }, "AlertRouteChannelConfigV2": { "example": { "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" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } }, "properties": { "condition_groups": { "description": "The conditions that must be met for this channel config to be used", "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" }, "ms_teams_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetV2" }, "slack_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetV2" } }, "required": [ "condition_groups" ], "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" }, "AlertRouteEscalationConfigV2": { "example": { "auto_cancel_escalations": false, "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" } } } ] }, "properties": { "auto_cancel_escalations": { "description": "Should we auto cancel escalations when all alerts are resolved?", "example": false, "type": "boolean" }, "escalation_targets": { "description": "Targets for escalation", "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/AlertRouteEscalationTargetV2" }, "type": "array" } }, "required": [ "auto_cancel_escalations", "escalation_targets" ], "type": "object" }, "ExpressionV2": { "example": { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" }, "properties": { "else_branch": { "$ref": "#/components/schemas/ExpressionElseBranchV2" }, "label": { "description": "The human readable label of the expression", "example": "Team Slack channel", "type": "string" }, "operations": { "example": [ { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "items": { "$ref": "#/components/schemas/ExpressionOperationV2" }, "type": "array" }, "reference": { "description": "A short ID that can be used to reference the expression", "example": "abc123", "type": "string" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "root_reference": { "description": "The root reference for this expression (i.e. where the expression starts)", "example": "incident.status", "type": "string" } }, "required": [ "label", "reference", "returns", "root_reference", "operations" ], "type": "object" }, "AlertRouteIncidentConfigV2": { "example": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "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" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "properties": { "auto_decline_enabled": { "description": "Should triage incidents be declined when alerts are resolved?", "example": false, "type": "boolean" }, "auto_relate_grouped_alerts": { "description": "Should grouped alerts automatically be related to active incidents without confirmation?", "example": false, "type": "boolean" }, "condition_groups": { "description": "What condition groups must be true for this alert route to create an incident?", "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" }, "defer_time_seconds": { "description": "How long should the escalation defer time be?", "example": 1, "format": "int32", "type": "integer" }, "enabled": { "description": "Whether incident creation is enabled for this alert route", "example": false, "type": "boolean" }, "grouping_keys": { "description": "Which attributes should this alert route use to group alerts?", "example": [ { "reference": "alert.title" } ], "items": { "$ref": "#/components/schemas/GroupingKeyV2" }, "type": "array" }, "grouping_window_seconds": { "description": "How large should the grouping window be?", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "auto_decline_enabled", "enabled", "condition_groups", "grouping_keys", "grouping_window_seconds", "defer_time_seconds", "auto_relate_grouped_alerts" ], "type": "object" }, "AlertRouteIncidentTemplateV2": { "example": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "custom_fields": { "description": "Custom fields configuration", "example": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "items": { "$ref": "#/components/schemas/AlertRouteCustomFieldBindingV2" }, "type": "array" }, "incident_mode": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" }, "incident_type": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" }, "membership_teams": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" }, "name": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingV2" }, "severity": { "$ref": "#/components/schemas/AlertRouteSeverityBindingV2" }, "start_in_triage": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" }, "summary": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingV2" }, "workspace": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" } }, "required": [ "name" ], "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" }, "CatalogEntryEngineParamBindingV2": { "example": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } }, "properties": { "array_value": { "description": "If array_value is set, this helps render the values", "example": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingValueV2" }, "type": "array" }, "value": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingValueV2" } }, "type": "object" }, "CatalogTypeSchemaV2": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "properties": { "attributes": { "description": "Attributes of this catalog type", "example": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributeV2" }, "type": "array" }, "version": { "description": "The version number of this schema", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "attributes", "version" ], "type": "object" }, "CatalogTypeAttributePathItemPayloadV2": { "example": { "attribute_id": "abc123" }, "properties": { "attribute_id": { "description": "the ID of the attribute to use", "example": "abc123", "type": "string" } }, "required": [ "attribute_id" ], "type": "object" }, "CustomFieldOptionV1": { "properties": { "custom_field_id": { "description": "ID of the custom field this option belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "id": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "sort_key": { "default": 1000, "description": "Sort key used to order the custom field options correctly", "example": 10, "format": "int64", "type": "integer" }, "value": { "description": "Human readable name for the custom field option. Values must not start or end with whitespace, or contain tabs or newlines.", "example": "Product", "type": "string" } }, "required": [ "id", "custom_field_id", "value", "sort_key" ], "type": "object" }, "TeamSlimV2": { "example": { "id": "abc123", "name": "abc123" }, "properties": { "id": { "description": "Unique ID of the team", "example": "abc123", "type": "string" }, "name": { "description": "Name of the team", "example": "abc123", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "ExternalIssueReferenceV2": { "example": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "properties": { "issue_name": { "description": "Human readable ID for the issue", "example": "INC-123", "type": "string" }, "issue_permalink": { "description": "URL linking directly to the action in the issue tracker", "example": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "type": "string" }, "provider": { "description": "ID of the issue tracker provider", "enum": [ "asana", "azure_devops", "click_up", "freshservice", "linear", "jira", "salesforce", "jira_server", "github", "gitlab", "service_now", "shortcut", "notion" ], "example": "asana", "type": "string" } }, "required": [ "provider", "issue_name", "issue_permalink" ], "type": "object" }, "FollowUpPriorityV2": { "example": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "properties": { "description": { "description": "Description of the follow-up priority option", "example": "A follow-up that requires immediate attention.", "type": "string" }, "id": { "description": "Unique identifier for the follow-up priority option", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "name": { "description": "Name of the follow-up priority option", "example": "Urgent", "type": "string" }, "rank": { "description": "Rank is used to order the follow-up priority options correctly", "example": 10, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "rank" ], "type": "object" }, "ActorV1": { "example": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyActorV1" }, "user": { "$ref": "#/components/schemas/UserV1" } }, "type": "object" }, "CustomFieldEntryV1": { "example": { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldTypeInfoV1" }, "values": { "description": "List of custom field values set on this entry", "example": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ], "items": { "$ref": "#/components/schemas/CustomFieldValueV1" }, "type": "array" } }, "required": [ "custom_field", "values" ], "type": "object" }, "IncidentRoleAssignmentV1": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV1" }, "role": { "$ref": "#/components/schemas/IncidentRoleV1" } }, "required": [ "role" ], "type": "object" }, "IncidentTypeV1": { "properties": { "create_in_triage": { "description": "Whether incidents of this must always, or can optionally, be created in triage", "enum": [ "always", "optional" ], "example": "always", "type": "string" }, "created_at": { "description": "When this resource was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "What is this incident type for?", "example": "Customer facing production outages", "type": "string" }, "id": { "description": "Unique identifier for this Incident Type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_default": { "description": "The default Incident Type is used when no other type is explicitly specified", "example": false, "type": "boolean" }, "name": { "description": "The name of this Incident Type", "example": "Production Outage", "type": "string" }, "owning_team_ids": { "description": "IDs of the teams that own this incident type", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "type": "array" }, "private_incidents_only": { "description": "Should all incidents created with this Incident Type be private?", "example": false, "type": "boolean" }, "updated_at": { "description": "When this resource was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "is_default", "description", "private_incidents_only", "created_at", "updated_at", "create_in_triage" ], "type": "object" }, "SeverityV1": { "properties": { "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the severity", "example": "Issues with **low impact**.", "type": "string" }, "id": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name of the severity", "example": "Minor", "maxLength": 50, "type": "string" }, "rank": { "description": "Rank to help sort severities (lower numbers are less severe)", "example": 1, "format": "int64", "type": "integer" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "rank", "created_at", "updated_at", "id", "name", "description" ], "type": "object" }, "IncidentTimestampValueV1": { "example": { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" }, "properties": { "last_occurred_at": { "description": "When this last occurred, if it did", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "name": { "description": "Name of the lifecycle event", "example": "last_activity", "type": "string" } }, "required": [ "name" ], "type": "object" }, "CustomFieldValuePayloadV1": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" }, "properties": { "id": { "description": "Unique identifier for the custom field value", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_catalog_entry_id": { "description": "ID of the catalog entry. You can also use an ExternalID or an Alias of the catalog entry.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_link": { "description": "If the custom field type is 'link', this will contain the value assigned.", "example": "https://google.com/", "type": "string" }, "value_numeric": { "description": "If the custom field type is 'numeric', this will contain the value assigned.", "example": "123.456", "type": "string" }, "value_option_id": { "description": "ID of the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_text": { "description": "If the custom field type is 'text', this will contain the value assigned.", "example": "This is my text field, I hope you like it", "type": "string" }, "value_timestamp": { "description": "Deprecated: please use incident timestamp values instead", "example": "", "type": "string" } }, "type": "object" }, "UserReferencePayloadV1": { "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" }, "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" }, "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" }, "ExpressionBranchesOptsPayloadV2": { "example": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "description": "The branches to apply for this operation", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/ExpressionBranchPayloadV2" }, "type": "array" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "branches", "returns" ], "type": "object" }, "ExpressionCastOptsPayloadV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "returns" ], "type": "object" }, "ExpressionConcatenateOptsPayloadV2": { "example": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "properties": { "reference": { "description": "The reference that you want to concatenate with", "example": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "ExpressionFilterOptsPayloadV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "properties": { "condition_groups": { "description": "The condition groups to apply in this filter. Only one group needs to be satisfied for the filter to pass.", "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" } }, "required": [ "condition_groups" ], "type": "object" }, "ExpressionNavigateOptsPayloadV2": { "example": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "properties": { "reference": { "description": "The reference that you want to navigate to", "example": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "ExpressionParseOptsPayloadV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "source": { "description": "Source expression that is evaluated to a result", "example": "metadata.annotations[\"github.com/repo\"]", "type": "string" } }, "required": [ "source", "returns" ], "type": "object" }, "AlertRouteChannelTargetV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "channel_visibility": { "description": "The visibility of the channel", "example": "abc123", "type": "string" } }, "required": [ "binding", "channel_visibility" ], "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" }, "AlertRouteEscalationTargetV2": { "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" }, "ExpressionElseBranchV2": { "example": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "result": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "result" ], "type": "object" }, "ExpressionOperationV2": { "example": { "branches": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "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" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "$ref": "#/components/schemas/ExpressionBranchesOptsV2" }, "cast": { "$ref": "#/components/schemas/ExpressionCastOptsV2" }, "concatenate": { "$ref": "#/components/schemas/ExpressionConcatenateOptsV2" }, "filter": { "$ref": "#/components/schemas/ExpressionFilterOptsV2" }, "navigate": { "$ref": "#/components/schemas/ExpressionNavigateOptsV2" }, "operation_type": { "description": "The type of the operation", "enum": [ "navigate", "filter", "concatenate", "count", "min", "max", "sum", "random", "first", "parse", "branches", "cast" ], "example": "navigate", "type": "string" }, "parse": { "$ref": "#/components/schemas/ExpressionParseOptsV2" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "operation_type", "returns" ], "type": "object" }, "ReturnsMetaV2": { "example": { "array": true, "type": "IncidentStatus" }, "properties": { "array": { "description": "Whether the return value should be single or multi-value", "example": true, "type": "boolean" }, "type": { "description": "Expected return type of this expression (what to try casting the result to)", "example": "IncidentStatus", "type": "string" } }, "required": [ "type", "array" ], "type": "object" }, "AlertRouteCustomFieldBindingV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "custom_field_id": { "description": "ID of the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merge_strategy": { "description": "The strategy to use when multiple alerts match this route", "enum": [ "first-wins", "last-wins", "append" ], "example": "first-wins", "type": "string" } }, "required": [ "custom_field_id", "binding", "merge_strategy" ], "type": "object" }, "AlertRouteTemplateBindingV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "type": "object" }, "AlertRouteAutoGeneratedTemplateBindingV2": { "example": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "autogenerated": { "description": "Whether this attribute is autogenerated using AI or not", "example": false, "type": "boolean" }, "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "autogenerated" ], "type": "object" }, "AlertRouteSeverityBindingV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "merge_strategy": { "description": "Strategy for merging severity when multiple alerts create/update the same incident", "enum": [ "first-wins", "max" ], "example": "first-wins", "type": "string" } }, "required": [ "merge_strategy" ], "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" }, "CatalogEntryEngineParamBindingValueV2": { "example": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryReferenceV2" }, "helptext": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "abc123", "type": "string" }, "image_url": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "abc123", "type": "string" }, "is_image_slack_icon": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": false, "type": "boolean" }, "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": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "incident.severity", "type": "string" }, "sort_key": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "abc123", "type": "string" }, "unavailable": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": false, "type": "boolean" }, "value": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "abc123", "type": "string" } }, "required": [ "label", "sort_key" ], "type": "object" }, "CatalogTypeAttributeV2": { "example": { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "backlink_attribute": { "description": "The attribute to use (if this is a backlink)", "example": "abc123", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "mode": { "description": "Controls how this attribute is modified", "enum": [ "", "manual", "external", "internal", "dynamic", "backlink", "path" ], "example": "", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "Unique name of this attribute", "example": "tier", "type": "string" }, "path": { "description": "The path to use (if this is a path attribute)", "example": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePathItemV2" }, "type": "array" }, "type": { "description": "Catalog type name for this attribute", "example": "Custom[\"Service\"]", "type": "string" } }, "required": [ "id", "mode", "name", "type", "array" ], "type": "object" }, "APIKeyActorV1": { "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" }, "CustomFieldTypeInfoV1": { "example": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "id": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "options": { "description": "What options are available for this custom field, if this field has options", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "items": { "$ref": "#/components/schemas/CustomFieldOptionV1" }, "type": "array" } }, "required": [ "id", "name", "description", "field_type", "options" ], "type": "object" }, "CustomFieldValueV1": { "example": { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" }, "properties": { "value_catalog_entry": { "$ref": "#/components/schemas/EmbeddedCatalogEntryV1" }, "value_link": { "description": "If the custom field type is 'link', this will contain the value assigned.", "example": "https://google.com/", "type": "string" }, "value_numeric": { "description": "If the custom field type is 'numeric', this will contain the value assigned.", "example": "123.456", "type": "string" }, "value_option": { "$ref": "#/components/schemas/CustomFieldOptionV1" }, "value_text": { "description": "If the custom field type is 'text', this will contain the value assigned.", "example": "This is my text field, I hope you like it", "type": "string" } }, "type": "object" }, "ExpressionBranchPayloadV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "condition_groups": { "description": "When one of these condition groups are satisfied, this branch will be evaluated", "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" }, "result": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "required": [ "condition_groups", "result" ], "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" }, "ExpressionBranchesOptsV2": { "example": { "branches": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "description": "The branches to apply for this operation", "example": [ { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/ExpressionBranchV2" }, "type": "array" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "branches", "returns" ], "type": "object" }, "ExpressionCastOptsV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "returns" ], "type": "object" }, "ExpressionConcatenateOptsV2": { "example": { "reference": "1235", "reference_label": "Teams" }, "properties": { "reference": { "description": "The reference within the scope to concatenate with", "example": "1235", "type": "string" }, "reference_label": { "description": "The name of the reference to concatenate with", "example": "Teams", "type": "string" } }, "required": [ "reference", "reference_label" ], "type": "object" }, "ExpressionFilterOptsV2": { "example": { "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" } } ] } ] }, "properties": { "condition_groups": { "description": "The condition groups to apply in this filter. Only one group needs to be satisfied for the filter to pass.", "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" } }, "required": [ "condition_groups" ], "type": "object" }, "ExpressionNavigateOptsV2": { "example": { "reference": "1235", "reference_label": "Teams" }, "properties": { "reference": { "description": "The reference within the scope to navigate to", "example": "1235", "type": "string" }, "reference_label": { "description": "The name of the reference to navigate to", "example": "Teams", "type": "string" } }, "required": [ "reference", "reference_label" ], "type": "object" }, "ExpressionParseOptsV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "source": { "description": "Source expression that is evaluated to a result", "example": "metadata.annotations[\"github.com/repo\"]", "type": "string" } }, "required": [ "source", "returns" ], "type": "object" }, "CatalogEntryReferenceV2": { "example": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "archived_at": { "description": "When this entry was archived", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "catalog_entry_id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "catalog_entry_name": { "description": "The name of this entry", "example": "Primary escalation", "type": "string" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "catalog_type_id", "catalog_entry_id", "catalog_entry_name" ], "type": "object" }, "CatalogTypeAttributePathItemV2": { "example": { "attribute_id": "abc123", "attribute_name": "abc123" }, "properties": { "attribute_id": { "description": "the ID of the attribute to use", "example": "abc123", "type": "string" }, "attribute_name": { "description": "the name of the attribute to use", "example": "abc123", "type": "string" } }, "required": [ "attribute_id", "attribute_name" ], "type": "object" }, "EmbeddedCatalogEntryV1": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "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", "name" ], "type": "object" }, "ExpressionBranchV2": { "example": { "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" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "condition_groups": { "description": "When one of these condition groups are satisfied, this branch will be evaluated", "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" }, "result": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "condition_groups", "result" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key from your incident.io dashboard (Settings → API keys)" } } } }