C
CIFP

API Authentication

Authenticate with the CIFP control plane API.

The CIFP API base URL is https://cifp.vril.dev/api. All endpoints require authentication except the health endpoint.

Authentication Methods

The API accepts two authentication methods:

Bearer API Key

Pass a cifp_-prefixed API key in the Authorization header:

bash
curl https://cifp.vril.dev/api/proxies \
  -H "Authorization: Bearer cifp_your_api_key_here"

API keys are created in the dashboard or via POST /api/keys. They can be scoped to specific operations and revoked independently.

Browser Session

Dashboard users are automatically authenticated via Auth.js session cookies when making API calls from the browser. No additional configuration needed.

Error Responses

StatusMeaning
400 Bad RequestInvalid request body. Check the details field for schema errors.
401 UnauthorizedNo credential, invalid key, or revoked key.
403 ForbiddenAuthenticated but insufficient scope or not a paid user.
404 Not FoundResource doesn't exist or belongs to a different tenant.
409 ConflictDuplicate resource (e.g. secret name already exists).
429 Too Many RequestsRate limit exceeded. Retry after the Retry-After header.
500 Internal Server ErrorUnexpected server error.

Rate Limits

All API endpoints are rate-limited per IP. Limits are applied using a sliding window. When exceeded, the API returns 429 with a Retry-After header indicating when the window resets.

Pagination

List endpoints return up to their stated maximum per request. Use thelimit query parameter to control the page size. Cursor-based pagination may be added in a future release.

Base URL

bash
https://cifp.vril.dev/api