> ## Documentation Index > Fetch the complete documentation index at: https://docs.incident.io/llms.txt > Use this file to discover all available pages before exploring further. # Update > Update an existing policy. The policy_type of an existing policy cannot be changed: sending a different type is rejected. Create a new policy instead. 🔑 Requires the `policies.create` scope. ## OpenAPI ````yaml /openapi/tags/policies-v2.json put /v2/policies/{id} 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 the policies that encode how your organisation should handle incidents. A policy scopes itself to a set of resources with conditions, states the requirements those resources must meet, and describes who to chase when they don't. Every policy has a policy_type, which selects exactly one matching configuration block: a follow_up policy carries follow_up config, a schedule policy carries schedule config, and so on. Sending a block that doesn't match the policy type is rejected. name: Policies V2 paths: /v2/policies/{id}: put: tags: - Policies V2 summary: Update description: > Update an existing policy. The policy_type of an existing policy cannot be changed: sending a different type is rejected. Create a new policy instead. operationId: Policies V2_Update parameters: - description: Unique identifier for the policy example: 01FCNDV6P870EA6S7TK1DSYDG0 in: path name: id required: true schema: description: Unique identifier for the policy example: 01FCNDV6P870EA6S7TK1DSYDG0 type: string requestBody: content: application/json: example: assignment_rules: bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity reminder_detected_date_offset_hours: - 0 - 48 reminder_due_date_offset_hours: - -24 - 0 - 24 conditions: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity debrief: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false description: >- All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure. 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 follow_up: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false name: Critical incidents must export follow-ups on_call_readiness: enforcement: advisory high_urgency: - max_delay_seconds: 300 method_types: - slack low_urgency: - max_delay_seconds: 300 method_types: - slack policy_type: follow_up post_mortem: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false schedule: evaluation_level: schedule requirement_type: contiguous status: enabled schema: $ref: '#/components/schemas/PoliciesUpdatePayloadV2' required: true responses: '200': content: application/json: example: policy: assignment_rules: bindings: - array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity reminder_detected_date_offset_hours: - 0 - 48 reminder_due_date_offset_hours: - -24 - 0 - 24 conditions: - 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' debrief: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false description: >- All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure. 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 follow_up: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false id: 01G0J1EXE7AXZ2C93K61WBPYEH name: Critical incidents must export follow-ups on_call_readiness: enforcement: advisory high_urgency: - max_delay_seconds: 300 method_types: - slack low_urgency: - max_delay_seconds: 300 method_types: - slack policy_type: follow_up post_mortem: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false schedule: evaluation_level: schedule requirement_type: contiguous status: enabled updated_at: '2021-08-17T13:28:57.801578Z' schema: $ref: '#/components/schemas/PoliciesUpdateResultV2' 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. client_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. rate_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.' components: schemas: PoliciesUpdatePayloadV2: example: assignment_rules: bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity reminder_detected_date_offset_hours: - 0 - 48 reminder_due_date_offset_hours: - -24 - 0 - 24 conditions: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity debrief: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false description: >- All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure. 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 follow_up: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false name: Critical incidents must export follow-ups on_call_readiness: enforcement: advisory high_urgency: - max_delay_seconds: 300 method_types: - slack low_urgency: - max_delay_seconds: 300 method_types: - slack policy_type: follow_up post_mortem: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false schedule: evaluation_level: schedule requirement_type: contiguous status: enabled properties: assignment_rules: $ref: '#/components/schemas/PolicyAssignmentRulesPayloadV2' conditions: description: >- Conditions which determine which resources are in scope for this policy 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 debrief: $ref: '#/components/schemas/PolicyDebriefPayloadV2' description: description: Human readable description of the policy example: >- All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure. type: string expressions: description: The expressions to use in this policy 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 follow_up: $ref: '#/components/schemas/PolicyFollowUpPayloadV2' name: description: Human readable name of the policy example: Critical incidents must export follow-ups type: string on_call_readiness: $ref: '#/components/schemas/PolicyOnCallReadinessV2' policy_type: description: >- Type of the policy, specifying what this applies to. Cannot be changed after the policy is created. enum: - debrief - follow_up - on_call_readiness - post_mortem - schedule - vacation_conflict example: follow_up type: string post_mortem: $ref: '#/components/schemas/PolicyPostMortemPayloadV2' schedule: $ref: '#/components/schemas/PolicyScheduleV2' status: description: >- Defaults to enabled on create. Settable on update — there is no separate disable endpoint. enum: - enabled - disabled example: enabled type: string required: - name - description - policy_type - conditions type: object PoliciesUpdateResultV2: example: policy: assignment_rules: bindings: - array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity reminder_detected_date_offset_hours: - 0 - 48 reminder_due_date_offset_hours: - -24 - 0 - 24 conditions: - 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' debrief: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false description: >- All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure. 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 follow_up: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false id: 01G0J1EXE7AXZ2C93K61WBPYEH name: Critical incidents must export follow-ups on_call_readiness: enforcement: advisory high_urgency: - max_delay_seconds: 300 method_types: - slack low_urgency: - max_delay_seconds: 300 method_types: - slack policy_type: follow_up post_mortem: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false schedule: evaluation_level: schedule requirement_type: contiguous status: enabled updated_at: '2021-08-17T13:28:57.801578Z' properties: policy: $ref: '#/components/schemas/PolicyV2' required: - policy 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 PolicyAssignmentRulesPayloadV2: example: bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity reminder_detected_date_offset_hours: - 0 - 48 reminder_due_date_offset_hours: - -24 - 0 - 24 properties: bindings: description: >- Bindings which define the user to be assigned. We will assign the first user which evaluates; the rest are fallback values example: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity items: $ref: '#/components/schemas/EngineParamBindingPayloadV2' type: array reminder_detected_date_offset_hours: description: >- List of hours relative to when the violation was detected to remind the assignee. Non-negative only; 0 means immediately on detection. Only valid for policy types that support detection reminders (e.g. schedule). example: - 0 - 48 items: example: 1 format: int64 type: integer type: array reminder_due_date_offset_hours: description: >- List of hours relative to the due date to remind the assignee. Negative values are before the due date, positive after. example: - -24 - 0 - 24 items: example: 1 format: int64 type: integer type: array required: - bindings - reminder_due_date_offset_hours 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 PolicyDebriefPayloadV2: description: Set when policy_type is debrief. example: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false properties: due_date_config: $ref: '#/components/schemas/PolicyDueDateConfigPayloadV2' requirements: description: Conditions a debrief must satisfy to be compliant 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 run_on_private_incidents: description: Requires the policies.run_on_private scope example: false type: boolean required: - requirements 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 PolicyFollowUpPayloadV2: description: Set when policy_type is follow_up. example: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false properties: due_date_config: $ref: '#/components/schemas/PolicyDueDateConfigPayloadV2' requirements: description: >- Conditions a follow-up must satisfy to be compliant, e.g. 'is exported to Jira' 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 run_on_private_incidents: description: Requires the policies.run_on_private scope example: false type: boolean required: - requirements type: object PolicyOnCallReadinessV2: description: >- Set when policy_type is on_call_readiness. The assignee is always the user in violation and cannot be configured. example: enforcement: advisory high_urgency: - max_delay_seconds: 300 method_types: - slack low_urgency: - max_delay_seconds: 300 method_types: - slack properties: enforcement: description: >- advisory reports only; blocking also prevents users saving non-compliant notification rules. Defaults to advisory. enum: - advisory - blocking example: advisory type: string high_urgency: example: - max_delay_seconds: 300 method_types: - slack items: $ref: '#/components/schemas/PolicyReadinessRuleV2' type: array low_urgency: example: - max_delay_seconds: 300 method_types: - slack items: $ref: '#/components/schemas/PolicyReadinessRuleV2' type: array type: object PolicyPostMortemPayloadV2: description: Set when policy_type is post_mortem. example: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity run_on_private_incidents: false properties: due_date_config: $ref: '#/components/schemas/PolicyDueDateConfigPayloadV2' requirements: description: Conditions a post-mortem must satisfy to be compliant 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 run_on_private_incidents: description: Requires the policies.run_on_private scope example: false type: boolean required: - requirements type: object PolicyScheduleV2: description: Detects gaps in on-call coverage. Set when policy_type is schedule. example: evaluation_level: schedule requirement_type: contiguous properties: evaluation_level: description: >- Evaluate coverage across the whole schedule, or per rotation. Defaults to schedule. enum: - schedule - rotation example: schedule type: string requirement_type: enum: - contiguous example: contiguous type: string required: - requirement_type type: object PolicyV2: properties: assignment_rules: $ref: '#/components/schemas/PolicyAssignmentRulesV2' conditions: description: >- Conditions which determine which resources are in scope for this policy 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: example: '2021-08-17T13:28:57.801578Z' format: date-time type: string debrief: $ref: '#/components/schemas/PolicyDebriefV2' description: description: Human readable description of the policy example: >- All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure. type: string expressions: description: The expressions relating to this policy 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 follow_up: $ref: '#/components/schemas/PolicyFollowUpV2' id: description: Unique ID of the policy example: 01G0J1EXE7AXZ2C93K61WBPYEH type: string name: description: Human readable name of the policy example: Critical incidents must export follow-ups type: string on_call_readiness: $ref: '#/components/schemas/PolicyOnCallReadinessV2' policy_type: description: Type of the policy, specifying what this applies to enum: - debrief - follow_up - on_call_readiness - post_mortem - schedule - vacation_conflict example: follow_up type: string post_mortem: $ref: '#/components/schemas/PolicyPostMortemV2' schedule: $ref: '#/components/schemas/PolicyScheduleV2' status: description: Disabled policies stop evaluating but keep their config enum: - enabled - disabled example: enabled type: string updated_at: example: '2021-08-17T13:28:57.801578Z' format: date-time type: string required: - id - name - policy_type - status - conditions - 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 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 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 PolicyDueDateConfigPayloadV2: example: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 properties: applies_from: description: >- If set, the policy only applies to resources from this timestamp onwards example: '2021-08-17T13:28:57.801578Z' format: date-time type: string calculation_timezone: description: >- Timezone the due date is calculated in. Only meaningful when calculation_type is weekdays. example: Europe/London type: string calculation_type: enum: - seven_days - weekdays example: weekdays type: string days: $ref: '#/components/schemas/EngineParamBindingPayloadV2' incident_timestamp_id: description: Timestamp the due date counts from example: 01FCNDV6P870EA6S7TK1DSYDG0 type: string required: - incident_timestamp_id - days - calculation_type 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 PolicyReadinessRuleV2: example: max_delay_seconds: 300 method_types: - slack properties: max_delay_seconds: description: How quickly the method must fire to count example: 300 format: int64 type: integer method_types: example: - slack items: enum: - slack - email - app - sms - phone - live_call - slack_channel - microsoft_teams - microsoft_teams_channel - whatsapp_message example: slack type: string type: array required: - method_types type: object PolicyAssignmentRulesV2: example: bindings: - array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity reminder_detected_date_offset_hours: - 0 - 48 reminder_due_date_offset_hours: - -24 - 0 - 24 properties: bindings: description: >- Bindings which define the user to be assigned. We will assign the first user which evaluates; the rest are fallback values 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 reminder_detected_date_offset_hours: description: >- List of hours relative to when the violation was detected to remind the assignee. Non-negative only; 0 means immediately on detection. Only valid for policy types that support detection reminders (e.g. schedule). example: - 0 - 48 items: example: 1 format: int64 type: integer type: array reminder_due_date_offset_hours: description: >- List of hours relative to the due date to remind the assignee. Negative values are before the due date, positive after. example: - -24 - 0 - 24 items: example: 1 format: int64 type: integer type: array required: - bindings - reminder_due_date_offset_hours 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 PolicyDebriefV2: description: Set when policy_type is debrief. example: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false properties: due_date_config: $ref: '#/components/schemas/PolicyDueDateConfigV2' requirements: description: Conditions a debrief must satisfy to be compliant 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 run_on_private_incidents: description: Requires the policies.run_on_private scope example: false type: boolean required: - requirements 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 PolicyFollowUpV2: description: Set when policy_type is follow_up. example: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false properties: due_date_config: $ref: '#/components/schemas/PolicyDueDateConfigV2' requirements: description: >- Conditions a follow-up must satisfy to be compliant, e.g. 'is exported to Jira' 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 run_on_private_incidents: description: Requires the policies.run_on_private scope example: false type: boolean required: - requirements type: object PolicyPostMortemV2: description: Set when policy_type is post_mortem. example: due_date_config: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 requirements: - 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 run_on_private_incidents: false properties: due_date_config: $ref: '#/components/schemas/PolicyDueDateConfigV2' requirements: description: Conditions a post-mortem must satisfy to be compliant 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 run_on_private_incidents: description: Requires the policies.run_on_private scope example: false type: boolean required: - requirements 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 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 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 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 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 PolicyDueDateConfigV2: example: applies_from: '2021-08-17T13:28:57.801578Z' calculation_timezone: Europe/London calculation_type: weekdays days: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity incident_timestamp_id: 01FCNDV6P870EA6S7TK1DSYDG0 properties: applies_from: description: >- If set, the policy only applies to resources from this timestamp onwards example: '2021-08-17T13:28:57.801578Z' format: date-time type: string calculation_timezone: description: >- Timezone the due date is calculated in. Only meaningful when calculation_type is weekdays. example: Europe/London type: string calculation_type: enum: - seven_days - weekdays example: weekdays type: string days: $ref: '#/components/schemas/EngineParamBindingV2' incident_timestamp_id: description: Timestamp the due date counts from example: 01FCNDV6P870EA6S7TK1DSYDG0 type: string required: - incident_timestamp_id - days - calculation_type 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 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 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 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 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) ````