API Documentation

Authorization

The Sitequest API uses Bearer token authentication with API keys.

API Keys

Create API keys in your Dashboard under API / MCP (open the profile menu at the bottom of the sidebar). Each key can be configured with a name, expiry date, and specific permission scopes.

Include your key in every request via the Authorization header:

Authorization: Bearer sq_live_xxxxx...

API keys use the prefix sq_live_ followed by a 64-character hex string.

Scopes

Each API key is assigned one or more scopes that control what it can access. Use the principle of least privilege — only grant the scopes your integration needs.

Scope Description
vps:read List servers, view status and metrics
vps:files Read and list files as root, including secrets stored in them
vps:manage Start, stop, reboot, mount ISO, create folders, delete files
vps:exec Run commands, write files, add SSH keys and reset the password as root
vps:scale Upgrade CPU, RAM and storage of existing servers
vps:cancel Cancel subscriptions and undo cancellations
vps:provision Create servers and reinstall operating systems
domains:read List domains and view DNS records
domains:manage Edit DNS records and domain settings
domains:cancel Cancel domains at period end and undo cancellations
domains:provision Register and transfer domains
webspace:read List webspaces, view status, usage and config
webspace:files Read and list files, including secrets stored in them
webspace:manage Manage PHP, CMS, linked domains, create folders, delete files
webspace:exec Run commands, write files and add SSH keys as the site user
webspace:scale Upgrade storage and databases of existing webspaces
webspace:cancel Cancel subscriptions and undo cancellations
webspace:provision Create webspaces and delete free webspaces

scale and cancel include read and nothing else. files includes read, and manage and exec include files. provision includes all other scopes of the same resource except exec: running code is always granted explicitly.

Whoever can write files or add SSH keys can also run code, so those rights belong to exec. files is sensitive too: it can be used to read passwords and tokens from configuration files.

When creating a key you pick each scope individually, per resource. Keys with full access (*) can no longer be created in the dashboard; existing ones keep working.

Resource Restrictions

In addition to scopes, an API key can be restricted to specific VPS instances, domains, and/or webspaces. When Resource restrictions are enabled, the key only applies to the explicitly allowed resource IDs — even if the scope would otherwise permit more. Resources ordered with the key are added to it automatically. The list cannot be edited afterwards; to reach further resources, create a new key.

Spending Limit

Keys that allow scaling or ordering can have a spending limit. It applies in total over the key's lifetime. Upgrades count with their monthly increase, new orders with their full first charge, so a ten-year domain counts with its whole amount. A purchase above the limit fails with 403 SPENDING_LIMIT_EXCEEDED, and nothing is charged. Failed payments do not count. Set the limit when you create the key.

Grouping runs

Send the optional X-Run-Id header to mark calls that belong together, such as all steps of a CI job. Up to 128 letters, digits, _ and - are allowed. The activity log can then be filtered by this run.

Rate Limiting

API requests are rate-limited to 60 requests per minute per API key.

Every response includes rate limit headers:

Header Description
X-RateLimit-Limit Maximum requests allowed per window
X-RateLimit-Remaining Requests remaining in the current window
X-RateLimit-Reset Unix timestamp when the window resets

When the rate limit is exceeded the API returns 429 Too Many Requests.

Error Responses

Authentication errors return a JSON body:

{
  "error": "Invalid or missing API key",
  "code": "UNAUTHORIZED",
  "status": 401
}
Status Code Meaning
401 UNAUTHORIZED Missing, invalid, revoked, or expired API key
403 INSUFFICIENT_SCOPE API key lacks the required scope(s)
429 RATE_LIMITED Too many requests

Security Tips

  • Never commit API keys to version control.
  • Rotate keys regularly and revoke unused ones.
  • Use the narrowest scopes possible.
  • Set an expiry date for keys used in CI/CD pipelines.