Sites
Update Git Deployment Settings
Updates the git deployment configuration for a git-deployed site: tracked git_branch, the push-to-deploy webhook toggle (enable_push_deploy), whether the deploy script runs after each pull (run_after_deployment), the post-pull deploy_script, a custom…
Trigger Git Deployment
Queues a manual pull-and-deploy for a git-deployed site. Returns 202 immediately; poll GET /sites/{uuid}/deployment-logs or /sites/{uuid}/events for progress. Requires the write:sites scope and the site:manage-update permission.
List Site SSH Keys
Returns every SSH key pair attached to the site, including the public key body. Private keys and sudo passwords are never exposed. Requires the read:sites scope.
Get SSH/SFTP Config
Returns the SSH/SFTP configuration for the site, including the site user, authentication mode, and any associated SSH keypairs. Private keys are never returned. Requires the read:sites scope.
Update SSH/SFTP Config
Updates the SSH/SFTP authentication configuration for the site. When authentication_mode is public_key, provide ssh_public_keys. When authentication_mode is password, provide password. This is an asynchronous operation. Requires the write:sites scope.
Trigger Backup
Initiates an on-demand backup of the site. This is an asynchronous operation — poll GET /sites/{uuid}/events to track completion. type selects the destination: local (default) or remote. A remote backup…
Rescue Site
Queues a site rescue job with the selected repair options. Supported options depend on the site type and server stack. Poll GET /sites/{uuid}/events to track completion. Requires the write:sites scope.
List Custom Nginx Configs
Returns custom nginx configuration snippets attached to a site. Nginx-only — on non-nginx stacks (OpenLiteSpeed) the list is naturally empty since these rows are never created. Requires the read:sites scope.
List Web Rules
Returns the custom web-server rules attached to a site: HTTP header rules (set or unset response headers) and redirect rules (with optional conditions on host, URI, query arg, or device).…
List Site Snapshots
Returns snapshots created from this site, paginated. SSH keypair references, raw meta, and logs are stripped. The public_url_token is included only for public snapshots — for private snapshots it is…
