Update an Event Rule on a Service

Update an Event Rule on a Service. Note that the endpoint supports partial updates, so any number of the writable fields can be provided.

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

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

id*string

The ID of the resource.

rule_id*string

The id of the Event Rule to retrieve.

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

TypeScript Definitions

Use the request body type in TypeScript.

rule?

rule_id*string

The id of the Event Rule to update on the Service.

Response Body

`application/json`

curl -X PUT "https://example.com/services/{id}/rules/{rule_id}" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "rule_id": "7123bdd1-74e8-4aa7-aa38-4a9ebe123456",    "rule": {      "actions": {        "suppress": {          "value": true        }      }    }  }'

{  "rule": {    "id": "14e56445-ebab-4dd0-ba9d-fc28a41b7e7b",    "position": 0,    "disabled": false,    "self": "https://api.pagerduty.com/services/PI2KBWI/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b",    "conditions": {      "operator": "and",      "subconditions": [        {          "operator": "contains",          "parameters": {            "value": "mysql",            "path": "class"          }        }      ]    },    "time_frame": {      "active_between": {        "start_time": 1577880000000,        "end_time": 1580558400000      }    },    "actions": {      "annotate": {        "value": "This incident was modified by an Event Rule"      },      "priority": {        "value": "PCMUB6F"      },      "severity": {        "value": "warning"      },      "extractions": [        {          "target": "dedup_key",          "source": "custom_details.error_summary",          "regex": "Host (.*) is experiencing errors"        }      ]    }  }}

Update an Event Rule on a Service

End-of-life

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`