Alerts API
List alerts
GET /api/v1/alerts?filter=unresolved&limit=50| Query | Values |
|---|---|
filter | all (default), unread, unresolved |
limit | 1–200 (default 50) |
curl "https://api.securecheap.com/api/v1/alerts?filter=unresolved" \
-H "X-API-Key: sc_live_..."Response: { "alerts": [ ... ] }
Update alerts
| Method | Path | Action |
|---|---|---|
PATCH | /api/v1/alerts/{id}/read | Mark one alert read |
PATCH | /api/v1/alerts/read-all | Mark all alerts read |
PATCH | /api/v1/alerts/{id}/resolve | Resolve an alert |
DELETE | /api/v1/alerts/{id} | Delete an alert |
Each returns { "ok": true }.
Notification channels
| Method | Path | Action |
|---|---|---|
GET | /api/v1/alerts/channels | List channels |
POST | /api/v1/alerts/channels | Add a channel |
PATCH | /api/v1/alerts/channels/{id} | Update a channel |
DELETE | /api/v1/alerts/channels/{id} | Delete a channel |
POST | /api/v1/alerts/channels/{id}/test | Send a test notification |
Channel type is one of EMAIL, SLACK, DISCORD, TELEGRAM, WEBHOOK. An optional
minSeverity (info, warning, critical) filters which alerts the channel receives.