v1

latestOpenAPI 3.0.22026-07-144652931.4 MB

Recommendations

List recommended rules

List AI-generated recommended rules available for an account's Service Event Orchestrations.

Results can be filtered by service or team. Use cursor-based pagination to retrieve large result sets.

Note: service_id and service_ids[] cannot be used together in the same request.

Scoped OAuth requires: recommendations.read

get/recommendations/event_orchestrations/rules

Query parameters

service_idstring

Filter recommended rules for a single service. Cannot be combined with service_ids[].

service_ids[]string[]

Filter recommended rules for multiple services. Cannot be combined with service_id.

team_ids[]string[]

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

actions[]string[]

Filter recommended rules by action type.

limitinteger

The number of results per page.

cursorstring

Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

A list of recommended rules for the account's Service Event Orchestrations.

next_cursorstring nullable

Cursor to retrieve the next page of results. Null if there are no more results.

Example response

{
  "recommended_rules": [
    {
      "recommendation_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "description": "Suppress alerts where event.summary matches 'disk usage'",
      "pcl_expr": "event.summary matches part 'disk usage'",
      "parent": {
        "id": "P1ABC23"
      }
    }
  ]
}