Sites
List Sites
Returns a paginated list of all sites across all your servers. Requires the read:sites scope.
Get Site
Returns full details for a specific site. Requires the read:sites scope.
Get Site Status
Lightweight endpoint for polling a site's current status during provisioning or after triggering async operations. Requires the read:sites scope.
Get SSL Certificate
Returns SSL certificate information for the site. Requires the read:sites scope.
List Staging Sites
Returns every staging environment attached to a production site. Rejects with 422 when called on a non-production site — staging sites cannot have nested staging children. Requires the read:sites scope.
List Site Scripts
Returns metadata for every site script (env, deployment, git-pull, staging hooks, docker-compose). The raw script body is intentionally NOT exposed because env scripts contain secrets (DB passwords, API keys). Use…
List Site IP Access Rules
Returns every IP access rule scoped to the site, split between whitelist and blacklist entries. Requires the read:sites scope.
List Site Backup Settings
Returns the backup settings configured for the site. A site can have multiple entries (typically one local and one remote). The storage provider's credentials are never exposed — only its…
Get Site Backup Status
Returns whether scheduled backups are active for the site, split into local and remote. A type is active when the site has its own backup setting of that type with…
List Site Cron Jobs
Returns the cron jobs scoped to the site. Paginated. Requires the read:sites scope.
