alerting-v2

Delete an action policy

Changed on

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Deletes the action policy whose ID you include in the URL path. Use the id returned when you created the policy, or from get or list. This request has no body.<br/><br/>[Required authorization] Route required privileges: manage_alerting-v2-action-policies.

delete/api/alerting/v2/action_policies/{id}

Request

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

Path parameters

idstring required

The ID of the action policy. Copy it from the response when you create a policy, fetch one policy, or fetch the policy list. Chosen at creation and permanent — it cannot be changed afterwards. Re-using the id of a deleted resource is allowed but discouraged: execution history, change history, and alerts recorded under that id are retained and are attributed to the new resource. Ids appear in URLs and logs, so keep them free of sensitive data.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Response

The action policy was deleted successfully.

Changes