Scopes
A scoped key can do only what its scopes allow. A :write scope includes the :read scope of the same area. Full-access keys have every scope. The scope each endpoint needs is shown on its reference entry.
| Scope | Area | Allows |
|---|---|---|
account:read | Account | Profile, plan, site slots, limits and usage, frozen state and why. |
account:write | Account | Refresh usage measurements. |
billing:read | Billing | Subscription status, payment due, invoices and invoice PDFs, add-ons. |
sites:read | Sites | List and read sites: status, nameservers, CDN, indexation, SEO, platform, usage, health. |
sites:write | Sites | Create sites, change settings and PHP version, purge cache, reinstall, recheck health, run Site Cleaner. |
sites:delete | Sites | Delete sites (kept separate on purpose). |
sites:login | Sites | One-click admin login links (WordPress, Joomla, Drupal and the other applications). |
dns:read | DNS | Read DNS records and nameserver status. |
dns:write | DNS | Add, change and delete DNS records. |
backups:read | Backups | List backups and get download links. |
backups:write | Backups | Create backups, restore a backup, delete a backup. |
files:read | Files | List folders and read files of a site. |
files:write | Files | Upload, create folders, rename and delete files of a site. |
logs:read | Logs | Error log and access log of a site. |
tickets:read | Support | Read your support tickets. |
tickets:write | Support | Open tickets and reply to them. |
content:read | Content | Read posts, pages and the auto-posting campaigns of the account. |
content:write | Content | Publish and change posts and pages on any site type, upload pictures, and start or pause auto-posting campaigns. |
kb:read | Knowledge base | Search the knowledge base (needs no scope; listed for completeness). |
A call without the scope gets 403 scope_missing, with details.required naming the scope it needs. Jobs (GET /jobs) need account:read; the knowledge base and GET /limits work with any key.