stack kb alerting-v2 put-alerting-v2-action-policies-id cli command

elastic stack kb alerting-v2 put-alerting-v2-action-policies-id \
  --id <id> \
  --description <description> \
  --destinations <destinations> \
  --name <name> \
  [options]

Create or replace an action policy

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--id string 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 alert episodes 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.

--description string required

A description of the action policy.

--destinations string[] required

The list of destinations. At least one is required.

Repeatable: pass --destinations multiple times to supply more than one value

--name string required

The name of the action policy.

--enabled

Whether the action policy is enabled. On create, defaults to true when omitted. On replace, omitting this field preserves the existing enabled state; otherwise it becomes the new stored value.

--group-by string[]

The fields used to group alerts.

Repeatable: pass --group-by multiple times to supply more than one value

--grouping-mode string

The grouping mode for alert notifications.

--matcher string

Selects the alerts this policy applies to. Set tags to match alerts from rules with those tags. Set expression to a KQL query, which will be evaluated against each alert. <br/><br/> If you set both tags and expression, an alert must match the tags and the expression for the policy to apply. When matcher is null, or when both tags and expression are empty, the policy applies to all alerts.

--throttle string

The throttle configuration for notifications.

--input-file string

path to a JSON file to use as command input

--dry-run

validate all inputs and exit without performing any action (preview changes without applying them)

--no-validate

skip input validation and send the request as-is

--output-fields string

comma-separated list of fields to include in output (dot-notation supported)

--output-template string

Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")

--json

output as JSON