PingrootDocumentation
Three things to know: how to add a check, how alerts reach you, and how to subscribe to the live event stream.
API endpoints
| Method | Path | Purpose |
|---|---|---|
| POST | /api/v1/checks | Register a new endpoint to monitor |
| GET | /api/v1/checks | List every check on the account |
| GET | /api/live/events | Subscribe to the incident stream |
| DELETE | /api/v1/checks/:id | Stop monitoring an endpoint |
Event stream
The stream stays open and delivers each probe result as it lands. Reconnect with the last event id to resume without gaps.
| Field | Meaning |
|---|---|
| event | probe.ok, probe.fail, incident.open, incident.close |
| id | Monotonic sequence number for resuming |
| data | JSON payload with region, latency and status code |
| retry | Reconnect delay in milliseconds |