Web hosting
88 endpoints. Hosting accounts, email accounts, databases, WordPress, files and SSL.
Hosting accounts
- GET List web hosting accounts
/shared-hosting - GET Get a web hosting account
/shared-hosting/{accountId} - PATCH Rename a web hosting account
/shared-hosting/{accountId} - GET Get connection details for web hosting
/shared-hosting/{accountId}/account-details - GET Get web hosting usage
/shared-hosting/{accountId}/account-stats - GET Check a main domain change for web hosting
/shared-hosting/{accountId}/actions/change-main-domain - POST Change the main domain of web hosting
/shared-hosting/{accountId}/actions/change-main-domain - POST Set a new control panel password
/shared-hosting/{accountId}/actions/reset-password - GET Check control panel login for web hosting
/shared-hosting/{accountId}/actions/sso - POST Create a control panel login link
/shared-hosting/{accountId}/actions/sso - GET Inspect website files
/shared-hosting/{accountId}/diagnostics/files - GET Check the account's Redis socket
/shared-hosting/{accountId}/diagnostics/redis - GET Get hosting disk quota
/shared-hosting/{accountId}/disk-quota - POST Create a webmail login link
/shared-hosting/{accountId}/email-accounts/{address}/actions/sso - GET Read a website's error logs
/shared-hosting/{accountId}/logs/error-log - POST Purge a website's page cache
/shared-hosting/{accountId}/page-cache/actions/purge - GET Get PHP versions per website
/shared-hosting/{accountId}/php - POST Set a website's PHP version
/shared-hosting/{accountId}/php - POST Get a WordPress admin login link
/shared-hosting/{accountId}/wordpress/{siteId}/actions/sso
Domains on the account
- GET List hosting domains
/shared-hosting/{accountId}/domains - POST Add a domain to web hosting
/shared-hosting/{accountId}/domains - DELETE Remove a domain from web hosting
/shared-hosting/{accountId}/domains - GET Get the DNS setup of a hosting domain
/shared-hosting/{accountId}/domains/dns-setup - POST Apply the DNS setup of a hosting domain
/shared-hosting/{accountId}/domains/dns-setup
- GET Download a mail setup profile
/mail-profiles/{token} - GET List email accounts
/shared-hosting/{accountId}/email-accounts - POST Create an email account
/shared-hosting/{accountId}/email-accounts - DELETE Delete an email account
/shared-hosting/{accountId}/email-accounts/{address} - POST Create an Apple Mail setup link
/shared-hosting/{accountId}/email-accounts/{address}/actions/mail-profile-link - GET Download an Apple Mail setup profile
/shared-hosting/{accountId}/email-accounts/{address}/mobileconfig - PUT Change an email account password
/shared-hosting/{accountId}/email-accounts/{address}/password - PUT Change an email account quota
/shared-hosting/{accountId}/email-accounts/{address}/quota - GET Get the default address of a hosted domain
/shared-hosting/{accountId}/email-default-address - GET Check DKIM, SPF and DMARC for a domain
/shared-hosting/{accountId}/email-deliverability - GET List incoming mail deliveries
/shared-hosting/{accountId}/email-deliveries - GET List email forwarders
/shared-hosting/{accountId}/email-forwarders - POST Create an email forwarder
/shared-hosting/{accountId}/email-forwarders - DELETE Delete an email forwarder
/shared-hosting/{accountId}/email-forwarders/{address} - GET Get email routing for a domain
/shared-hosting/{accountId}/email-routing - PUT Set email routing for a domain
/shared-hosting/{accountId}/email-routing - GET Get mail app settings for a domain
/shared-hosting/{accountId}/mail-settings
Databases
- GET List database backups
/shared-hosting/{accountId}/backups/databases - POST Restore a database backup
/shared-hosting/{accountId}/backups/databases/{backupId}/actions/restore - GET List database access hosts
/shared-hosting/{accountId}/database-access-hosts - POST Allow a database access host
/shared-hosting/{accountId}/database-access-hosts - DELETE Remove a database access host
/shared-hosting/{accountId}/database-access-hosts/{host} - GET List database users
/shared-hosting/{accountId}/database-users - POST Create database user
/shared-hosting/{accountId}/database-users - DELETE Delete database user
/shared-hosting/{accountId}/database-users/{username} - PUT Reset database user password
/shared-hosting/{accountId}/database-users/{username}/password - POST Grant database privileges
/shared-hosting/{accountId}/database-users/{username}/privileges - DELETE Revoke database privileges
/shared-hosting/{accountId}/database-users/{username}/privileges - GET List hosting databases
/shared-hosting/{accountId}/databases
WordPress
- GET List WordPress sites
/shared-hosting/{accountId}/wordpress - POST Install WordPress
/shared-hosting/{accountId}/wordpress - GET List WordPress plugins
/shared-hosting/{accountId}/wordpress-plugins - POST Install a WordPress plugin
/shared-hosting/{accountId}/wordpress-plugins/{slug}/actions/install - POST Switch a WordPress plugin on or off
/shared-hosting/{accountId}/wordpress-plugins/{slug}/actions/toggle - GET Get a WordPress site
/shared-hosting/{accountId}/wordpress/{siteId} - DELETE Uninstall a WordPress site
/shared-hosting/{accountId}/wordpress/{siteId} - POST Clone a WordPress site
/shared-hosting/{accountId}/wordpress/{siteId}/actions/clone - POST Create a WordPress staging copy
/shared-hosting/{accountId}/wordpress/{siteId}/actions/staging - POST Update WordPress on a site
/shared-hosting/{accountId}/wordpress/{siteId}/actions/upgrade - GET Scan for WordPress sites
/shared-hosting/{accountId}/wordpress/actions/scan - POST Import WordPress sites
/shared-hosting/{accountId}/wordpress/import - POST List WordPress sites on several accounts
/shared-hosting/wordpress/batch
Backups
- GET List web hosting backups
/shared-hosting/{accountId}/backups - POST Restore a web hosting backup
/shared-hosting/{accountId}/backups/{snapshotId}/actions/restore - GET Get the status of a web hosting restore
/shared-hosting/{accountId}/backups/queue/{queueRef}
SSH and SSL
- GET List web hosting SSH keys
/shared-hosting/{accountId}/ssh-keys - POST Add an SSH key to web hosting
/shared-hosting/{accountId}/ssh-keys - DELETE Delete a web hosting SSH key
/shared-hosting/{accountId}/ssh-keys/{fingerprint} - POST Authorize a web hosting SSH key
/shared-hosting/{accountId}/ssh-keys/{fingerprint}/actions/authorize - POST Run AutoSSL for a web hosting account
/shared-hosting/{accountId}/ssl/actions/run-autossl
Plan, renewal and cancellation
- GET List billing periods for web hosting
/shared-hosting/{accountId}/actions/billing-cycle - POST Change the billing period of web hosting
/shared-hosting/{accountId}/actions/billing-cycle - POST Cancel a web hosting account
/shared-hosting/{accountId}/actions/cancel - GET Get the pause status of web hosting
/shared-hosting/{accountId}/actions/pause - POST Pause web hosting
/shared-hosting/{accountId}/actions/pause - DELETE End a web hosting pause
/shared-hosting/{accountId}/actions/pause - POST Renew a web hosting account
/shared-hosting/{accountId}/actions/renew - GET List plans a web hosting account can move to
/shared-hosting/{accountId}/actions/upgrade - POST Change the plan of a web hosting account
/shared-hosting/{accountId}/actions/upgrade - DELETE Cancel a scheduled web hosting plan change
/shared-hosting/{accountId}/actions/upgrade - GET List storage add-ons for web hosting
/shared-hosting/{accountId}/addons/storage - POST Order extra storage for web hosting
/shared-hosting/{accountId}/addons/storage - GET Get web hosting cancellation status
/shared-hosting/{accountId}/cancellation - DELETE Remove a web hosting cancellation
/shared-hosting/{accountId}/cancellation