Get the Service Orchestration for a Service

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

Scoped OAuth requires: services.read

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

service_id*string

The service ID

Query Parameters

include[]?"migrated_metadata"

Array of additional Models to include in response.

Value in

"migrated_metadata"

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Response Body

`application/json`

curl -X GET "https://example.com/event_orchestrations/services/{service_id}" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json"

{  "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",                  "trigger_types": [                    "alert_triggered"                  ]                }              ],              "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"                    }                  ],                  "trigger_types": [                    "alert_triggered"                  ]                }              ],              "incident_custom_field_updates": [                {                  "id": "PEXCK89",                  "value": "#my-team-channel"                }              ]            }          },          {            "label": "Pause the alert and trigger a reboot action if flaky server receives an error",            "id": "c0163dbe",            "conditions": [              {                "expression": "event.custom_details.hostname matches part 'staging'"              }            ],            "actions": {              "suspend": 300,              "pagerduty_automation_actions": [                {                  "action_id": "01CSBCGJXMG7ABIJZKPD8P9RCL",                  "trigger_types": [                    "alert_suspended"                  ]                }              ]            }          },          {            "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_"  }}

Get the Service Orchestration for a Service

Authorization

Path Parameters

Query Parameters

Header Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`