Skip to content

List Endpoint

POST
/user/alert/list

List all configured alerts.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
ListAlertsRequest
object
tenant_id
required
Tenant Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

ListAlertsResponse
object
alerts
required
Alerts
Array<object>
NodeOfflineAlert
object
type
Type
string
default: node_offline
id
required
Id
string
node_id
required
Node Id
string
duration
required
Duration
integer
webhook_url
required
Webhook Url
string
webhook_body
required
Webhook Body
string

403

Section titled “403 ”

{"detail": "Invalid API Key"}

404

Section titled “404 ”

{"detail": "Dashboard not found"}

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string