alerting-v2

Get rules in bulk

Changed on

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Returns the requested rules. Ids that match no rule are reported per item in errors as RULE_NOT_FOUND. The request itself succeeds as long as it is valid.<br/><br/>[Required authorization] Route required privileges: read_alerting-v2-rules.

post/api/alerting/v2/rules/_bulk_get

Request

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

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

idsstring[] required

Explicit list of IDs to operate on. Each id can appear at most once.

Response

Returns the rules that were found in items and a per-item error in errors for every id that matched no rule.

Changes

  • 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

  • 93e11b266872Revision changes
    • breaking

      the response property /////// became optional for the status