Recurring checks
List monitoring alerts
Scope: monitoring:read
Alerts across every recurring check, newest first.
Subscribe to the monitoring.alert.created
webhook to be told as they are raised, rather than
polling this.
AuthorizationBearer <token>
Use Authorization: Bearer vrf_live_... or vrf_test_....
In: header
Query Parameters
page?integer
Zero-based page number. The first page is 0.
Range
0 <= valueDefault
0size?integer
Records per page. Large values are capped.
Range
1 <= value <= 200Default
20unreadOnly?boolean
Return only alerts that have not been marked read.
Default
falsesortBy?string
Sort key. An unsupported key falls back to the endpoint's default order.
sortDirection?string
Sort direction.
Default
"asc"Value in
- "asc"
- "desc"
Response Body
application/json
curl -X GET "https://example.com/api/v1/monitoring/alerts?page=0&size=20&sortBy=createdAt"{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "message": "string", "severity": "LOW", "read": true, "actioned": true, "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9", "createdAt": "2019-08-24T14:15:22Z" } ], "page": 0, "size": 20, "totalItems": 42, "totalPages": 3, "hasNext": true, "hasPrevious": true}