API Keys

API keys provide programmatic access to Fyren's admin endpoints. Use them for CI/CD integrations, scripts, and external tooling.

Key Format

API keys use the fyr_ prefix followed by 32 random alphanumeric characters:

fyr_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Keys are hashed with SHA-256 before storage — only the prefix (first 12 characters) is stored in plaintext for lookup.

Creating Keys

Create keys from the admin dashboard under Settings > API Keys, or via the API:

POST /api/v1/admin/api-keys

{
  "name": "CI/CD Pipeline",
  "expiresAt": "2026-12-31T23:59:59Z"
}

The expiresAt field is optional. If omitted, the key does not expire.

Important: The full key is only shown once at creation time. Store it securely — it cannot be retrieved later.

Using Keys

Include your API key in the Authorization header:

curl -H "Authorization: Bearer fyr_your_api_key_here" \
  https://status.example.com/api/v1/admin/components

Expiration

Keys can optionally have an expiration date. Expired keys are rejected automatically. To rotate a key, create a new one and delete the old one.

Usage Tracking

Each key tracks lastUsedAt, which is updated on every authenticated request. This helps you identify unused keys that can be safely removed.

Managing Keys

GET    /api/v1/admin/api-keys        — List all keys (name, prefix, lastUsedAt, expiresAt)
POST   /api/v1/admin/api-keys        — Create a new key
DELETE /api/v1/admin/api-keys/:id     — Delete a key

You cannot delete the key that is authenticating the current request.