Public API

Every status page can expose a small read-only API so customers can pull your current status into their own dashboards, scripts or health checks.

Enable the public API

Login to Instatus from instatus.com/login then choose your status page.

  1. Go to Settings → Notifications
  2. Turn on API
  3. Click Save

API will now show up in the Get updates menu on your status page, linking to a reference page that documents the endpoints with live responses from your own page.

Endpoints

your-status-page-url/v3/summary.json
your-status-page-url/v3/components.json

summary.json returns the overall page status plus any active incidents and maintenances. components.json returns each component and its current status.

See Publicly available data for the response format and the list of possible statuses.