Authentication

All requests to the FluxRail API require an API key. Pass it in the X-API-Key header on every request.

bash

# Every request must include this header
curl https://api.fluxrail.io/api/v1/subscriptions \
  -H "X-API-Key: flux_your_key_here"

Base URL: https://api.fluxrail.io/api/v1 — all endpoints below are relative to this URL.

Key Format

API keys begin with flux_ followed by a random string. Example: flux_a3f9c8d2e1b7...

Keys are hashed server-side — FluxRail cannot recover a lost key. If compromised, revoke it in your dashboard and generate a new one.

Quick Test

bash

# Validate your key and see your plan info
curl https://api.fluxrail.io/api/v1/auth/validate-key/ \
  -H "X-API-Key: flux_your_key_here"

# 200 response:
{
  "valid": true,
  "user": "you@example.com",
  "plan": "pro",
  "rate_limit": 1000,
  "subscriptions_used": 12,
  "subscriptions_limit": 2000
}

S

Sophie

Docs assistant · Ask anything

Hi! I'm Sophie 👋

Ask me anything about the FluxRail API — I can explain endpoints, generate code examples, and walk you through setup.