Retrieve an alert

GET 
/api/v1/alerts/:id/

Gets a specific alert.

Request

Path Parameters

id uuidrequired
service_id uuidrequired

Responses

200

application/json

Schema

Schema

account uuidrequired
account_providers uuid[]
alert_type stringrequired

Possible values: <= 255 characters

channels uuid[]required
enabled boolean
health_checks uuid[]
id uuidrequired
name stringrequired

Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9_\-\s]*$

restrict_to_account_providers boolean
restrict_to_health_checks boolean
restrict_to_services boolean
services uuid[]
threshold integernullable

Possible values: >= -2147483648 and <= 2147483647

Example (from schema)

{
  "account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account_providers": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "alert_type": "string",
  "channels": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "enabled": true,
  "health_checks": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "restrict_to_account_providers": true,
  "restrict_to_health_checks": true,
  "restrict_to_services": true,
  "services": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "threshold": 0
}

Loading...