Web Hosting

Hosting accounts, cPanel, files, databases, email, and WordPress operations

77 endpoints

Databases 9 Email 14 Hosting Accounts 30 Plans & Billing 5 SSH 4 SSL 1 WordPress 14

Databases 9 endpoints

GET /api/v2/shared-hosting/{accountId}/backups/databases

List database backups read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/backups/databases/{backupId}/actions/restore

Restore database backup write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/database-users

List database users read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/database-users

Create database user write:hosting, console:services

DELETE /api/v2/shared-hosting/{accountId}/database-users/{username}

Delete database user write:hosting, console:services

PUT /api/v2/shared-hosting/{accountId}/database-users/{username}/password

Reset database user password write:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/database-users/{username}/privileges

Grant database privileges write:hosting, console:services

DELETE /api/v2/shared-hosting/{accountId}/database-users/{username}/privileges

Revoke database privileges write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/databases

List hosting databases read:hosting, console:services

Email 14 endpoints

GET /api/v2/shared-hosting/{accountId}/email-accounts

List email accounts read:hosting

POST /api/v2/shared-hosting/{accountId}/email-accounts

Create email account write:hosting, console:services

DELETE /api/v2/shared-hosting/{accountId}/email-accounts/{address}

Delete email account write:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/email-accounts/{address}/actions/mail-profile-link

Create Apple Mail setup profile link for an email account read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/email-accounts/{address}/actions/sso

Create webmail login link for an email account console:services, write:hosting

GET /api/v2/shared-hosting/{accountId}/email-accounts/{address}/mobileconfig

Download Apple Mail setup profile for an email account read:hosting, console:services

PUT /api/v2/shared-hosting/{accountId}/email-accounts/{address}/password

Reset email account password write:hosting, console:services

PUT /api/v2/shared-hosting/{accountId}/email-accounts/{address}/quota

Replace email account quota write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/email-deliverability

Inspect cPanel email authentication records read:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/email-forwarders

List email forwarders read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/email-forwarders

Create email forwarder write:hosting, console:services

DELETE /api/v2/shared-hosting/{accountId}/email-forwarders/{address}

Delete email forwarder destinations write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/email-routing

Get email routing mode read:hosting, console:services

PUT /api/v2/shared-hosting/{accountId}/email-routing

Set email routing mode write:hosting, console:services

Hosting Accounts 30 endpoints

GET /api/v2/mail-profiles/{token}

Download Apple Mail setup profile from a link public

GET /api/v2/shared-hosting

List shared-hosting accounts read:services

GET /api/v2/shared-hosting/{accountId}

Get shared-hosting account read:hosting

PATCH /api/v2/shared-hosting/{accountId}

Rename shared-hosting account write:hosting

GET /api/v2/shared-hosting/{accountId}/account-details

Get hosting access details read:services

GET /api/v2/shared-hosting/{accountId}/account-stats

Get hosting usage stats read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/actions/cancel

Cancel shared-hosting account write:billing

GET /api/v2/shared-hosting/{accountId}/actions/pause

Get hosting pause status read:services

POST /api/v2/shared-hosting/{accountId}/actions/pause

Pause shared hosting write:billing

DELETE /api/v2/shared-hosting/{accountId}/actions/pause

Cancel hosting pause write:billing

POST /api/v2/shared-hosting/{accountId}/actions/renew

Renew shared hosting write:billing

POST /api/v2/shared-hosting/{accountId}/actions/reset-password

Reset hosting control-panel password write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/actions/sso

Check control-panel SSO availability read:hosting

POST /api/v2/shared-hosting/{accountId}/actions/sso

Create hosting control-panel SSO link console:services, write:hosting

GET /api/v2/shared-hosting/{accountId}/addons/storage

List hosting storage add-ons read:services

POST /api/v2/shared-hosting/{accountId}/addons/storage

Order hosting storage add-on write:billing

GET /api/v2/shared-hosting/{accountId}/backups

List hosting backups read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/backups/{snapshotId}/actions/restore

Restore hosting backup write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/backups/queue/{queueRef}

Get hosting restore status read:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/cancellation

Get shared-hosting cancellation status read:hosting

DELETE /api/v2/shared-hosting/{accountId}/cancellation

Remove shared-hosting cancellation write:billing

GET /api/v2/shared-hosting/{accountId}/disk-quota

Get hosting disk quota read:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/domains

List hosting domains read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/domains

Add hosting domain write:hosting, console:services

DELETE /api/v2/shared-hosting/{accountId}/domains

Remove hosting domain write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/domains/dns-setup

Read hosting DNS setup state for a domain read:hosting, read:dns, console:services

POST /api/v2/shared-hosting/{accountId}/domains/dns-setup

Apply hosting DNS setup for a domain write:hosting, write:dns, console:services

GET /api/v2/shared-hosting/{accountId}/logs/error-log

Read website error log read:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/mail-settings

Get mail app settings for a hosted domain read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/page-cache/actions/purge

Purge website page cache write:hosting, console:services

Plans & Billing 5 endpoints

GET /api/v2/shared-hosting/{accountId}/actions/billing-cycle

Get hosting billing-cycle options read:hosting

POST /api/v2/shared-hosting/{accountId}/actions/billing-cycle

Change hosting billing cycle write:billing

GET /api/v2/shared-hosting/{accountId}/actions/upgrade

List hosting upgrade options read:services

POST /api/v2/shared-hosting/{accountId}/actions/upgrade

Change hosting plan write:billing

DELETE /api/v2/shared-hosting/{accountId}/actions/upgrade

Cancel scheduled hosting change write:billing

SSH 4 endpoints

GET /api/v2/shared-hosting/{accountId}/ssh-keys

List hosting SSH keys read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/ssh-keys

Import hosting SSH key write:hosting, console:services

DELETE /api/v2/shared-hosting/{accountId}/ssh-keys/{fingerprint}

Delete hosting SSH key write:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/ssh-keys/{fingerprint}/actions/authorize

Authorize hosting SSH key write:hosting, console:services

SSL 1 endpoints

POST /api/v2/shared-hosting/{accountId}/ssl/actions/run-autossl

Run AutoSSL certificate check write:hosting, console:services

WordPress 14 endpoints

GET /api/v2/shared-hosting/{accountId}/wordpress

List WordPress sites read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/wordpress

Install WordPress write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/wordpress-plugins

List WordPress plugins read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/wordpress-plugins/{slug}/actions/install

Install WordPress plugin write:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/wordpress-plugins/{slug}/actions/toggle

Enable or disable WordPress plugin write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/wordpress/{siteId}

Get WordPress site read:hosting, console:services

DELETE /api/v2/shared-hosting/{accountId}/wordpress/{siteId}

Uninstall WordPress write:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/wordpress/{siteId}/actions/clone

Clone WordPress site write:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/wordpress/{siteId}/actions/sso

Create WordPress admin SSO link write:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/wordpress/{siteId}/actions/staging

Create WordPress staging site write:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/wordpress/{siteId}/actions/upgrade

Upgrade WordPress site write:hosting, console:services

GET /api/v2/shared-hosting/{accountId}/wordpress/actions/scan

Scan for unmanaged WordPress sites read:hosting, console:services

POST /api/v2/shared-hosting/{accountId}/wordpress/import

Import WordPress installations write:hosting, console:services

POST /api/v2/shared-hosting/wordpress/batch

Batch list WordPress sites read:services