Update alert configuration

Update an existing alert configuration.

Immutable fields — the following fields cannot be changed after creation.
If the request body contains a different value, the API returns 400:

  • alert_type_id

Editable fields — all other fields can be updated, including name.
If the new name conflicts with an existing alert owned by the same user,
the API returns 409.

For Phase 2 (dynamic/non-preset) alert types, changes are synced to
SignOz before the database is updated. If SignOz rejects the change,
the database remains untouched.

Path Params
uuid
required

ID of the alert configuration to be updated.

Body Params

Alert configuration object for creation

string
required

Name of the alert configuration

string
required

Description of the alert configuration

string
required

ID of the alert type

string

The ID of stream associated with the alert

string

The ID of the group associated with the alert

string

The ID of the CP tag associated with the alert

string

The ID of the stream associated with the alert

string

The ID of the stream rendition associated with the alert

Threshold configuration for dynamic alert types (e.g. { expected_bitrate: 5000000, deviation_percentage: 10 })


JSON string of threshold configuration

string

Comma-separated list of email addresses to notify

boolean
required
Defaults to true

Whether the alert configuration is public so others can subscribe to it

string
enum
required
Defaults to Warning

The severity level of the alert

Allowed:
boolean
required
Defaults to true

Whether the alert configuration is activated

Responses

400

Bad request. Possible reasons:

  • Invalid alert ID (not a valid UUID)
  • AJV schema validation failure (missing required fields, extra properties)
  • Attempted to change an immutable field (alert_type_id)
  • Invalid threshold_config values (e.g. expected_bitrate <= 0, deviation_percentage out of range)
401

Unauthorized — missing or invalid JWT.

403

Forbidden — user lacks write access to the specified contracts/groups.

404

Not found. Possible reasons:

  • Alert configuration does not exist or belongs to a different account
  • Alert type does not exist
409

Duplicate alert name — another alert with the same name already exists for this user.

500

Internal server error (including SignOz sync failures).

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json