Update alert configuration

put

https://{hostname}/api/platform/v1/alert/configuration/{id}

Update an existing alert configuration.

Path Params

string

required

ID of the alert configuration to be updated.

Body Params

name

string

required

Name of the alert configuration

description

string

required

Description of the alert configuration

alert_type_id

string

required

ID of the alert type

contract_ids

string

The ID of stream associated with the alert

group_ids

string

The ID of the group associated with the alert

cptag_ids

string

The ID of the CP tag associated with the alert

stream_ids

string

The ID of the stream associated with the alert

rendition_ids

string

The ID of the stream rendition associated with the alert

subscribers

string

Comma-separated list of email addresses to notify

public

boolean

required

Defaults to true

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

severity

string

enum

required

Defaults to Warning

The severity level of the alert

Allowed:

activated

boolean

required

Defaults to true

Whether the alert configuration is activated

Responses

401

Unauthorized.

409

Duplicate alert name.

500

Internal server error.

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the updated alert configuration.