Create or replace an action policy

Base URL: https://{kibana_url}

PUT /api/alerting/v2/action_policies/{id}
PUT /s/{space_id}/api/alerting/v2/action_policies/{id}

Auth

Creates an action policy with the given identifier, or fully replaces it if one already exists.

Required privileges

Privileges manage_alerting-v2-action-policies and read_alerting-v2-rules

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
id string · min length: 1 · max length: 150 · pattern: ^[a-zA-Z0-9_-]+$ 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.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

description string · min length: 1 · max length: 1024: A description of the action policy. Absent when the policy has none; send null on PATCH to clear it.
destinations union oneOf[] · min items: 1 · max items: 10 required: The list of destinations. At least one is required. Each one can appear at most once.; One of:
grouping union oneOf: One of: (determined by mode)
matcher object: Selects the alerts this policy applies to. Set tags to match alerts from rules with those routing tags. Set expression to a KQL query, which will be evaluated against each alert.

If you set both tags and expression, an alert must match the tags and the expression for the policy to apply. At least one of tags and expression must be set, so an empty matcher is rejected. Omit matcher entirely for a catch-all policy that applies to all alerts.
name string · min length: 1 · max length: 256 required: The name of the action policy.
throttle union oneOf: One of: (determined by strategy)

Responses

Returns the replaced action policy.

application/json

created_at string · format: date-time · max length: 64 required: The ISO datetime when the action policy was created.
created_by object required: The actor who created the action policy.
description string: A description of the action policy. Omitted when the policy has none.
destinations union oneOf[] required: The list of destinations.; One of:
enabled boolean required: Whether the action policy is enabled.
grouping union oneOf: One of: (determined by mode)
id string required: The unique identifier for the action policy.
matcher object: Selects the alerts this policy applies to. Set tags to match alerts from rules with those routing tags. Set expression to a KQL query, which will be evaluated against each alert.

If you set both tags and expression, an alert must match the tags and the expression for the policy to apply. At least one of tags and expression must be set, so an empty matcher is rejected. Omit matcher entirely for a catch-all policy that applies to all alerts.
name string required: The name of the action policy.
snoozed_until string: The ISO datetime until which the policy is snoozed. Omitted when the policy is not snoozed.
throttle union oneOf: One of: (determined by strategy)
updated_at string · format: date-time · max length: 64 required: The ISO datetime when the action policy was last updated.
updated_by object required: The actor who last updated the action policy.

Returns the newly created action policy.

application/json

created_at string · format: date-time · max length: 64 required: The ISO datetime when the action policy was created.
created_by object required: The actor who created the action policy.
description string: A description of the action policy. Omitted when the policy has none.
destinations union oneOf[] required: The list of destinations.; One of:
enabled boolean required: Whether the action policy is enabled.
grouping union oneOf: One of: (determined by mode)
id string required: The unique identifier for the action policy.
matcher object: Selects the alerts this policy applies to. Set tags to match alerts from rules with those routing tags. Set expression to a KQL query, which will be evaluated against each alert.

If you set both tags and expression, an alert must match the tags and the expression for the policy to apply. At least one of tags and expression must be set, so an empty matcher is rejected. Omit matcher entirely for a catch-all policy that applies to all alerts.
name string required: The name of the action policy.
snoozed_until string: The ISO datetime until which the policy is snoozed. Omitted when the policy is not snoozed.
throttle union oneOf: One of: (determined by strategy)
updated_at string · format: date-time · max length: 64 required: The ISO datetime when the action policy was last updated.
updated_by object required: The actor who last updated the action policy.

Indicates an invalid schema or parameters.

application/json

Indicates the request was not authenticated.

application/json

Indicates the user does not have the required privileges, or the current license does not support action policies. Creating, updating, upserting, and enabling action policies requires an active Enterprise license. Reading, disabling, snoozing, deleting, and rotating the API key of an existing policy do not, so existing policies can still be maintained after a license lapses.

application/json

Indicates the action policy was created or updated concurrently by another caller.

application/json

Indicates an unexpected server-side error.

application/json

Indicates the alerting engine is disabled by the alerting:v2:enabled advanced setting.

application/json

Required privileges

Path parameters

Header parameters

Request body { }

Responses

Request body