Jammonic

API

All endpoints under /api/v1 need a key: Authorization: Bearer <key> or X-Api-Key: <key>. Errors are Problem Details (RFC 9457) — JSON with status, title and detail.

Create or update by your own key

The main call for tools and scripts. Your key (externalId) is any stable name: a project, a domain, a host. 201 — created, 200 — updated. Run it again and nothing doubles.

curl -X PUT -H "X-Api-Key: $KEY" -H 'Content-Type: application/json' \
  -d '{"name":"shop","type":"HTTP","target":"https://shop.example.com","statusPage":true,"group":"Websites"}' \
  https://status.example.com/api/v1/checks/by-external-id/shop-web

Endpoints

Method Path What
GET /api/v1/checks all checks
POST /api/v1/checks create
GET, PUT, DELETE /api/v1/checks/{id} one check
GET, PUT, DELETE /api/v1/checks/by-external-id/{key} by your key
POST /api/v1/checks/{id}/pause, /resume pause and resume
GET /api/v1/checks/{id}/results?limit=100 history, newest first
GET, POST /push/{token} push signal, no key
GET /api/public/status status page data, no key

A check in an answer has its fields (see Checks) plus id, externalId, status, statusMessage, statusSince, lastCheckedAt and, for PUSH, pushUrl.