openapi: 3.0.2 info: description: 'This document describes the PagerDuty REST APIs. For guides and examples please visit our [Documentation.](https://developer.pagerduty.com/docs/get-started/getting-started/) Our REST APIs are defined in OpenAPI v3.x. You can view the schema at [github.com/PagerDuty/api-schema](https://github.com/PagerDuty/api-schema). Note that properties in some schemas have fields not shown by default such as `readOnly`, `format`, and `default`. Hover your cursor over the right column that looks like `optional+1` to see the full list of fields. ' contact: name: PagerDuty Support url: http://www.pagerduty.com/support email: support@pagerduty.com title: PagerDuty Abilities Event Orchestrations API version: 2.0.0 servers: - url: https://api.pagerduty.com description: PagerDuty V2 API. security: - api_key: [] tags: - name: Event Orchestrations description: 'Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. ' paths: /event_orchestrations: description: Manage Global Event Orchestrations. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations operationId: listEventOrchestrations description: 'List all Global Event Orchestrations on an Account. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration''s Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event''s content. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' summary: PagerDuty List Event Orchestrations parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/offset_limit' - $ref: '#/components/parameters/offset_offset' - $ref: '#/components/parameters/sort_by_event_orchestration' responses: '200': description: A paginated array of Event Orchestration objects. content: application/json: schema: allOf: - $ref: '#/components/schemas/Pagination' - type: object properties: orchestrations: type: array items: type: object properties: id: type: string description: ID of the Orchestration. readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true name: type: string description: Name of the Orchestration. description: type: string description: A description of this Orchestration's purpose. team: type: object description: Reference to the team that owns the Orchestration. If none is specified, only admins have access. properties: id: type: string type: type: string description: A string that determines the schema of the object readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true routes: type: integer description: Number of different Service Orchestration being routed to readOnly: true created_at: type: string format: date-time description: The date the Orchestration was created at. readOnly: true created_by: type: object description: Reference to the user that has created the Orchestration. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true updated_at: type: string format: date-time description: The date the Orchestration was last updated. readOnly: true updated_by: type: object description: Reference to the user that has updated the Orchestration last. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true version: type: string description: Version of the Orchestration. readOnly: true examples: response: summary: Response Example value: orchestrations: - id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 name: Shopping Cart Orchestration description: Send shopping cart alerts to the right services team: id: PQYP5MN type: team_reference self: https://api.pagerduty.com/teams/PQYP5MN routes: 0 created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: 9co0z4b152oICsoV91_PW2.ww8ip_xap limit: 25 offset: 0 more: false total: 1 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations description: 'Create a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration''s Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event''s content. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Create an Orchestration operationId: postOrchestration requestBody: content: application/json: schema: type: object properties: orchestration: $ref: '#/components/schemas/Orchestration' required: - orchestration examples: create_orchestration: summary: 'Example: Create Orchestration' value: orchestration: name: New Orchestration description: This is a newly created orchestration team: id: PXD0WR8 parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' responses: '201': description: The Orchestration that was created. content: application/json: schema: type: object properties: orchestration: $ref: '#/components/schemas/Orchestration' examples: response: summary: Response Example value: orchestration: id: 3aae9a17-8585-4d8c-93d3-99742801cd95 self: https://api.pagerduty.com/event_orchestrations/3aae9a17-8585-4d8c-93d3-99742801cd95 name: New Orchestration description: This is a newly created orchestration team: id: PXD0WR8 self: https://api.pagerduty.com/teams/PXD0WR8 type: team_reference integrations: - id: 461cd942-d7cc-43ef-ac7d-86ba2d58fc45 label: New Orchestration Default Integration parameters: routing_key: R022XIJR9M266DX570EVE6EXP1AFBN6D type: global routes: 0 created_at: '2021-12-02T14:21:42Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-12-02T14:21:42Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: oBgzJsGDOz99G.FKZ0c1C6hw35twk_Ib '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/{id}: description: Manage a Global Event Orchestration. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations operationId: getOrchestration description: 'Get a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration''s Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event''s content. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' summary: PagerDuty Get an Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '200': description: The Orchestration object. content: application/json: schema: type: object properties: orchestration: $ref: '#/components/schemas/Orchestration' examples: response: summary: Response Example value: orchestration: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 name: Shopping Cart Orchestration description: Send shopping cart alerts to the right services team: id: PQYP5MN type: team_reference self: https://api.pagerduty.com/teams/PQYP5MN integrations: - id: 9c5ff030-12da-4204-a067-25ee61a8df6c label: Shopping Cart Orchestration Default Integration parameters: routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T type: global routes: 0 created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: 9co0z4b152oICsoV91_PW2.ww8ip_xap '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations operationId: updateOrchestration description: 'Update a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration''s Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event''s content. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Update an Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' requestBody: content: application/json: schema: type: object properties: orchestration: $ref: '#/components/schemas/Orchestration' required: - orchestration examples: change_name: summary: 'Example: Change name' value: orchestration: name: Go-Kart Orchestration change_team: summary: 'Example: Change team' value: orchestration: team: id: PWL7QXS change_description: summary: 'Example: Change description' value: orchestration: description: Orchestration that does some stuff description: '' responses: '200': description: The Orchestration that was updated. content: application/json: schema: type: object properties: orchestration: $ref: '#/components/schemas/Orchestration' examples: response: summary: Response Example value: orchestration: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 name: Go-Kart Orchestration description: Orchestration that does some stuff team: id: PWL7QXS type: team_reference self: https://api.pagerduty.com/teams/PWL7QXS integrations: - id: 9c5ff030-12da-4204-a067-25ee61a8df6c label: Go-Kart Orchestration Default Integration parameters: routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T type: global routes: 0 created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-19T11:42:32Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: BrWLKQBLm8QO2ZYQ0GosHLxdbgWZ0ZR3 '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' delete: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations operationId: deleteOrchestration description: 'Delete a Global Event Orchestration. Once deleted, you will no longer be able to ingest events into PagerDuty using this Orchestration''s Routing Key. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Delete an Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '204': description: The Orchestration was deleted successfully. '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/{id}/integrations: description: Manage Integrations for a Global Event Orchestration. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations description: 'List the Integrations associated with this Event Orchestrations. You can use a Routing Key from these Integrations to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' summary: PagerDuty List Integrations for an Event Orchestration operationId: listOrchestrationIntegrations parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '200': description: The Integrations for this Event Orchestration. content: application/json: schema: type: object properties: integrations: type: array items: $ref: '#/components/schemas/OrchestrationIntegration' total: $ref: '#/components/schemas/Pagination/properties/total' examples: response: summary: Response Example value: integrations: - id: 9c5ff030-12da-4204-a067-25ee61a8df6c label: Go-Kart Orchestration Default Integration parameters: routing_key: R022XIJR9M266DX570EVE6EXP1AFBN6D type: global - id: 11832872-88b6-4661-8972-db5712b69496 label: Integration for Monitoring Tool X parameters: routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T type: global total: 2 '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '405': $ref: '#/components/responses/NotAllowed' post: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations description: 'Create an Integration associated with this Event Orchestration. You can then use the Routing Key from this new Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Create an Integration for an Event Orchestration operationId: postOrchestrationIntegration requestBody: content: application/json: schema: type: object properties: integration: type: object properties: label: type: string description: Name of the Integration. required: - label required: - integration examples: create_orchestration: summary: 'Example: Create an Integration' value: integration: label: Integration for Monitoring Tool X parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '201': description: The Integration that was created. content: application/json: schema: type: object properties: integration: $ref: '#/components/schemas/OrchestrationIntegration' examples: response: summary: Response Example value: integration: id: 11832872-88b6-4661-8972-db5712b69496 label: Integration for Monitoring Tool X parameters: routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T type: global '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/{id}/integrations/{integration_id}: description: Manage an Integration for a Global Event Orchestration. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations description: 'Get an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' summary: PagerDuty Get an Integration for an Event Orchestration operationId: getOrchestrationIntegration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' - $ref: '#/components/parameters/event_orchestration_integration_id' responses: '200': description: An Integration for this Event Orchestration. content: application/json: schema: properties: integration: $ref: '#/components/schemas/OrchestrationIntegration' examples: response: summary: Response Example value: integration: id: 9c5ff030-12da-4204-a067-25ee61a8df6c label: Go-Kart Orchestration Default Integration parameters: routing_key: R022XIJR9M266DX570EVE6EXP1AFBN6D type: global '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '405': $ref: '#/components/responses/NotAllowed' put: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations description: 'Update an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Update an Integration for an Event Orchestration operationId: updateOrchestrationIntegration requestBody: content: application/json: schema: type: object properties: integration: type: object properties: label: type: string description: Name of the Integration. required: - label required: - integration examples: create_orchestration: summary: 'Example: Update an Integration' value: integration: label: New Name for my Integration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' - $ref: '#/components/parameters/event_orchestration_integration_id' responses: '200': description: The Integration that was updated. content: application/json: schema: type: object properties: integration: $ref: '#/components/schemas/OrchestrationIntegration' examples: response: summary: Response Example value: integration: id: 11832872-88b6-4661-8972-db5712b69496 label: New Name for my Integration parameters: routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T type: global '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' delete: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations description: 'Delete an Integration and its associated Routing Key. Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Delete an Integration for an Event Orchestration operationId: deleteOrchestrationIntegration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' - $ref: '#/components/parameters/event_orchestration_integration_id' responses: '204': description: The Integration was deleted successfully. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/{id}/integrations/migration: description: Migrate an Integration to this Global Event Orchestration. post: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations description: 'Move an Integration and its Routing Key from the Event Orchestration specified in the request payload, to the Event Orchestration specified in the request URL. Any future events sent to this Integration''s Routing Key will be processed by this Event Orchestration''s Rules. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Migrate an Integration from one Event Orchestration to another operationId: migrateOrchestrationIntegration requestBody: content: application/json: schema: type: object properties: source_id: type: string description: The ID of the Event Orchestration you'll be moving the Integration away from source_type: type: string description: The type of of the `source_id` object enum: - orchestration integration_id: type: string description: The ID of the Integration you'll be moving required: - source_id - source_type - integration_id examples: migrate_integration: summary: 'Example: Migrate an Integration' value: source_type: orchestration source_id: b02e973d-9620-4e0a-9edc-00fedf7d4694 integration_id: 11832872-88b6-4661-8972-db5712b69496 parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '200': description: The Integration that was migrated content: application/json: schema: type: object properties: integrations: type: array items: $ref: '#/components/schemas/OrchestrationIntegration' total: $ref: '#/components/schemas/Pagination/properties/total' examples: response: summary: Response Example value: integrations: - id: 9c5ff030-12da-4204-a067-25ee61a8df6c label: Go-Kart Orchestration Default Integration parameters: routing_key: R022XIJR9M266DX570EVE6EXP1AFBN6D type: global - id: 11832872-88b6-4661-8972-db5712b69496 label: Integration for Monitoring Tool X parameters: routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T type: global total: 2 '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/{id}/global: description: View and update Global Orchestration Rules. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations operationId: getOrchPathGlobal summary: PagerDuty Get the Global Orchestration for an Event Orchestration description: 'Get the Global Orchestration for an Event Orchestration. Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '200': description: The Global Orchestration Rules object. content: application/json: schema: $ref: '#/components/schemas/OrchestrationGlobal' examples: response: $ref: '#/components/examples/OrchestrationPathGlobalTypeResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations operationId: updateOrchPathGlobal summary: PagerDuty Update the Global Orchestration for an Event Orchestration description: 'Update the Global Orchestration for an Event Orchestration. Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' requestBody: description: Update Global Orchestration rules. Omitted rules and rule details are deleted. content: application/json: schema: $ref: '#/components/schemas/OrchestrationGlobal' examples: request: summary: Example Request value: orchestration_path: sets: - id: start rules: - label: Always apply some consistent event transformations to all events id: c91f72f3 conditions: [] actions: variables: - name: hostname path: event.component value: 'hostname: (.*)' type: regex extractions: - template: '{{variables.hostname}}' target: event.custom_details.hostname - source: event.source regex: www (.*) service target: event.source incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - id: PN1C4A2 value: '{{event.timestamp}}' route_to: step-two - id: step-two rules: - label: All critical alerts should be treated as P1 incidents id: 7c54529d conditions: - expression: event.severity matches 'critical' actions: priority: P0IN2KQ suppress: false incident_custom_field_updates: - id: PEXCK89 value: '#p1-incident-response' - label: Drop all events from the very-noisy monitoring tool id: 1f6d9a33 conditions: - expression: event.source matches part 'very-noisy' actions: drop_event: true - label: Never bother the on-call for info-level events outside of work hours id: cd770384 conditions: - expression: event.severity matches 'info' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles) actions: suppress: true catch_all: actions: suppress: true incident_custom_field_updates: - id: PEXCK89 value: '#general-incident-notifications' responses: '200': description: The Global Orchestration Rules object. content: application/json: schema: allOf: - $ref: '#/components/schemas/OrchestrationGlobal' - type: object properties: warnings: type: array items: anyOf: - $ref: '#/components/schemas/OrchestrationWarningIneligible' - $ref: '#/components/schemas/OrchestrationWarningInvalidData' examples: response: summary: Example Response value: orchestration_path: type: global parent: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 type: event_orchestration_reference self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global sets: - id: start rules: - label: Always apply some consistent event transformations to all events id: c91f72f3 conditions: [] actions: variables: - name: hostname path: event.component value: 'hostname: (.*)' type: regex extractions: - template: '{{variables.hostname}}' target: event.custom_details.hostname - source: event.source regex: www (.*) service target: event.source incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - id: PN1C4A2 value: '{{event.timestamp}}' route_to: step-two - id: step-two rules: - label: All critical alerts should be treated as P1 incidents id: 7c54529d conditions: - expression: event.severity matches 'critical' actions: priority: P0IN2KQ suppress: false incident_custom_field_updates: - id: PEXCK89 value: '#p1-incident-response' - label: Drop all events from the very-noisy monitoring tool id: 1f6d9a33 conditions: - expression: event.source matches part 'very-noisy' actions: drop_event: true - label: Never bother the on-call for info-level events outside of work hours id: cd770384 conditions: - expression: event.severity matches 'info' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles) actions: suppress: true catch_all: actions: suppress: true incident_custom_field_updates: - id: PEXCK89 value: '#general-incident-notifications' created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ warnings: - feature: nested_rules feature_type: nested_rules message: This orchestration contains Nested Rules, which is not available on your account plan. The orchestration will be updated, however, only rules in the 'start' set will be evaluated rule_id: null warning_type: forbidden_feature - feature: variables feature_type: actions message: This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: c91f72f3 warning_type: forbidden_feature - feature: extractions feature_type: actions message: This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: c91f72f3 warning_type: forbidden_feature - feature: recurring_condition feature_type: conditions message: This rule uses Recurring Condition, which is a condition not available on your account plan. The rule will be updated, but it will not be evaluated by events rule_id: cd770384 warning_type: forbidden_feature - feature: incident_custom_field_updates feature_type: actions message: This rule uses Incident Custom Field update, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: c91f72f3 warning_type: forbidden_feature '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/{id}/router: description: View and update an Orchestration Router. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations operationId: getOrchPathRouter summary: PagerDuty Get the Router for an Event Orchestration description: 'Get a Global Orchestration''s Routing Rules. An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn''t match any rules, it''ll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '200': $ref: '#/components/responses/OrchestrationPathRouterTypeResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations operationId: updateOrchPathRouter summary: PagerDuty Update the Router for an Event Orchestration description: 'Update a Global Orchestration''s Routing Rules. An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn''t match any rules, it''ll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' requestBody: description: Updates to Orchestration Router details. Omitted rules and rule details are deleted. content: application/json: schema: $ref: '#/components/schemas/OrchestrationRouter' examples: request: summary: Example Request value: orchestration_path: sets: - id: start rules: - label: Events relating to our relational database id: 1c26698b conditions: - expression: event.summary matches part 'database' - expression: event.source matches regex 'db[0-9]+-server' actions: route_to: PB31XBA - label: Events relating to our www app server id: d9801904 conditions: - expression: event.summary matches part 'www' actions: route_to: PC2D9ML - label: Events relating to our delivery pipeline id: ed624931 conditions: - expression: trigger_count over 1 minute > 3 actions: route_to: PQSJBMA responses: '200': description: The Orchestration Router object. content: application/json: schema: allOf: - $ref: '#/components/schemas/OrchestrationRouter' - type: object properties: warnings: type: array description: List of applicable warnings messages for each rule using a feature not available on your account plan. items: anyOf: - $ref: '#/components/schemas/OrchestrationWarningIneligible' examples: response: summary: Example Response value: orchestration_path: type: router parent: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 type: event_orchestration_reference self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router sets: - id: start rules: - label: Events relating to our relational database id: 1c26698b conditions: - expression: event.summary matches part 'database' - expression: event.source matches regex 'db[0-9]+-server' actions: route_to: PB31XBA - label: Events relating to our www app server id: d9801904 conditions: - expression: event.summary matches part 'www' actions: route_to: PC2D9ML - label: Events relating to our delivery pipeline id: ed624931 conditions: - expression: trigger_count over 1 minute > 3 actions: route_to: PQSJBMA catch_all: actions: route_to: unrouted created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: 9co0z4b152oICsoV91_PW2.ww8ip_xap warnings: - feature: threshold_condition feature_type: conditions message: This rule uses Threshold Condition, which is a condition not available on your account plan. The rule will be updated, but it will not be evaluated by events rule_id: ed624931 warning_type: forbidden_feature '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/{id}/unrouted: description: View and update an Unrouted Orchestration. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations operationId: getOrchPathUnrouted summary: PagerDuty Get the Unrouted Orchestration for an Event Orchestration description: 'Get a Global Event Orchestration''s Rules for Unrouted events. An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don''t match any rules in the Global Orchestration''s Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service. The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '200': $ref: '#/components/responses/OrchestrationPathUnroutedTypeResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations operationId: updateOrchPathUnrouted summary: PagerDuty Update the Unrouted Orchestration for an Event Orchestration description: 'Update a Global Event Orchestration''s Rules for Unrouted events. An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don''t match any rules in the Global Orchestration''s Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service. The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' requestBody: description: Updates to Unrouted Orchestration rules. Omitted rules and rule details are deleted. content: application/json: schema: $ref: '#/components/schemas/OrchestrationUnrouted' examples: request: summary: Example Request value: orchestration_path: sets: - id: start rules: - label: Update the summary of un-matched Critical alerts so they're easier to spot id: 38880ffb conditions: - expression: event.severity matches 'critical' actions: extractions: - target: event.summary template: '[Critical Unrouted] {{event.summary}}' - label: Reduce the severity of all other unrouted events id: 3896801e conditions: [] actions: severity: info catch_all: actions: suppress: true responses: '200': description: The Unrouted Orchestration object. content: application/json: schema: allOf: - $ref: '#/components/schemas/OrchestrationUnrouted' - type: object properties: warnings: type: array description: List of applicable warnings messages for each rule using a feature not available on your account plan. items: anyOf: - $ref: '#/components/schemas/OrchestrationWarningIneligible' examples: response: summary: Example Response value: orchestration_path: type: unrouted parent: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 type: event_orchestration_reference self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router sets: - id: start rules: - label: Update the summary of un-matched Critical alerts so they're easier to spot id: 38880ffb conditions: - expression: event.severity matches 'critical' actions: extractions: - target: event.summary template: '[Critical Unrouted] {{event.summary}}' - label: Reduce the severity of all other unrouted events id: 3896801e conditions: [] actions: severity: info catch_all: actions: suppress: true created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: aZO.EEf9zWb9Vg0NYq.Uqad1hOC2Maod warnings: - feature: extractions feature_type: actions message: This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: 3896801e warning_type: forbidden_feature '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/services/{service_id}: description: View and update a Service Orchestration. get: x-pd-requires-scope: services.read tags: - Event Orchestrations operationId: getOrchPathService summary: PagerDuty Get the Service Orchestration for a Service description: 'Get a Service Orchestration. A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' - $ref: '#/components/parameters/include_ruleset_migrated_metadata' responses: '200': $ref: '#/components/responses/OrchestrationPathServiceTypeResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-pd-requires-scope: services.write tags: - Event Orchestrations operationId: updateOrchPathService summary: PagerDuty Update the Service Orchestration for a Service description: 'Update a Service Orchestration. A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' requestBody: description: Update Service Orchestration rules. Omitted rules and rule details are deleted. content: application/json: schema: $ref: '#/components/schemas/ServiceOrchestration' examples: request: summary: Example Request value: orchestration_path: sets: - id: start rules: - label: Always apply some consistent event transformations to all events id: c91f72f3 conditions: [] actions: variables: - name: hostname path: event.component value: 'hostname: (.*)' type: regex extractions: - template: '{{variables.hostname}}' target: event.custom_details.hostname - source: event.source regex: www (.*) service target: event.source pagerduty_automation_actions: - action_id: 01CSB5SMOKCKVRI5GN0LJG7SMB incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - id: PN1C4A2 value: '{{event.timestamp}}' route_to: step-two - id: step-two rules: - label: All critical alerts should be treated as P1 incidents id: 7c54529d conditions: - expression: event.severity matches 'critical' actions: annotate: 'Please use our P1 runbook: https://docs.test/p1-runbook' priority: P0IN2KQ suppress: false incident_custom_field_updates: - id: PEXCK89 value: '#p1-incident-response' - label: If there's something wrong on the canary let the team know about it in our deployments Slack channel id: 1f6d9a33 conditions: - expression: event.custom_details.hostname matches part 'canary' actions: automation_actions: - name: Canary Slack Notification url: https://our-slack-listerner.test/send-notification auto_send: true headers: - key: X-Notification-Source value: PagerDuty Incident Webhook parameters: - key: channel value: '#my-team-channel' - key: message value: Something is wrong with the canary deployment incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - label: Never bother the on-call for info-level events outside of work hours id: cd770384 conditions: - expression: event.severity matches 'info' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles) actions: suppress: true catch_all: actions: suppress: true incident_custom_field_updates: - id: PEXCK89 value: '#general-incident-notifications' responses: '200': description: The Service Orchestration object. content: application/json: schema: allOf: - $ref: '#/components/schemas/ServiceOrchestration' - type: object properties: warnings: type: array items: anyOf: - $ref: '#/components/schemas/OrchestrationWarningIneligible' - $ref: '#/components/schemas/OrchestrationWarningInvalidData' examples: response: summary: Example Response value: orchestration_path: type: service parent: id: PC2D9ML self: https://api.pagerduty.com/service/PC2D9ML type: service_reference self: https://api.pagerduty.com/event_orchestrations/service/PC2D9ML sets: - id: start rules: - label: Always apply some consistent event transformations to all events id: c91f72f3 conditions: [] actions: variables: - name: hostname path: event.component value: 'hostname: (.*)' type: regex extractions: - template: '{{variables.hostname}}' target: event.custom_details.hostname - source: event.source regex: www (.*) service target: event.source pagerduty_automation_actions: - action_id: 01CSB5SMOKCKVRI5GN0LJG7SMB incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - id: PN1C4A2 value: '{{event.timestamp}}' route_to: step-two - id: step-two rules: - label: All critical alerts should be treated as P1 incidents id: 7c54529d conditions: - expression: event.severity matches 'critical' actions: annotate: 'Please use our P1 runbook: https://docs.test/p1-runbook' priority: P0IN2KQ suppress: false incident_custom_field_updates: - id: PEXCK89 value: '#p1-incident-response' - label: If there's something wrong on the canary let the team know about it in our deployments Slack channel id: 1f6d9a33 conditions: - expression: event.custom_details.hostname matches part 'canary' actions: automation_actions: - name: Canary Slack Notification url: https://our-slack-listerner.test/send-notification auto_send: true headers: - key: X-Notification-Source value: PagerDuty Incident Webhook parameters: - key: channel value: '#my-team-channel' - key: message value: Something is wrong with the canary deployment - label: Never bother the on-call for info-level events outside of work hours id: cd770384 conditions: - expression: event.severity matches 'info' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles) actions: suppress: true catch_all: actions: suppress: true incident_custom_field_updates: - id: PEXCK89 value: '#general-incident-notifications' created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ warnings: - feature: nested_rules feature_type: nested_rules message: This orchestration contains Nested Rules, which is not available on your account plan. The orchestration will be updated, however, only rules in the 'start' set will be evaluated rule_id: null warning_type: forbidden_feature - feature: variables feature_type: actions message: This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: c91f72f3 warning_type: forbidden_feature - feature: extractions feature_type: actions message: This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: c91f72f3 warning_type: forbidden_feature - feature: pagerduty_automation_actions feature_type: actions message: This rule uses PagerDuty Automation Actions, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: c91f72f3 warning_type: forbidden_feature - feature: automation_actions feature_type: actions message: This rule uses Automation Actions, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: 1f6d9a33 warning_type: forbidden_feature - feature: recurring_condition feature_type: conditions message: This rule uses Recurring Condition, which is a condition not available on your account plan. The rule will be updated, but it will not be evaluated by events rule_id: c91f72f3 warning_type: forbidden_feature - feature: incident_custom_field_updates feature_type: actions message: This rule uses Incident Custom Field update, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated rule_id: 4g6d2a901 warning_type: forbidden_feature '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/services/{service_id}/active: description: View and update a Service Orchestration's active status. get: x-pd-requires-scope: services.read tags: - Event Orchestrations operationId: getOrchActiveStatus summary: PagerDuty Get the Service Orchestration active status for a Service description: 'Get a Service Orchestration''s active status. A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false). For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' responses: '200': $ref: '#/components/responses/OrchestrationPathServiceActiveResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-pd-requires-scope: services.write tags: - Event Orchestrations operationId: updateOrchActiveStatus summary: PagerDuty Update the Service Orchestration active status for a Service description: 'Update a Service Orchestration''s active status. A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false). For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' requestBody: description: Update Service Orchestration's active status. content: application/json: schema: $ref: '#/components/responses/OrchestrationPathServiceActiveResponse/content/application~1json/schema' examples: request: summary: Example Request value: active: false responses: '200': $ref: '#/components/responses/OrchestrationPathServiceActiveResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' '409': $ref: '#/components/responses/Conflict' /event_orchestrations/{id}/cache_variables: description: Manage Cache Variables for a Global Event Orchestration. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations operationId: listCacheVarOnGlobalOrch description: 'List Cache Variables for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' summary: PagerDuty List Cache Variables for a Global Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' responses: '200': $ref: '#/components/responses/OrchestrationCacheVariableListResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations operationId: createCacheVarOnGlobalOrch description: 'Create a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Create a Cache Variable for a Global Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' requestBody: $ref: '#/components/requestBodies/OrchestrationCacheVariablePostRequest' responses: '200': $ref: '#/components/responses/OrchestrationCacheVariablePostResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' /event_orchestrations/{id}/cache_variables/{cache_variable_id}: description: Manage a Cache Variable for a Global Event Orchestration. get: x-pd-requires-scope: event_orchestrations.read tags: - Event Orchestrations operationId: getCacheVarOnGlobalOrch description: 'Get a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read` ' summary: PagerDuty Get a Cache Variable for a Global Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' - $ref: '#/components/parameters/event_orchestration_cache_variable_id' responses: '200': $ref: '#/components/responses/OrchestrationCacheVariableGetResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations operationId: updateCacheVarOnGlobalOrch description: 'Update a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Update a Cache Variable for a Global Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' - $ref: '#/components/parameters/event_orchestration_cache_variable_id' requestBody: $ref: '#/components/requestBodies/OrchestrationCacheVariablePutRequest' responses: '200': $ref: '#/components/responses/OrchestrationCacheVariablePutResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' delete: x-pd-requires-scope: event_orchestrations.write tags: - Event Orchestrations operationId: deleteCacheVarOnGlobalOrch description: 'Delete a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write` ' summary: PagerDuty Delete a Cache Variable for a Global Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/event_orchestration_id' - $ref: '#/components/parameters/event_orchestration_cache_variable_id' responses: '204': description: The Cache Variable was deleted successfully. '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /event_orchestrations/services/{service_id}/cache_variables: description: Manage Cache Variables for a Service Event Orchestration. get: x-pd-requires-scope: services.read tags: - Event Orchestrations operationId: listCacheVarOnServiceOrch description: 'List Cache Variables for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read` ' summary: PagerDuty List Cache Variables for a Service Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' responses: '200': $ref: '#/components/responses/OrchestrationCacheVariableListResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: x-pd-requires-scope: services.write tags: - Event Orchestrations operationId: createCacheVarOnServiceOrch description: 'Create a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write` ' summary: PagerDuty Create a Cache Variable for a Service Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' requestBody: $ref: '#/components/requestBodies/OrchestrationCacheVariablePostRequest' responses: '200': $ref: '#/components/responses/OrchestrationCacheVariablePostResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' /event_orchestrations/services/{service_id}/cache_variables/{cache_variable_id}: description: Manage a Cache Variable for a Service Event Orchestration. get: x-pd-requires-scope: services.read tags: - Event Orchestrations operationId: getCacheVarOnServiceOrch description: 'Get a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read` ' summary: PagerDuty Get a Cache Variable for a Service Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' - $ref: '#/components/parameters/event_orchestration_cache_variable_id' responses: '200': $ref: '#/components/responses/OrchestrationCacheVariableGetResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-pd-requires-scope: services.write tags: - Event Orchestrations operationId: updateCacheVarOnServiceOrch description: 'Update a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write` ' summary: PagerDuty Update a Cache Variable for a Service Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' - $ref: '#/components/parameters/event_orchestration_cache_variable_id' requestBody: $ref: '#/components/requestBodies/OrchestrationCacheVariablePutRequest' responses: '200': $ref: '#/components/responses/OrchestrationCacheVariablePutResponse' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/NotAllowed' delete: x-pd-requires-scope: services.write tags: - Event Orchestrations operationId: deleteCacheVarOnServiceOrch description: 'Delete a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write` ' summary: PagerDuty Delete a Cache Variable for a Service Event Orchestration parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/service_id' - $ref: '#/components/parameters/event_orchestration_cache_variable_id' responses: '204': description: The Cache Variable was deleted successfully. '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: responses: OrchestrationCacheVariablePutResponse: description: The updated Cache Variable for this Event Orchestration. content: application/json: schema: type: object properties: cache_variable: $ref: '#/components/schemas/OrchestrationCacheVariable' examples: update_conditions: summary: 'Response Example: Recent value cache variable' value: cache_variable: - id: 66bb56c3-2a17-44f3-9193-06b166d759ad name: example_1 conditions: - expression: event.summary matches 'exception' - expression: event.summary matches 'error' configuration: type: recent_value source: event.summary regex: .* created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference update_configuration: summary: 'Response Example: Trigger event count cache variable' value: cache_variable: - id: 66bb56c3-2a17-44f3-9193-06b166d759ad name: example_1 conditions: - expression: not event.custom_details.errors exists configuration: type: trigger_event_count ttl_seconds: 2 created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference update_disabled: summary: 'Response Example: Disabled cache variable' value: cache_variable: - id: 66bb56c3-2a17-44f3-9193-06b166d759ad name: example_1 conditions: - expression: not event.custom_details.errors exists configuration: type: recent_value source: event.summary regex: .* disabled: true created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference NotFound: description: The requested resource was not found. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' OrchestrationPathServiceTypeResponse: description: The Service Orchestration object. content: application/json: schema: $ref: '#/components/schemas/ServiceOrchestration' examples: response: summary: Example Response value: orchestration_path: type: service parent: id: PC2D9ML self: https://api.pagerduty.com/service/PC2D9ML type: service_reference self: https://api.pagerduty.com/event_orchestrations/service/PC2D9ML sets: - id: start rules: - label: Always apply some consistent event transformations to every event sent to this Service id: c91f72f3 conditions: [] actions: variables: - name: hostname path: event.component value: 'hostname: (.*)' type: regex extractions: - template: '{{variables.hostname}}' target: event.custom_details.hostname - source: event.source regex: www (.*) service target: event.source pagerduty_automation_actions: - action_id: 01CSB5SMOKCKVRI5GN0LJG7SMB route_to: step-two incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - id: PN1C4A2 value: '{{event.timestamp}}' - id: step-two rules: - label: All critical alerts should be treated as P1 incidents id: 7c54529d conditions: - expression: event.severity matches 'critical' actions: annotate: 'Please use our P1 runbook: https://docs.test/p1-runbook' priority: P0IN2KQ suppress: false incident_custom_field_updates: - id: PEXCK89 value: '#p1-incident-response' - label: If there's something wrong on the canary let the team know about it in our deployments Slack channel id: 1f6d9a33 conditions: - expression: event.custom_details.hostname matches part 'canary' actions: automation_actions: - name: Canary Slack Notification url: https://our-slack-listerner.test/send-notification auto_send: true headers: - key: X-Notification-Source value: PagerDuty Incident Webhook parameters: - key: channel value: '#my-team-channel' - key: message value: Something is wrong with the canary deployment incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - label: Never bother the on-call for info-level events outside of work hours id: cd770384 conditions: - expression: event.severity matches 'info' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles) actions: suppress: true catch_all: actions: suppress: true incident_custom_field_updates: - id: PEXCK89 value: '#general-incident-notifications' created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference migrated_at: '2023-06-14T13:51:31Z' migrated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference migrated_from: id: PC2D9ML self: https://api.pagerduty.com/services/PC2D9ML/rules type: service_event_rules_reference migrated_status: completed migrated_via: UI version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ Conflict: description: The request conflicts with the current state of the server. content: application/json: schema: type: object properties: error: type: object properties: code: type: integer readOnly: true message: type: string readOnly: true description: Error message string errors: type: array readOnly: true items: type: string readOnly: true description: Human-readable error details example: message: Not Found code: 2100 OrchestrationCacheVariablePostResponse: description: The created Cache Variable for this Event Orchestration. content: application/json: schema: type: object properties: cache_variable: $ref: '#/components/schemas/OrchestrationCacheVariable' examples: recent_value: summary: 'Response Example: Recent value cache variable' value: cache_variable: - id: 66bb56c3-2a17-44f3-9193-06b166d759ad name: example_1 conditions: - expression: not event.custom_details.errors exists configuration: type: recent_value source: event.summary regex: .* created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference trigger_event_count: summary: 'Response Example: Trigger event count cache variable' value: cache_variable: - id: f08cdd8d-10a5-4c70-b508-82ab5c365a43 name: example_2 conditions: [] configuration: type: trigger_event_count ttl_seconds: 30 created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference OrchestrationCacheVariableListResponse: description: The Cache Variables for this Event Orchestration. content: application/json: schema: type: object properties: cache_variables: type: array items: $ref: '#/components/schemas/OrchestrationCacheVariable' examples: response: summary: Response Example value: cache_variables: - id: 294c3ee9-ae83-4da7-828d-107c71dc9316 name: cache_var_1 conditions: - expression: event.source exists - expression: event.severity matches 'critical' configuration: type: recent_value source: event.source regex: www (.*) service created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference - id: 2a6d02d5-6365-4326-aaf1-6a719e990245 name: cache_var_2 conditions: [] configuration: type: trigger_event_count ttl_seconds: 60 disabled: true created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference total: 2 OrchestrationCacheVariableGetResponse: description: The fetched Cache Variable for this Event Orchestration. content: application/json: schema: type: object properties: cache_variable: $ref: '#/components/schemas/OrchestrationCacheVariable' examples: response: summary: Response Example value: cache_variable: - id: 64122e97-de81-4554-9d7c-c219cef351cd name: cache_var_1 conditions: - expression: raw_event.class exists and event.summary matches part 'unstable' configuration: type: recent_value source: event.custom_details.work_id regex: .* created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference NotAllowed: description: The request was received and recognized by the server, but its HTTP method was rejected for the requested resource. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' Unauthorized: description: 'Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed. ' content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' ArgumentError: description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' OrchestrationPathUnroutedTypeResponse: description: The Unrouted Orchestration object. content: application/json: schema: $ref: '#/components/schemas/OrchestrationUnrouted' examples: response: summary: Example Response value: orchestration_path: type: unrouted parent: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 type: event_orchestration_reference self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router sets: - id: start rules: - label: Update the summary of un-matched Critical alerts so they're easier to spot id: 38880ffb conditions: - expression: event.severity matches 'critical' actions: extractions: - target: event.summary template: '[Critical Unrouted] {{event.summary}}' - label: Reduce the severity of all other unrouted events id: 3896801e conditions: [] actions: severity: info catch_all: actions: suppress: true created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: aZO.EEf9zWb9Vg0NYq.Uqad1hOC2Maod OrchestrationPathRouterTypeResponse: description: The Orchestration Router object. content: application/json: schema: $ref: '#/components/schemas/OrchestrationRouter' examples: response: summary: Example Response value: orchestration_path: type: router parent: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 type: event_orchestration_reference self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router sets: - id: start rules: - label: Events relating to our relational database id: 1c26698b conditions: - expression: event.summary matches part 'database' - expression: event.source matches regex 'db[0-9]+-server' actions: route_to: PB31XBA - label: Events relating to our www app server id: d9801904 conditions: - expression: event.summary matches part 'www' actions: route_to: PC2D9ML catch_all: actions: route_to: unrouted created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: 9co0z4b152oICsoV91_PW2.ww8ip_xap OrchestrationPathServiceActiveResponse: description: An object with the active status. content: application/json: schema: type: object properties: active: type: boolean description: The status of the service orchestration. examples: response: summary: Example Response value: active: false Forbidden: description: 'Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action. ' content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' parameters: service_id: name: service_id in: path description: The service ID required: true schema: type: string event_orchestration_integration_id: name: integration_id description: The ID of an Integration. in: path required: true schema: type: string offset_offset: name: offset in: query required: false description: Offset to start pagination search results. schema: type: integer event_orchestration_id: name: id description: The ID of an Event Orchestration. in: path required: true schema: type: string header_Accept: name: Accept description: The `Accept` header is used as a versioning header. in: header required: true schema: type: string default: application/vnd.pagerduty+json;version=2 header_Content-Type: name: Content-Type in: header required: true schema: type: string default: application/json enum: - application/json sort_by_event_orchestration: name: sort_by in: query description: Used to specify the field you wish to sort the results on. schema: type: string enum: - name:asc - name:desc - routes:asc - routes:desc - created_at:asc - created_at:desc default: name:asc event_orchestration_cache_variable_id: name: cache_variable_id description: The ID of a Cache Variable. in: path required: true schema: type: string include_ruleset_migrated_metadata: name: include[] in: query description: Array of additional Models to include in response. explode: true schema: type: string enum: - migrated_metadata uniqueItems: true offset_limit: name: limit in: query required: false description: The number of results per page. schema: type: integer schemas: OrchestrationCacheVariable: type: object properties: id: type: string readOnly: true name: type: string description: The name of the Cache Variable configuration: oneOf: - type: object description: 'Defines how the value of the Cache Variable will be set. ' properties: type: type: string description: 'Cache Variable will be set to the most recent value seen, based on the source event field and the extraction regex specified ' enum: - recent_value source: type: string description: The path to the event field where the regex will be applied to extract a value. example: event.summary regex: type: string description: 'A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used. ' required: - type - source - regex - type: object description: 'Defines how the value of the Cache Variable will be set. ' properties: type: type: string description: 'Cache Variable will be set to the number of trigger events that have been seen within the TTL range ' enum: - trigger_event_count ttl_seconds: type: integer description: 'The time to live (in seconds) for how long to count trigger events before resetting back to 0. ' required: - type - ttl_seconds conditions: type: array description: Each of these conditions is evaluated to check if an event matches this rule. The rule is considered a match if **any** of these conditions match. items: type: object properties: expression: type: string example: event.summary matches part 'my service error' description: 'A PCL condition string. Note: The `trigger_count` and `resetting_trigger_count` operators are unsupported for Cache Variables ' disabled: type: boolean description: Indicates whether the Cache Variable is disabled and would therefore not be evaluated. created_at: type: string format: date-time description: The date/time the object was created. readOnly: true created_by: type: object description: Reference to the user that created the object. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true updated_at: type: string format: date-time description: The date/time the object was last updated. readOnly: true updated_by: type: object description: Reference to the user that last updated the object. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true required: - name - configuration OrchestrationIntegration: type: object properties: id: type: string description: ID of the Integration. readOnly: true label: type: string description: Name of the Integration. parameters: type: object readOnly: true properties: routing_key: type: string description: Routing Key used to send Events to this Orchestration readOnly: true type: type: string default: global readOnly: true ServiceOrchestration: allOf: - $ref: '#/components/schemas/OrchestrationGlobal/allOf/0' - type: object properties: orchestration_path: allOf: - type: object properties: migrated_at: type: string format: date-time description: The date/time the service's Event Rules were converted to this Service Orchestration. This property is only included if the `migrated_metadata` query parameter is provided. readOnly: true migrated_by: type: object description: Reference to the user that converted the service's Event Rules to this Service Orchestration. This property is only included if the `migrated_metadata` query parameter is provided. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true migrated_from: type: object description: Reference to the Service Event Rules that were converted to this Service Orchestration. This property is only included if the `migrated_metadata` query parameter is provided. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true migrated_status: type: string description: The status indicating whether the service's Event Rules were successfully converted to this Service Orchestration. This property is only included if the `migrated_metadata` query parameter is provided. enum: - completed readOnly: true migrated_via: type: string description: Indicates whether the conversion was performed via the PagerDuty API or PagerDuty website. This property is only included if the `migrated_metadata` query parameter is provided. enum: - API - UI readOnly: true - type: object properties: type: description: Indicates that these are sets of rules belonging to a service. default: service parent: properties: id: description: The ID of the Service this Orchestration belongs to. type: enum: - service_reference sets: description: A Service Orchestration must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph. items: properties: rules: items: properties: actions: allOf: - properties: route_to: type: string description: The ID of a Set from this Service Orchestration whose rules you also want to use with event that match this rule. - $ref: '#/components/schemas/ServiceOrchestration/allOf/1/properties/orchestration_path/allOf/1/properties/catch_all/properties/actions/allOf/0' - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/1' - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' - $ref: '#/components/schemas/ServiceOrchestration/allOf/1/properties/orchestration_path/allOf/1/properties/catch_all/properties/actions/allOf/3' - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/3' - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/4' catch_all: properties: actions: allOf: - type: object properties: suppress: type: boolean description: If true, the resulting alert is suppressed. Suppressed alerts will not trigger an incident. suspend: type: integer description: The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a resolve event arrives before the alert triggers then PagerDuty won't create an incident for this the resulting alert. - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/1' - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' - type: object properties: pagerduty_automation_actions: type: array description: Configure an Automation Action associated with the resulting incident. items: type: object properties: action_id: type: string description: Automation Action ID - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/3' - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/4' example: orchestration_path: type: service parent: id: PC2D9ML self: https://api.pagerduty.com/service/PC2D9ML type: service_reference self: https://api.pagerduty.com/event_orchestrations/service/PC2D9ML sets: - id: start rules: - label: Always apply some consistent event transformations to all events id: c91f72f3 conditions: [] actions: variables: - name: hostname path: event.component value: 'hostname: (.*)' type: regex extractions: - template: '{{variables.hostname}}' target: event.custom_details.hostname - source: event.source regex: www (.*) service target: event.source incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - id: PN1C4A2 value: '{{event.timestamp}}' route_to: step-two - id: step-two rules: - label: All critical alerts should be treated as P1 incidents id: 7c54529d conditions: - event.severity matches 'critical' actions: annotate: 'Please use our P1 runbook: https://docs.test/p1-runbook' priority: P0IN2KQ suppress: false incident_custom_field_updates: - id: PEXCK89 value: '#p1-incident-response' - label: If the API endpoints return HTTP 502 run an Automation Action that restarts the service id: 8a874630 conditions: - event.custom_details.http_status_code equals '502' actions: pagerduty_automation_actions: - action_id: 01CSB5SMOKCKVRI5GN0LJG7SMB - label: If there's something wrong on the canary let the team know about it in our deployments Slack channel id: 1f6d9a33 conditions: - event.custom_details.hostname matches part 'canary' actions: automation_actions: - name: Canary Slack Notification url: https://our-slack-listerner.test/send-notification auto_send: true headers: - key: X-Notification-Source value: PagerDuty Incident Webhook parameters: - key: channel value: '#my-team-channel' - key: message value: Something is wrong with the canary deployment incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - label: Never bother the on-call for info-level events outside of work hours id: cd770384 conditions: - event.severity matches 'info' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles) actions: suppress: true catch_all: actions: suppress: true incident_custom_field_updates: - id: PEXCK89 value: '#general-incident-notifications' created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference migrated_at: '2023-06-14T13:51:31Z' migrated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference migrated_from: id: PC2D9ML self: https://api.pagerduty.com/services/PC2D9ML/rules type: service_event_rules_reference migrated_status: completed migrated_via: UI version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ Pagination: type: object properties: offset: type: integer description: Echoes offset pagination property. readOnly: true limit: type: integer description: Echoes limit pagination property. readOnly: true more: type: boolean description: Indicates if there are additional records to return readOnly: true total: type: integer description: The total number of records matching the given query. nullable: true readOnly: true OrchestrationGlobal: allOf: - type: object properties: orchestration_path: type: object properties: type: type: string default: service readOnly: true parent: type: object properties: id: type: string description: ID of the object these Orchestration Rules belongs to. readOnly: true type: type: string description: A string that determines the schema of the parent object readOnly: true self: type: string format: url description: The API show URL at which the parent object is accessible readOnly: true readOnly: true sets: type: array description: Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. items: type: object description: A set of rules properties: id: type: string description: The ID of this set of rules. Rules in other sets can route events into this set using the "route_to" properties. default: start rules: type: array items: type: object properties: id: type: string description: ID of the rule readOnly: true label: type: string description: A description of this rule's purpose. conditions: type: array description: Each of these conditions is evaluated to check if an event matches this rule. The rule is considered a match if **any** of these conditions match. items: type: object properties: expression: type: string description: A PCL condition string example: event.summary matches part 'my service error' actions: type: object description: When an event matches this rule, these are the actions that will be taken to change the resulting alert and incident. disabled: type: boolean description: Indicates whether the rule is disabled and would therefore not be evaluated. catch_all: type: object description: When none of the Rules in a set match an event, we apply the catch_all actions to the event. properties: actions: type: object description: These are the actions that will be taken to change the resulting alert and incident. created_at: type: string format: date-time description: The date/time the object was created. readOnly: true created_by: type: object description: Reference to the user that created the object. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true updated_at: type: string format: date-time description: The date/time the object was last updated. readOnly: true updated_by: type: object description: Reference to the user that last updated the object. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true version: type: string description: Version of these Orchestration Rules readOnly: true required: - orchestration_path - type: object properties: orchestration_path: properties: type: description: Indicates that these are a set of "global" rules. default: global parent: properties: id: description: ID of the Global Event Orchestration these Global Rules belongs to. type: enum: - event_orchestration_reference sets: description: You must define at least a "start" set, but you can also define any number of additional sets that are routed to by other rules to form a directional graph. items: properties: rules: items: properties: actions: allOf: - properties: route_to: type: string description: The ID of a Set from this Global Orchestration whose rules you also want to use with event that match this rule. - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/0' - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/1' - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/3' - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/4' catch_all: description: When none of the rules match an event, the event will be routed according to the catch_all settings. properties: actions: allOf: - type: object properties: suppress: type: boolean description: If true, the resulting alert is suppressed. Suppressed alerts will not trigger an incident. suspend: type: integer description: The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a resolve event arrives before the alert triggers then PagerDuty won't create an incident for this the resulting alert. drop_event: type: boolean description: If true, this event will be dropped. Dropped events will not trigger or resolve an alert or an incident. Dropped events will not be evaluated against router rules. - type: object properties: priority: type: string description: The ID of the priority you want to set on resulting incident. You can find the list of priority IDs for your account by calling the priorities endpoint. example: P53ZZH5 annotate: type: string description: Add this text as a note on the resulting incident. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the note. - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' - type: object properties: automation_actions: type: array description: Create a Webhoook associated with the resulting incident. items: type: object properties: name: type: string description: The name of the Webhook. url: type: string description: The API endpoint where PagerDuty's servers will send the webhook request. auto_send: type: boolean description: When true, PagerDuty's servers will automatically send this webhook request as soon as the resulting incident is created. When false, your incident responder will be able to manually trigger the Webhook via the PagerDuty website & mobile app. default: false headers: type: array description: Specify custom key/value pairs that'll be sent with the webhook request as request headers. items: type: object properties: key: type: string value: type: string description: AIOps users can additionally use the {{event}} variable to include elements of the event payload in the header value. parameters: type: array description: Specify custom key/value pairs that'll be included in the webhook request's JSON payload. items: type: object properties: key: type: string value: type: string description: AIOps users can additionally use the {{event}} variable to include elements of the event payload in the parameter value. - type: object properties: incident_custom_field_updates: type: array description: Configure custom field updates for the incident. items: type: object properties: id: type: string description: Unique identifier for the custom field resource. You can find the list of IDs by calling the List Custom Fields endpoint. example: PEXCK89 value: type: string description: A value that will be used to populate the specified Incident Custom Field. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the custom field value. example: High CPU on server example: $ref: '#/components/examples/OrchestrationPathGlobalTypeResponse/value' Orchestration: type: object properties: id: type: string description: ID of the Orchestration. readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true name: type: string description: Name of the Orchestration. description: type: string description: A description of this Orchestration's purpose. team: type: object description: Reference to the team that owns the Orchestration. If none is specified, only admins have access. properties: id: type: string type: type: string description: A string that determines the schema of the object readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true integrations: type: array items: $ref: '#/components/schemas/OrchestrationIntegration' readOnly: true routes: type: integer description: Number of different Service Orchestration being routed to readOnly: true created_at: type: string format: date-time description: The date the Orchestration was created at. readOnly: true created_by: type: object description: Reference to the user that has created the Orchestration. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true updated_at: type: string format: date-time description: The date the Orchestration was last updated. readOnly: true updated_by: type: object description: Reference to the user that has updated the Orchestration last. properties: id: type: string readOnly: true type: type: string description: A string that determines the schema of the object readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true readOnly: true version: type: string description: Version of the Orchestration. readOnly: true OrchestrationRouter: allOf: - $ref: '#/components/schemas/OrchestrationGlobal/allOf/0' - type: object properties: orchestration_path: properties: type: description: Indicates that these are a "router" type set of rules. default: router parent: properties: id: description: ID of the Global Event Orchestration this Router belongs to. type: enum: - event_orchestration_reference sets: description: The Router contains a single set of rules (the "start" set). The Router evaluates Events against these Rules, one at a time, and routes each Event to a specific Service based on the first rule that matches. maxItems: 1 minItems: 1 items: properties: rules: items: properties: actions: properties: route_to: type: string description: The ID of the target Service for the resulting alert. You can find the service you want to route to by calling the services endpoint. example: PSI2I2O catch_all: description: When none of the rules match an event, the event will be routed according to the catch_all settings. properties: actions: properties: route_to: description: With a value of 'unrouted', all events are sent to the Unrouted Orchestration. type: string default: unrouted example: orchestration_path: type: router parent: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 type: event_orchestration_reference self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router sets: - id: start rules: - label: Events relating to our relational database id: 1c26698b conditions: - expression: event.summary matches part 'database' - expression: event.source matches regex 'db[0-9]+-server' actions: route_to: PB31XBA - label: Events relating to our www app server id: d9801904 conditions: - expression: event.summary matches part 'www' actions: route_to: PC2D9ML catch_all: actions: route_to: unrouted created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: 9co0z4b152oICsoV91_PW2.ww8ip_xap OrchestrationWarningInvalidData: type: object description: This rule includes invalid data for a feature item. properties: message: type: string description: A description of the warning and any potential side effects. rule_id: type: string description: The ID of the rule using the feature. feature: type: string description: "The feature that includes invalid data.\n\nExample values include:\n * `incident_custom_field_updates`\n * `cache_variable:annotate`\n * `cache_variable:conditions`\n * `cache_variable:automation_actions`\n" feature_type: type: string description: "Specifies the feature type of the impacted item.\n\nExample values include:\n * `actions`\n * `conditions`\n" warning_type: type: string description: The type of warning that is being returned for the rule. enum: - invalid_data OrchestrationWarningIneligible: type: object description: This rule is using a feature that is currently unavailable on the current account plan. properties: message: type: string description: A description of the warning and any potential side effects. rule_id: type: string description: The ID of the rule using the feature. feature: type: string description: 'The feature that the current account plan does not have access to. Example values include: * `threshold_condition` * `nested_rules` * `suspend` * `automation_actions` * `cache_variable:automation_actions` * `cache_variable:annotate` * `variables` * `interpolation:annotate` * `interpolation:extractions` * `interpolation:incident_custom_field_updates` * `suppress` * `incident_custom_field_updates` ' feature_type: type: string description: 'Specifies whether the feature is a part of the rule''s conditions, or its actions. Example values include: * `conditions` * `actions` * `nested_rules` * `global_orchestrations` ' warning_type: type: string description: The type of warning that is being returned for the rule. enum: - forbidden_feature OrchestrationUnrouted: allOf: - $ref: '#/components/schemas/OrchestrationGlobal/allOf/0' - type: object properties: orchestration_path: properties: type: description: Indicates that these are a "unrouted" type set of rules. default: unrouted parent: properties: id: description: ID of the Global Event Orchestration this Unrouted Orchestration belongs to. type: enum: - event_orchestration_reference sets: description: An Unrouted Orchestration must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph. items: properties: rules: items: properties: actions: allOf: - properties: route_to: type: string description: The ID of a Set from this Unrouted Orchestration whose rules you also want to use with event that match this rule. - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' catch_all: properties: actions: type: object properties: severity: type: string description: Set the severity of the resulting alert. enum: - info - error - warning - critical event_action: type: string description: Set whether the resulting alert status is trigger or resolve. enum: - trigger - resolve variables: type: array description: Populate variables from event payloads and use those variables in other event actions. items: type: object properties: name: type: string description: The name of the variable example: server_name path: type: string description: Path to a field in an event, in dot-notation. example: event.summary type: type: string description: The type of operation to populate the variable. Currently only Regex-based variable extraction is supported. enum: - regex value: type: string description: A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used. example: High CPU on (.*) server extractions: type: array description: Dynamically extract values to set and modify new and existing PD-CEF fields. items: anyOf: - type: object description: Use a template string & variables properties: target: type: string description: The PD-CEF field that will be set with the value from the template. example: event.summary template: type: string description: A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation. example: High CPU on {{hostname}} server - type: object description: Use a regex to extract a value properties: target: type: string description: The PD-CEF field that will be set with the value from the regex. example: event.custom_details.server regex: type: string description: A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used. example: High CPU on (.*) server source: type: string description: The path to the event field where the regex will be applied to extract a value. example: event.summary example: orchestration_path: type: unrouted parent: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 type: event_orchestration_reference self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router sets: - id: start rules: - label: Update the summary of un-matched Critical alerts so they're easier to spot id: 38880ffb conditions: - expression: event.severity matches 'critical' actions: extractions: - target: event.summary template: '[Critical Unrouted] {{event.summary}}' - label: Reduce the severity of all other unrouted events id: 3896801e conditions: [] actions: severity: info catch_all: actions: suppress: true created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: aZO.EEf9zWb9Vg0NYq.Uqad1hOC2Maod examples: OrchestrationPathGlobalTypeResponse: summary: Example Response value: orchestration_path: type: global parent: id: b02e973d-9620-4e0a-9edc-00fedf7d4694 self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694 type: event_orchestration_reference self: https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global sets: - id: start rules: - label: Always apply some consistent event transformations to all events id: c91f72f3 conditions: [] actions: variables: - name: hostname path: event.component value: 'hostname: (.*)' type: regex extractions: - template: '{{variables.hostname}}' target: event.custom_details.hostname - source: event.source regex: www (.*) service target: event.source incident_custom_field_updates: - id: PEXCK89 value: '#my-team-channel' - id: PN1C4A2 value: '{{event.timestamp}}' route_to: step-two - id: step-two rules: - label: All critical alerts should be treated as P1 incidents id: 7c54529d conditions: - expression: event.severity matches 'critical' actions: priority: P0IN2KQ suppress: false incident_custom_field_updates: - id: PEXCK89 value: '#p1-incident-response' - label: Drop all events from the very-noisy monitoring tool id: 1f6d9a33 conditions: - expression: event.source matches part 'very-noisy' actions: drop_event: true - label: Never bother the on-call for info-level events outside of work hours id: cd770384 conditions: - expression: event.severity matches 'info' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles) actions: suppress: true catch_all: actions: suppress: true incident_custom_field_updates: - id: PEXCK89 value: '#general-incident-notifications' created_at: '2021-11-18T16:42:01Z' created_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference updated_at: '2021-11-18T16:42:01Z' updated_by: id: P8B9WR8 self: https://api.pagerduty.com/users/P8B9WR8 type: user_reference version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ requestBodies: OrchestrationCacheVariablePostRequest: content: application/json: schema: type: object properties: cache_variable: $ref: '#/components/schemas/OrchestrationCacheVariable' required: - cache_variable examples: recent_value: summary: 'Request Example: Recent value cache variable' value: cache_variable: name: example_1 conditions: - expression: not event.custom_details.errors exists configuration: type: recent_value source: event.summary regex: .* trigger_event_count: summary: 'Request Example: Trigger event count cache variable' value: cache_variable: name: example_2 configuration: type: trigger_event_count ttl_seconds: 30 OrchestrationCacheVariablePutRequest: content: application/json: schema: type: object properties: cache_variable: $ref: '#/components/schemas/OrchestrationCacheVariable' required: - cache_variable examples: update_conditions: summary: 'Request Example: Update conditions' value: cache_variable: name: example_1 conditions: - expression: event.summary matches 'exception' - expression: event.summary matches 'error' update_configuration: summary: 'Request Example: Update configuration' value: cache_variable: name: example_1 configuration: type: trigger_event_count ttl_seconds: 2 update_disabled: summary: 'Request Example: Update disabled state' value: cache_variable: name: example_1 disabled: true securitySchemes: api_key: type: apiKey name: Authorization in: header description: The API Key with format `Token token=`