API Overview

Fyren exposes a REST API at /api/v1/ for managing your status page, monitors, incidents, and more.

Base URL

All API endpoints are relative to your Fyren instance URL:

https://status.example.com/api/v1/

Response Format

All responses are JSON. Successful responses return the data directly:

{
  "id": "abc123",
  "name": "API Server",
  "status": "operational"
}

Error responses include a message field:

{
  "error": "not_found",
  "message": "Component not found"
}

Rate Limiting

API requests are rate-limited. The default is 100 requests per 60-second window. Rate limit headers are included in every response:

• X-RateLimit-Limit — Maximum requests per window
• X-RateLimit-Remaining — Remaining requests in the current window
• X-RateLimit-Reset — Unix timestamp when the window resets

Endpoint Categories

• Authentication — How to authenticate API requests
• Public Endpoints — Unauthenticated status page data
• Admin Endpoints — Authenticated management endpoints