alerting-v2

List action policies

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/action_policies</span></div>

Refer to Spaces for more information.

Get a paginated list of action policies with optional filtering and sorting.<br/><br/>[Required authorization] Route required privileges: read_alerting-v2-action-policies.

get/api/alerting/v2/action_policies

Request

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

Query parameters

pageinteger

The page number to return. Defaults to 1.

per_pageinteger

The number of action policies to return per page. Defaults to 20.

filterstring

A KQL filter to apply to the action policies. Supported fields: id, name, description, enabled. Cannot be empty. Omit it to list every action policy.

searchstring

A text string to search across action policy fields.

sort_field'name' | 'created_at' | 'updated_at'

The field to sort action policies by.

sort_order'asc' | 'desc'

The sort direction.

Response

Returns a paginated list of action policies.

pagenumber required

The current page number.

per_pagenumber required

The number of action policies per page.

totalnumber required

The number of action policies 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

  • 1078d5597eb4Revision changes
    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter tags