Overview
Updates the router configuration for a specific event orchestration. This allows you to modify routing rules, conditions, and actions.
This is a write tool that modifies your PagerDuty account. It requires the --enable-write-tools flag to be enabled.
Parameters
The ID of the event orchestration to update
router_update
EventOrchestrationRouterUpdateRequest
required
The updated router configuration Show EventOrchestrationRouterUpdateRequest properties
orchestration_path
EventOrchestrationPathUpdateRequest
required
The router path configuration to update Show EventOrchestrationPathUpdateRequest properties
Array containing exactly one rule set (the “start” set). Maximum length: 1. Show EventOrchestrationRuleSet properties
ID of the rule set. For routers, this is typically “start”.
List of routing rules to evaluate in order Show EventOrchestrationRule properties
Description of this rule’s purpose
Conditions to match. Rule matches if ANY condition is true. Show EventOrchestrationRuleCondition properties
PCL condition string Example: event.summary matches part 'database error'
actions
EventOrchestrationRuleActions
required
Actions to take when rule matches Service ID to route the event to
Dynamically route based on event payload (AIOps only)
Whether this rule is disabled
catch_all
EventOrchestrationCatchAll
required
Actions when no rules match actions
EventOrchestrationRuleActions
required
Default routing actions
Response
Returns the updated EventOrchestrationRouter object with the new configuration.
Usage Examples
Update routing rules
Update the router for orchestration P1A2B3C to route database errors to service PABCDEF
Disable a routing rule
Disable the first routing rule in orchestration P1A2B3C
Change catch-all behavior
Update orchestration P1A2B3C to route unmatched events to the default service
This tool replaces the entire router configuration. Make sure to include all rules you want to keep. Consider using append_event_orchestration_router_rule if you only want to add a new rule.
PCL Expression Examples
PagerDuty Common Expression Language (PCL) is used for rule conditions:
event.summary matches part 'database' - Summary contains “database”
event.severity equals 'critical' - Severity is critical
event.source matches regex 'prod-.*' - Source matches pattern
event.custom_details.region equals 'us-west-2' - Custom field match