alerting-v2

Create or replace an action policy

Changed on

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Creates an action policy with the given identifier, or fully replaces it if one already exists.<br/><br/>[Required authorization] Route required privileges: manage_alerting-v2-action-policies AND read_alerting-v2-rules.

put/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

Request body

descriptionstring

A description of the action policy. Absent when the policy has none; send null on PATCH to clear it.

namestring required

The name of the action policy.

Response

Returns the replaced action policy.

created_atstring date-time required

The ISO datetime when the action policy was created.

descriptionstring

A description of the action policy. Omitted when the policy has none.

enabledboolean required

Whether the action policy is enabled.

idstring required

The unique identifier for the action policy.

namestring required

The name of the action policy.

snoozed_untilstring

The ISO datetime until which the policy is snoozed. Omitted when the policy is not snoozed.

updated_atstring date-time required

The ISO datetime when the action policy was last updated.

Changes