rules
Overview
Name | rules |
Type | Resource |
Id | pagerduty.services.rules |
Fields
Name | Datatype | Description |
---|---|---|
id | string | ID of the Event Rule. |
actions | object | When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident. |
conditions | object | Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though. |
disabled | boolean | Indicates whether the Event Rule is disabled and would therefore not be evaluated. |
position | integer | Position/index of the Event Rule on the Service. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached. |
self | string | the API show URL at which the object is accessible. |
time_frame | object | Time-based conditions for limiting when the rule is active. |
variables | array | [Early Access] Populate variables from event payloads and use those variables in other event actions. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_service_event_rule | SELECT | id, rule_id | Get an Event Rule from a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you migrate to Event Orchestration as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: services.read |
list_service_event_rules | SELECT | id | List Event Rules on a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you migrate to Event Orchestration as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: services.read |
create_service_event_rule | INSERT | id, data__rule | Create a new Event Rule on a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you migrate to Event Orchestration as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: services.write |
delete_service_event_rule | DELETE | id, rule_id | Delete an Event Rule from a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you migrate to Event Orchestration as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: services.write |
_get_service_event_rule | EXEC | id, rule_id | Get an Event Rule from a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you migrate to Event Orchestration as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: services.read |
_list_service_event_rules | EXEC | id | List Event Rules on a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you migrate to Event Orchestration as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: services.read |
update_service_event_rule | EXEC | id, rule_id, data__rule_id | Update an Event Rule on a Service. Note that the endpoint supports partial updates, so any number of the writable fields can be provided. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you migrate to Event Orchestration as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: services.write |