← All docs

API tokens

Generate API tokens for programmatic access to your ScaleVault data.

Account
breeder
multi-site

API tokens

Available on Adult and above. Go to Account → API tokens to manage your tokens.

API tokens allow you to read and write your ScaleVault data from external scripts, automations, and third-party tools.

Generating a token

  1. Go to Account → API tokens.
  2. Click Generate new token.
  3. Give the token a descriptive name (e.g., "Export script – laptop").
  4. Click Create. The token is shown once — copy it now and store it securely.

Using a token

Include the token in the Authorization header of every API request:

Authorization: Bearer <your_token>

The base URL for all API endpoints is:

https://<your-subdomain>.scalevault.io/api

Or, if you're not on a subdomain plan:

https://app.scalevault.io/api

Consult the API reference in your account settings for available endpoints and response formats.

Token scopes

Tokens inherit the permissions of the account they belong to. There are no fine-grained per-token scopes — a token can do anything the account owner can do, so treat them like passwords.

Revoking a token

From Account → API tokens, click Revoke next to any token to permanently invalidate it. Revocation is immediate — any requests using the revoked token will return 401 Unauthorized.

Tips

  • Create one token per integration so you can revoke individual access without disrupting others.
  • Rotate tokens periodically, especially if a script or machine is decommissioned.
  • Never commit tokens to version control — use environment variables or a secrets manager.