Docs / API
Access tokens
Keys for scripts and bots: two permission sets, limits, revoking.
An access token is for scripts, bots and reseller panels that manage your VPS through the API. The account password is never used in scripts.
Create a token
- In the cabinet, open Settings → API tokens → New token.
- Give it a clear name: where it is used.
- Pick the permissions: Read only: VPS and balance or Manage VPS.
- Copy the token. We show it once and keep only a fingerprint — it cannot be recovered, only replaced with a new one.
A token looks like crp_ plus 43 characters. Creating tokens needs a confirmed email. Up to 50 tokens can be active.
How to send it
curl -H "Authorization: Bearer crp_..." https://turtleguard.cloud/api/v1/cloud/vmsThe token works only in the Authorization header. Do not put it in the URL: URLs end up in logs and browser history.
What a token can reach
A token works with VPS and the balance only: the /cloud/… methods, GET /billing/balance, GET /billing/transactions, plus GET /auth/me and GET /openapi.json. Any other address answers 403 with the code auth.token_area. Domains, DNS and protection rules are not managed with tokens. This applies to tokens created earlier as well.
Permissions
| In the panel | Token permissions | What it allows |
|---|---|---|
| Read only: VPS and balance | cloud:read, billing:read | See servers, their load and snapshots, the balance and transactions |
| Manage VPS | cloud:read, cloud:write, billing:read | All of the above, plus order, power on and off, reinstall, renew and delete servers, change the IP and the plan, open the console |
If a token lacks the permission for a method, the API answers 403 with the code auth.scope. The permission each method needs is listed with the methods.
Reading is access to servers too
A Read only token sees the whole server data, root password included. Keep it as carefully as a token that manages servers.
Give the minimum
A storefront that only shows customers the state of their servers needs Read only. Manage VPS is for whatever orders and renews servers. Make a separate token for each system: then a leak of one can be closed without touching the rest.
Limits
Each token gets up to 300 requests a minute, of which up to 30 may change something (everything except GET). Over the limit the API answers 429 with the code rate_limited and a Retry-After header: the number of seconds to wait before retrying.
Account security
- A token cannot change account settings: password, email, login codes, sessions. Tokens can also be created, listed and revoked only in the cabinet.
- Changing the account password revokes all tokens at once. Create new ones afterwards and replace them in your scripts.
- A support agent signed in to your account to help you cannot create a token.
Expiry and revoking
- Tokens from the cabinet do not expire: they work until you revoke them.
- The token list shows when each token was last used.
- Revoke turns a token off at once. Revoke a token that may have leaked, and the tokens of people who left.