alerting-v2

Delete rules in bulk by ID

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

Refer to Spaces for more information.

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

post/api/alerting/v2/rules/_bulk_delete

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/alerting/v2/rules/_bulk_delete
  • 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 result of the bulk delete operation.

affected_countinteger required

Number of resources the operation successfully touched.

Changes