v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Rulesets

List Event Rules

List all Event Rules on a Ruleset.

<!-- 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.read

get/rulesets/{id}/rules

Path parameters

idstring required

The ID of the resource.

Query parameters

limitinteger

The number of results per page.

offsetinteger

Offset to start pagination search results.

totalboolean

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated.

See our Pagination Docs for more information.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

A paginated array of Event Rule objects.

offsetinteger

Echoes offset pagination property.

limitinteger

Echoes limit pagination property.

moreboolean

Indicates if there are additional records to return

totalinteger nullable

The total number of records matching the given query.

Example response

{
  "rules": [
    {
      "actions": {
        "extractions": [
          {
            "template": "Error number {{count}} on host {{host}}"
          }
        ]
      }
    }
  ]
}