router
Creates, updates, deletes, gets or lists a router resource.
Overview
| Name | router |
| Type | Resource |
| Id | pagerduty.event_orchestrations.router |
Fields
The following fields are returned by SELECT queries:
- get_orch_path_router
The Orchestration Router object.
| Name | Datatype | Description |
|---|---|---|
catch_all | | When none of the rules match an event, the event will be routed according to the catch_all settings. |
parent | | |
sets | | 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. |
type | | Indicates that these are a "router" type set of rules. (default: router) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_orch_path_router | select | id | Accept, Content-Type | 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 Scoped OAuth requires: event_orchestrations.read |
_get_orch_path_router | exec | id | Accept, Content-Type | 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 Scoped OAuth requires: event_orchestrations.read |
update_orch_path_router | exec | id, orchestration_path | Accept, Content-Type | 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 Scoped OAuth requires: event_orchestrations.write |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string | The ID of an Event Orchestration. |
Accept | string | The Accept header is used as a versioning header. |
Content-Type | string |
SELECT examples
- get_orch_path_router
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
Scoped OAuth requires: event_orchestrations.read
SELECT
catch_all,
parent,
sets,
type
FROM pagerduty.event_orchestrations.router
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;
Lifecycle Methods
- _get_orch_path_router
- update_orch_path_router
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
Scoped OAuth requires: event_orchestrations.read
EXEC pagerduty.event_orchestrations.router._get_orch_path_router
@id='{{ id }}' --required,
@Accept='{{ Accept }}',
@Content-Type='{{ Content-Type }}'
;
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
Scoped OAuth requires: event_orchestrations.write
EXEC pagerduty.event_orchestrations.router.update_orch_path_router
@id='{{ id }}' --required,
@Accept='{{ Accept }}',
@Content-Type='{{ Content-Type }}'
@@json=
'{
"orchestration_path": "{{ orchestration_path }}"
}'
;