API key format
Example:
Prerequisites (every /v1 request)
Middleware applied to all /v1 routes:
- Valid API key (
Authorization: Bearer ck_...) - Rate limit: 120 requests/minute per key
- Plan must have API keys enabled (
plan.api_keys_enabled) - Active cloakup subscription
- Route-specific scope (see each endpoint)
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 only —
campaigns: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.