API Reference
Authentication
How to authenticate with the Fyren API.
Fyren supports two authentication methods for admin API endpoints.
Session Authentication
For browser-based access (admin dashboard), Fyren uses session cookies managed by BetterAuth:
- Sign in via
POST /api/v1/auth/signin - The response sets a secure session cookie
- Subsequent requests include the cookie automatically
API Key Authentication
For programmatic access, use API keys. Include your key in the Authorization header:
curl -H "Authorization: Bearer fyr_your_api_key_here" \
https://status.example.com/api/v1/admin/componentsCreating an API Key
Generate API keys from the admin dashboard under Settings > API Keys, or via the API:
curl -X POST \
-H "Authorization: Bearer fyr_existing_key" \
-H "Content-Type: application/json" \
-d '{"name": "CI/CD Pipeline"}' \
https://status.example.com/api/v1/admin/api-keysThe full key is only shown once at creation time. Store it securely.
Key Format
API keys use the prefix fyr_ followed by a random string:
fyr_abc123def456...Public Endpoints
Public endpoints (status page data, subscriptions) do not require authentication. See Public Endpoints.