Sign in
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

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

descriptionstring required

A description of the action policy.

group_bystring[]

The fields used to group alerts.

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 required

A description of the action policy.

enabledboolean required

Whether the action policy is enabled.

group_bystring[] nullable required

The fields used to group alerts, or null for no grouping.

idstring required

The unique identifier for the action policy.

namestring required

The name of the action policy.

snoozed_untilstring nullable required

The ISO datetime until which the policy is snoozed, or null if not snoozed.

updated_atstring date-time required

The ISO datetime when the action policy was last updated.

versionstring

The version, used for optimistic concurrency control.

Changes

Changed in 4 of the 176 revisions of this API.325

  • 883cd57e9ac71See the full diff
    • ●

      the / request property's maxLength was set to 32

      request-property-max-length-set

  • 1078d5597eb411See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the request property

      request-property-removed

  • cf530633f03b24See the full diff
    • ▲

      the request property type changed from string to object

      request-property-type-changed

    • ▲

      the response's property type changed from string to object for status

      response-property-type-changed

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • e9badbb5da991See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 176 revisions, 20 have no diff computed.