Headers

• kbn-xsrf string Required

  A required header to protect against CSRF attacks

Responses

• 201 application/json

  Returns the newly created action policy.

  Hide response attributes Show response attributes object

  • auth object Required

    Authentication and ownership information.

    Additional properties are NOT allowed.

    Hide auth attributes Show auth attributes object

    • created_by_user boolean Required

      Whether this policy was created by a user (vs system-generated).

    • owner string Required

      The owner of the action policy.

  • created_at string Required

    The ISO datetime when the action policy was created.

  • created_by string | null Required

    The user ID who created the action policy.

  • description string Required

    A description of the action policy.

  • destinations array[object] Required

    The list of destinations.

    Hide destinations attributes Show destinations attributes object

    An action policy destination configuration.

    • id string Required

      The workflow connector identifier.

      Minimum length is 1, maximum length is 150.

    • type string Required Discriminator

      The destination type.

      Value is workflow.

  • enabled boolean Required

    Whether the action policy is enabled.

  • group_by array[string] | null Required

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

  • grouping_mode string Required

    The grouping mode for alert notifications.

    Any of:

    string-1 string string-2 string string-3 string

    one notification per alert episode lifecycle (default).

    Value is per_episode.

    a single notification for all matching episodes.

    Value is all.

    group by specified groupBy fields.

    Value is per_field.

  • id string Required

    The unique identifier for the action policy.

  • matcher object | null Required

    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.
    
    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.

    Additional properties are NOT allowed.

    Hide matcher attributes Show matcher attributes object | null

    • expression string | null

      A KQL query that's evaluated against each alert. Supported fields are: episode_id, episode_status, group_hash, last_event_timestamp, severity, and your rule's query output columns under data.* (for example, data.host.name). Referencing other fields won't work. Omit matcher.expression or set it to null to match on tags alone.

      Maximum length is 4096.

    • tags array[string] | null

      Rule tags this policy should match. The policy applies to alerts from any rule that has at least one of these tags. Omit matcher.tags or set it to null to match on matcher.expression alone.

      Not more than 50 elements. Minimum length of each is 1, maximum length of each is 256.

  • name string Required

    The name of the action policy.

  • snoozed_until string | null Required

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

  • throttle object | null Required

    The throttle configuration for notifications.

    Additional properties are NOT allowed.

    Hide throttle attributes Show throttle attributes object | null

    • interval string | null Required

      The throttle interval duration (e.g. 5m, 1h), or null when the strategy is intervalless.

      Maximum length is 32.

    • strategy string

      The throttle strategy.

      Any of:

      string-1 string string-2 string string-3 string string-4 string

      notify only on episode status transitions (default for per_episode).

      Value is on_status_change.

      notify on transitions and at regular intervals.

      Value is per_status_interval.

      notify at regular intervals regardless of status (default for all/per_field).

      Value is time_interval.

      notify on every evaluation cycle (high volume).

      Value is every_time.

  • updated_at string Required

    The ISO datetime when the action policy was last updated.

  • updated_by string | null Required

    The user ID who last updated the action policy.

  • version string

    The version, used for optimistic concurrency control.

• 400 application/json

  Indicates an invalid schema or parameters.

  Hide response attributes Show response attributes object

  • code string Required

    Stable error code you can branch on, for example INVALID_SCHEDULE or RULE_ALREADY_EXISTS.

  • details object

    Optional extra information about the error, for example field validation issues or the rule_id when that ID already exists.

    Additional properties are allowed.

  • error string Required

    A short human-readable summary of the error category (e.g., "Not Found", "Bad Request"). Subject to change without notice. Do not parse or rely on its content.

  • message string Required

    A readable explanation of the error. The wording can change without notice. Do not parse this field.

• 401 application/json

  Indicates the request was not authenticated.

  Hide response attributes Show response attributes object

  • code string Required

    Stable error code you can branch on, for example INVALID_SCHEDULE or RULE_ALREADY_EXISTS.

  • details object

    Optional extra information about the error, for example field validation issues or the rule_id when that ID already exists.

    Additional properties are allowed.

  • error string Required

    A short human-readable summary of the error category (e.g., "Not Found", "Bad Request"). Subject to change without notice. Do not parse or rely on its content.

  • message string Required

    A readable explanation of the error. The wording can change without notice. Do not parse this field.

• 403 application/json

  Indicates the user does not have the required privileges to perform the request.

  Hide response attributes Show response attributes object

  • code string Required

    Stable error code you can branch on, for example INVALID_SCHEDULE or RULE_ALREADY_EXISTS.

  • details object

    Optional extra information about the error, for example field validation issues or the rule_id when that ID already exists.

    Additional properties are allowed.

  • error string Required

    A short human-readable summary of the error category (e.g., "Not Found", "Bad Request"). Subject to change without notice. Do not parse or rely on its content.

  • message string Required

    A readable explanation of the error. The wording can change without notice. Do not parse this field.

• 500 application/json

  Indicates an unexpected server-side error.

  Hide response attributes Show response attributes object

  • code string Required

    Stable error code you can branch on, for example INVALID_SCHEDULE or RULE_ALREADY_EXISTS.

  • details object

    Optional extra information about the error, for example field validation issues or the rule_id when that ID already exists.

    Additional properties are allowed.

  • error string Required

    A short human-readable summary of the error category (e.g., "Not Found", "Bad Request"). Subject to change without notice. Do not parse or rely on its content.

  • message string Required

    A readable explanation of the error. The wording can change without notice. Do not parse this field.

• 503 application/json

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

  Hide response attributes Show response attributes object

  • code string Required

    Stable error code you can branch on, for example INVALID_SCHEDULE or RULE_ALREADY_EXISTS.

  • details object

    Optional extra information about the error, for example field validation issues or the rule_id when that ID already exists.

    Additional properties are allowed.

  • error string Required

    A short human-readable summary of the error category (e.g., "Not Found", "Bad Request"). Subject to change without notice. Do not parse or rely on its content.

  • message string Required

    A readable explanation of the error. The wording can change without notice. Do not parse this field.