Skip to main content

Status Page API

Access your status page data programmatically using our Atlassian Statuspage-compatible API v2.

Atlassian-Compatible

Our API follows the Atlassian Statuspage API v2 format. If you have existing integrations with Statuspage, they should work with FlareWarden with minimal changes.

Base URL

Configure your API endpoint

All API endpoints are available at your status page URL:

https://your-status-page.status.flarewarden.com/api/v2/

Or if using a custom domain: https://status.yourcompany.com/api/v2/

Available Endpoints

RESTful API endpoints for status data

Summary & Status

GET /api/v2/summary.json

Overall status summary with components

GET /api/v2/status.json

Current status indicator

Components

GET /api/v2/components.json

List of all components with current status

Incidents

GET /api/v2/incidents.json

All incidents

GET /api/v2/incidents/unresolved.json

Only unresolved (active) incidents

Scheduled Maintenance

GET /api/v2/scheduled-maintenances.json

All scheduled maintenance

GET /api/v2/scheduled-maintenances/upcoming.json

Upcoming maintenance only

GET /api/v2/scheduled-maintenances/active.json

Currently active maintenance

Subscriptions

POST /api/v2/subscribers

Subscribe an email to updates

Real-Time Updates

GET /sse/events

Server-Sent Events (SSE) stream for live updates

Example Response

Sample JSON response from the summary endpoint

Here's an example response from /api/v2/summary.json:

{
  "page": {
    "id": "your-page-id",
    "name": "Acme Corp Status",
    "url": "https://status.acme.com"
  },
  "status": {
    "indicator": "operational",
    "description": "All Systems Operational"
  },
  "components": [
    {
      "id": "comp_abc123",
      "name": "Website",
      "status": "operational",
      "description": "Main website"
    },
    {
      "id": "comp_xyz789",
      "name": "API",
      "status": "operational",
      "description": "REST API"
    }
  ],
  "incidents": [],
  "scheduled_maintenances": []
}

Real-Time Updates with SSE

Subscribe to live status changes via Server-Sent Events

Connect to the /sse/events endpoint to receive real-time updates:

const eventSource = new EventSource(
  'https://status.yourcompany.com/sse/events'
);

eventSource.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Status update:', data);
};

Updates are pushed approximately every 5 minutes or immediately when status changes.