Authentication & abilities
Every API call needs a personal API token, sent as a bearer token:
A missing, wrong, revoked or expired token gets 401 unauthenticated. Tokens are created and revoked in the panel under
API tokens; each login can hold up to 50 tokens.
Token abilities (access levels)
Each token has exactly one access level. Levels are cumulative — manage can do everything rotate can, and rotate
everything read can.
A call above the token's level answers 403 insufficient_ability. GET /me shows the token's abilities.
Your login still applies
A token never gives more than the login it belongs to:
Proxies or nodes your login cannot see answer 404 not_found — the API never reveals other customers' ids.
Visible but not allowed answers 403 forbidden.
A suspended login (or a sub-user / team member of a suspended account) gets 403 account_suspended on every call.
Good practice
- Give each script its own token with the lowest level it needs (a rotation bot only needs
rotate). - Set an expiry for tokens you hand to third parties.
- Changing your panel password does not revoke tokens — revoke them yourself under API tokens if one may have leaked.