Skip to main content

API key format

Example:
Create keys in the dashboard. Keys are shown only once at creation.

Prerequisites (every /v1 request)

Middleware applied to all /v1 routes:
  1. Valid API key (Authorization: Bearer ck_...)
  2. Rate limit: 120 requests/minute per key
  3. Plan must have API keys enabled (plan.api_keys_enabled)
  4. Active cloakup subscription
  5. Route-specific scope (see each endpoint)
Failure at any step returns 401 or 403. See Errors.

Scopes

Each key has one or more scopes. The endpoint rejects requests when the key lacks the required scope. Presets in the dashboard:
  • Read onlycampaigns:list, campaigns:show, domains:list
  • Full access — all scopes above

IDs

Resource IDs are numeric (bigint). JSON may serialize them as numbers or strings depending on the serializer.