Update the Global Orchestration for an Event Orchestration

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

Scoped OAuth requires: event_orchestrations.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

id*string

The ID of an Event Orchestration.

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"

Request Body

application/json

Update Global Orchestration rules. Omitted rules and rule details are deleted.

TypeScript Definitions

Use the request body type in TypeScript.

orchestration_path*

Response Body

`application/json`

curl -X PUT "https://example.com/event_orchestrations/{id}/global" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "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": "Assign all database related incidents to the Database Team\'s escalation policy",              "id": "4314d9ce",              "conditions": [                {                  "expression": "event.source matches \'prod-db\'"                }              ],              "actions": {                "escalation_policy": "PEYSGVF"              }            },            {              "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"          }        ]      }    }  }'

{  "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": "Assign all database related incidents to the Database Team's escalation policy",            "id": "4314d9ce",            "conditions": [              {                "expression": "event.source matches 'prod-db'"              }            ],            "actions": {              "escalation_policy": "PEYSGVF"            }          },          {            "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"    }  ]}

Update the Global Orchestration for an Event Orchestration

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

405application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`