Documentation
Overview
Corvid Status Platform is a read-oriented HTTP API. All responses are JSON encoded in UTF-8.
Quick start
Every resource is reachable under https://ccn.brightquill.org/api/v2. No SDK is required.
Authentication
Requests carry a project key in the Authorization header. Keys are scoped per environment and may be rotated without downtime.
Errors
Errors return a JSON object with an error.code and error.message. The HTTP status carries the same meaning as the code.
Rate limits
Limits are applied per key. Exceeding a limit returns 429 with a Retry-After header.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v2 | Version index and resource map. |
| GET | /api/v2/components | Monitored components and their state. |
| GET | /api/v2/incidents | Recent incidents and their resolution. |
| GET | /api/v2/regions | Regions from which checks are performed. |
| GET | /api/v2/status | Machine-readable service status. |