Sign in
alerting-v2

Get an action policy

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Get an action policy by identifier.<br/><br/>[Required authorization] Route required privileges: read_alerting-v2-action-policies.

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

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

Response

Returns the requested 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 3 of the 176 revisions of this API.23

  • 1078d5597eb41See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

  • cf530633f03b12See the full diff
    • ▲

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

      response-property-type-changed

    • ○

      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.