API by router
Alerts
List Alerts
List operational alerts for this tenant.
"I see dead people." — Cole Sear, The Sixth Sense (about resolved alerts that still show up in the list)
AuthorizationBearer <token>
In: header
Query Parameters
severity?Severity
Filter by severity: critical, warning, info
alert_type?Alert Type
Filter by alert type
status?Status
Filter: active (unresolved), acknowledged, resolved, all
page?Page
Page number
Default
1Range
1 <= valuepage_size?Page Size
Items per page
Default
25Range
1 <= value <= 100Header Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/alerts?severity=string&alert_type=string&status=string&page=1&page_size=25" \ -H "X-Api-Key: string"{
"items": [
{
"acknowledged_at": "string",
"acknowledged_by": "string",
"alert_type": "string",
"created_at": "string",
"customer_id": "string",
"detail": {},
"id": "string",
"instance_id": "string",
"resolved_at": "string",
"severity": "string",
"title": "string"
}
],
"page": 0,
"page_size": 0,
"total": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Alerts Summary
Get unacknowledged alert counts by severity — powers the notification bell.
"By Grabthar's hammer... what a savings." — Dr. Lazarus, Galaxy Quest (about the summary query that saves you from loading all alerts)
AuthorizationBearer <token>
In: header
Header Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/alerts/summary" \ -H "X-Api-Key: string"{
"critical": 0,
"info": 0,
"total": 0,
"warning": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Acknowledge Alert Endpoint
Acknowledge an alert — marks it as seen by a human.
"I acknowledge your existence." — Spock, probably
AuthorizationBearer <token>
In: header
Path Parameters
alert_idAlert Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X PATCH "https://loading/v1/alerts/497f6eca-6276-4993-bfeb-53cbbbba6f08/acknowledge" \ -H "X-Api-Key: string"{
"acknowledged": true,
"alert_id": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Resolve Alert Endpoint
Manually resolve an alert — marks the condition as cleared.
"It's over. It's done." — Frodo, Return of the King
AuthorizationBearer <token>
In: header
Path Parameters
alert_idAlert Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X PATCH "https://loading/v1/alerts/497f6eca-6276-4993-bfeb-53cbbbba6f08/resolve" \ -H "X-Api-Key: string"{
"acknowledged": true,
"alert_id": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}