Skip to main content
Add alerts to a claim

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
alert_ids
string<uuid>[]

Explicit alerts. The command applies to every listed alert or fails: an unknown ID returns 404 and an alert that may not be changed returns 409.

Required array length: 1 - 5000 elements
filter
object

Every alert matching this filter when the command runs. Takes the GET /v1/alerts filters with JSON lists and booleans. Matching alerts that may not be changed are left alone and counted in skipped_count.

excluded_alert_ids
string<uuid>[]

Alerts to leave out of a filter selection. Only valid with filter.

Required array length: 1 - 5000 elements

Response

How many alerts the command changed and how many matching alerts were left alone. Read the claim for its current counts and amounts.

changed_count
integer
required

Alerts the command changed. Alerts already in the requested state are not counted.

skipped_count
integer
required

Filter selections only: matching alerts that may not be changed and were left alone. Always 0 for alert_ids.