alerting-v2

Partially update an action policy.

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb patch">patch</span>&nbsp;<span class="operation-path">/s/{space_id}/api/alerting/v2/action_policies/{id}</span></div>

Refer to Spaces for more information.

Apply a partial update. A field you omit keeps its stored value, and that applies at every level: send {"matcher": {"tags": ["prod"]}} to change one leaf while leaving its siblings alone. Send null to clear a field, again at any level: {"matcher": {"expression": null}} clears a single leaf, while {"matcher": null} clears a whole object. Lists and variant objects are replaced as a unit rather than merged, since a partly-sent variant could never be valid. The merged result is validated as a whole, so a patch that would leave the resource invalid is rejected with a 400 and nothing is stored.<br/><br/>[Required authorization] Route required privileges: manage_alerting-v2-action-policies AND read_alerting-v2-rules.

patch/api/alerting/v2/action_policies/{id}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/alerting/v2/action_policies/{id}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

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

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

descriptionstring nullable

A description of the action policy. Absent when the policy has none; send null on PATCH to clear it.

namestring

The name of the action policy.

Response

Returns the updated 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

  • 883cd57e9ac7Revision changes
    • warning

      the ///// request property's maxLength was set to 32

  • 1078d5597eb4Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property