v1
latestOpenAPI 3.0.22026-07-144652931.4 MBUpdate an Event Rule
Update an Event Rule. 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.
Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.
For more information see the API Concepts Document
Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.
Scoped OAuth requires: event_rules.write
Path parameters
The ID of the resource.
The id of the Event Rule to retrieve.
Headers
The Accept header is used as a versioning header.
Request body
Example request
{
"rule": {
"actions": {
"extractions": [
{
"template": "Error number {{count}} on host {{host}}"
}
]
}
}
}Response
The Event Rule that was updated.
Example response
{
"rule": {
"actions": {
"extractions": [
{
"template": "Error number {{count}} on host {{host}}"
}
]
}
}
}