alerting-v2

Create an action policy

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

Refer to Spaces for more information.

Creates an action policy with a server-generated identifier. To create or replace an action policy with a client-supplied identifier, use PUT /api/alerting/v2/action_policies/{id}/.<br/><br/>[Required authorization] Route required privileges: manage_alerting-v2-action-policies AND read_alerting-v2-rules.

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

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 newly created 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