Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Routing & Policies
PUTAlertingSince 1.0SynchronousAuth Required

UpdateAlertNotificationPolicy

Update an existing notification routing policy

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the policy to update

Body Fields

  • nameStringRequired

    New policy name

    Example: Updated Routing Policy

  • descriptionStringRequired

    New policy description

    Example: Updated routing description

  • priorityIntegerRequired

    New priority order

    Example: 2

  • matchersListRequired

    Updated label matchers

    Example: (nested array)

    • keyString

      Label key to match against

      Example: severity

    • operatorString

      Match operator: eq, neq, regex, etc.

      Example: eq

    • valueString

      Value to match against

      Example: critical

  • channelIdsListRequired

    Updated channel UUIDs

    Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the policy

    Example: policy-001

  • nameString

    Human-readable policy name

    Example: Critical Alert Routing

  • descriptionString

    Description of the policy routing logic

    Example: Route critical alerts to ops channels

  • priorityInteger

    Priority order for policy evaluation (lower = higher priority)

    Example: 1

  • isDefaultBoolean

    Whether this is the default catch-all policy

    Example: false

  • matchersList

    Label matchers for routing decisions

    Example: (nested array)

    • keyString

      Label key to match against

      Example: severity

    • operatorString

      Match operator: eq, neq, regex, etc.

      Example: eq

    • valueString

      Value to match against

      Example: critical

  • channelIdsList

    Channel UUIDs to deliver notifications to

    Example: item1,item2

  • groupByList

    Fields to group notifications by

    Example: item1,item2

  • groupWaitInteger

    Seconds to wait before sending first notification

    Example: 30

  • groupIntervalInteger

    Seconds between grouped notification batches

    Example: 300

  • repeatIntervalInteger

    Seconds before repeating a notification

    Example: 3600

  • statusString

    Policy status: active or disabled

    Example: active

  • createDateString

    Timestamp when the policy was created

    Example: 2024-01-15T09:00:00Z

  • lastOpDateString

    Timestamp of the last policy modification

    Example: 2024-01-15T09:00:00Z

Endpoint

PUT/api/v1/alerting/notification-policies/{uuid}

/api/v1/alerting/notification-policies/{uuid}

Operation ID

UpdateAlertNotificationPolicy

Permalink

Request Example

curl -X PUT '{host}/api/v1/alerting/notification-policies/{uuid}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Updated Routing Policy","description":"Updated routing description","priority":2,"matchers":"(nested array)","channelIds":"item1,item2","groupBy":"item1,item2","groupWait":30,"groupInterval":300,"repeatInterval":3600,"status":"active"}'

Response Example

200
{
  "uuid": "policy-001",
  "name": "Critical Alert Routing",
  "description": "Route critical alerts to ops channels",
  "priority": 1,
  "isDefault": false,
  "matchers": [
    {}
  ],
  "channelIds": [],
  "groupBy": []
}

Change History

This API has no change history records yet.

View all change history