API

Update an alert

put
https://{hostname}/alerts/v2/alert-definitions/

Modifies the criteria that determine when an alert fires.

Path Params
string
required

Identifies the alert definition.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Alert configured with thresholds for monitoring.

string
length ≥ 1

Identifies the account under which the alert was created.

string
length ≥ 1

Identifies the alert definition.

editInfo
object

A summary of the alert's creation time and most recent edit.

fields
object
required

The set of criteria that determines when the alert fires. The object's members vary depending on the template on which the alert is based. However, all fields include a name, the templateId on which the alert was based, and an array of email addresses for the alert's recipients.

links
array of objects
length ≥ 2

Link relations to schemas and REST endpoints.

links
string
enum

Identifies the type of alert the template enables, either STATIC or ADAPTIVE. Static alert types specify raw values, while the adaptive alert type expresses standard deviations. The only available ADAPTIVE alert identifies excessive traffic, and its templateId is a@1.

Allowed:
Responses
204

Alert successfully updated.

Updated 4 months ago

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

Updated 4 months ago