Developer quickstart · live playground
Create an incident in one request.
Send a scoped, authenticated request from the documentation and inspect the real response before moving the same request into your server, CI runner or protected worker.
- Prerequisite
- A temporary API key scoped to one status page.
- Endpoint
POST /api/v1/incidents- Success
- A
201response containing the new incident id.
Run a request to inspect its status, timing and response body.
$NOW becomes the current ISO time when sent. Running writes to the status page attached to this key. The key is never saved; use a temporary scoped key and revoke it after testing.
Make one request, then pick the reference you need: the public read API, the incident and event write APIs, webhooks, or badges and feeds.
Start building
Base URLs, credentials and a first request you can check.
Read public status
Read the public page as JSON without a key.
Automate operations
Create incidents from your own systems, or report what your application returned.
Integrate and extend
Signed webhooks for your receivers, and badges and feeds for other tools.