alerting-v2

List rules

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/alerting/v2/rules</span></div>

Refer to Spaces for more information.

[Required authorization] Route required privileges: read_alerting-v2-rules.

get/api/alerting/v2/rules

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/alerting/v2/rules
  • Auth
    • API key in header Authorization
    • or HTTP basic

Query parameters

pageinteger

The page number to return. Defaults to 1. page * per_page cannot exceed 10000.

per_pageinteger

The number of rules to return per page. Defaults to 20.

filterstring

A KQL filter to apply to the rules. Supported fields: id, kind, enabled, metadata.name, metadata.description, metadata.tags, metadata.routing_tags. Cannot be empty. Omit it to list every rule.

sort_field'kind' | 'enabled' | 'name'

The field to sort rules by.

sort_order'asc' | 'desc'

The direction to sort rules.

searchstring

A text string to search across rule fields.

Response

Returns a paginated list of rules.

pagenumber required

The current page number.

per_pagenumber required

The number of rules per page.

totalnumber required

The number of rules matching the query. This count is an estimate: results above 10,000 may be reported as 10,000.

Changes

  • 883cd57e9ac7Revision changes
    • breaking

      for the query request parameter page, the type changed from number to integer

    • breaking

      for the query request parameter per_page, the type changed from number to integer

    • warning

      for the query request parameter page, the max was set to 10000.00

  • e2104277117cRevision changes
    • info

      added subschema #1 subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 to the // response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the // response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the // response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the // response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the // response property anyOf list for the response status