API Overview¶
The Outage Detection System API provides REST endpoints for accessing incident data and reachability information.
Base URL¶
Endpoints¶
| Method | Endpoint | Description |
|---|---|---|
| GET | / |
Health check |
| GET | /incidents |
Get current incidents |
| GET | /incidents/history |
Get historical incidents |
| GET | /reachability |
Get all reachability statuses |
| GET | /reachability/:targetId |
Get reachability for specific target |
| POST | /reachability/probe |
Trigger on-demand probe |
| GET | /reachability/targets |
List probe targets |
| POST | /reachability/targets |
Add probe target |
| DELETE | /reachability/targets/:id |
Remove probe target |
Common Headers¶
Request Headers¶
Response Headers¶
Error Responses¶
Errors are returned with appropriate HTTP status codes:
| Status | Description |
|---|---|
| 400 | Bad Request - Invalid parameters |
| 404 | Not Found - Resource doesn't exist |
| 500 | Internal Server Error |
| 503 | Service Unavailable - Feature not configured |
Error response format:
CORS¶
The API supports CORS and can be called from any origin. Preflight requests are handled automatically.
Rate Limiting¶
Currently no rate limits are enforced. Please be respectful with request frequency.