v1.0.0 OAS 3.0.0

HostUp API

Download OpenAPI Document

API for managing VPS servers, domains, hosting services, DNS, and billing.

Authentication

See API Authentication Guide for setup instructions.

Integration Examples

General

System information and utility endpoints

VPS Services

Virtual machines, storage, networking, and snapshots

Operations
GET /api/vm/{vmid}/active-jobs GET /api/vm/{vmid}/rebuild-status GET /api/vm/{vmid}/metrics GET /api/vps-accounts POST /api/cloud/quick-deploy GET /api/vps-products POST /api/firewall-groups GET /api/vm/{vmid}/status POST /api/vm/{vmid}/status GET /api/windows-vps-products GET /api/vm/{vmid}/firewall/group POST /api/vm/{vmid}/firewall/group GET /api/notifications/{id} GET /api/vm/{vmid}/agent/exec POST /api/vm/{vmid}/agent/exec POST /api/lookup-nameservers POST /api/port25/requests GET /api/vps-accounts/{id} GET /api/vm/{vmid}/details-poll GET /api/vm/{vmid}/details GET /api/vm/{vmid}/autorenew GET /api/vm/{vmid}/agent/memory GET /api/vm/{vmid}/iso POST /api/vm/{vmid}/iso DELETE /api/vm/{vmid}/iso GET /api/vm/{vmid}/firewall/options PUT /api/vm/{vmid}/firewall/options GET /api/vm/{vmid}/firewall POST /api/vm/{vmid}/firewall PUT /api/vm/{vmid}/firewall DELETE /api/vm/{vmid}/firewall POST /api/server-tags DELETE /api/server-tags GET /api/vm/{vmid}/upgrade POST /api/vm/{vmid}/upgrade GET /api/vm/{vmid}/billing-cycle POST /api/vm/{vmid}/billing-cycle GET /api/vm/{vmid}/console GET /api/vm/{vmid}/disks GET /api/vm/{vmid}/storage POST /api/validate-nameservers GET /api/vm/{vmid}/backup-schedules POST /api/vm/{vmid}/backup-schedules DELETE /api/vm/{vmid}/backup-schedules GET /api/vm/{vmid}/storage-quota GET /api/vm/{vmid}/network GET /api/vm/{vmid}/backups POST /api/vm/{vmid}/backups PUT /api/vm/{vmid}/backups GET /api/vm/{vmid}/firmware PUT /api/vm/{vmid}/firmware GET /api/vm/{vmid}/crowdsec POST /api/vm/{vmid}/crowdsec GET /api/vm/{vmid}/hostname GET /api/product-overview/vps GET /api/vm/{vmid}/routed-ipv6 POST /api/vm/{vmid}/routed-ipv6 DELETE /api/vm/{vmid}/routed-ipv6 POST /api/vm/{vmid}/reset-password GET /api/vm/{vmid}/snapshots DELETE /api/vm/{vmid}/snapshots POST /api/vm/{vmid}/snapshots GET /api/vm/{vmid}/templates GET /api/vm/{vmid}/snapshot-schedules POST /api/vm/{vmid}/snapshot-schedules POST /api/vm/{vmid}/rebuild POST /api/vm/{vmid}/reset-ssh-keys GET /api/product-overview/vps/{slug} GET /api/firewall-groups/{id} POST /api/cloud/{accountId}/resize DELETE /api/vm/{vmid}/backups/{volid} POST /api/vm/{vmid}/add-disk GET /api/vm/{vmid}/cloud-init

Domain Services

Domain registration, transfers, WHOIS, and DNS management

Operations
GET /api/dns/zones/{zoneId}/records POST /api/dns/zones/{zoneId}/records GET /api/client-domains GET /api/domain-pins POST /api/domain-pins GET /api/dyndns/update POST /api/domain-check GET /api/domain-lookup GET /api/dns-propagation POST /api/dns-propagation GET /api/cdn/zones PUT /api/cdn/zones GET /api/redirects POST /api/redirects POST /api/ai-suggestions GET /api/domain-products GET /api/product-details/{id} GET /api/nameserver-templates POST /api/nameserver-templates GET /api/dns/zones GET /api/dns-test POST /api/scan-dns-records POST /api/domain-exists GET /api/whois GET /api/domain-preferences POST /api/domain-preferences GET /api/domain-order/{id} GET /api/domain-details/{id} POST /api/domain-access GET /api/dns/domain/{domain} GET /api/redirects/check-dns GET /api/domain-contacts/{id} POST /api/domain-contacts/{id} POST /api/domain-transfers/generate POST /api/domains/{id}/status-sync POST /api/email-verification/resend GET /api/domains/{domainId}/dnssec POST /api/domains/{domainId}/dnssec POST /api/registry-lock/request-unlock GET /api/domains/{domainId}/dnssec-auto POST /api/domains/{domainId}/dnssec-auto GET /api/domain-check/{jobId} HEAD /api/domain-check/{jobId} POST /api/domains/bulk/autorenew GET /api/domains/{domainId}/dyndns POST /api/domains/{domainId}/dyndns GET /api/domain-verify-identity/{domainId} POST /api/domain-edit/{id} POST /api/domains/bulk/renew PUT /api/dns/zones/{zoneId}/records/{recordId} DELETE /api/dns/zones/{zoneId}/records/{recordId} POST /api/domains/{domainId}/nameservers GET /api/jobs/{jobId} POST /api/domain-epp/{id} POST /api/transfers/details GET /api/domains/{domainId}/glue-records POST /api/domains/{domainId}/glue-records GET /api/domains/{domainId}/dyndns/{configId}/logs GET /api/product-overview/tlds/{tld} GET /api/domains/{id}/billing-cycle POST /api/domains/{id}/billing-cycle DELETE /api/domains/{id}/delete POST /api/domain-transfer/{id} POST /api/domain-renew/{id} GET /api/domain-pending-renewal/{id} POST /api/domain-identity-verification-links/{domainId} PATCH /api/domains/{domainId}/dyndns/{configId} DELETE /api/domains/{domainId}/dyndns/{configId} POST /api/domains/bulk/dns/add DELETE /api/domains/{domainId}/dnssec/{recordId} DELETE /api/domains/{domainId}/glue-records/{hostname} POST /api/domains/bulk/dns/delete

Hosting Management

Shared hosting configuration and management

Web Hosting Services

Web hosting account operations and features

Operations
GET /api/product-overview/webhosting GET /api/hosting-accounts HEAD /api/hosting-accounts POST /api/cpanel-ownership-check POST /api/hosting/wordpress/batch POST /api/hosting/billing-cycles/batch POST /api/cpanel-sso GET /api/webhotel-products POST /api/get-account-details GET /api/hosting/{accountId}/save-offers GET /api/domains/{domainId}/webhotel-check GET /api/hosting/{accountId}/wordpress POST /api/hosting/{accountId}/wordpress-sso GET /api/hosting/{accountId}/jetbackup/backups GET /api/hosting/{accountId}/files GET /api/hosting/{accountId}/jetbackup/queue POST /api/hosting-tags POST /api/hosting/{accountId}/jetbackup/restore POST /api/hosting/{accountId}/redirects GET /api/hosting/{accountId}/redirects DELETE /api/hosting/{accountId}/redirects POST /api/hosting/{accountId}/wordpress/uninstall POST /api/hosting/{accountId}/addon-domains DELETE /api/hosting/{accountId}/addon-domains GET /api/hosting/{accountId}/addons/storage POST /api/hosting/{accountId}/addons/storage PUT /api/hosting-accounts/{accountId}/name GET /api/hosting/{accountId}/domains GET /api/hosting/{hostingId}/jetbackup/info GET /api/hosting/{accountId}/cpanel/account-info POST /api/hosting/{accountId}/pause GET /api/hosting/{accountId}/upgrade POST /api/hosting/{accountId}/upgrade GET /api/hosting/{accountId}/cpanel/server-info GET /api/product-overview/webhosting/{slug} GET /api/hosting/{accountId}/ssl-certificates POST /api/hosting/{accountId}/files/read GET /api/hosting/{accountId}/ftp-accounts POST /api/hosting/{accountId}/ftp-accounts DELETE /api/hosting/{accountId}/ftp-accounts GET /api/hosting/{accountId}/account-stats GET /api/hosting/{accountId}/error-log GET /api/hosting/{accountId}/wordpress/scan GET /api/hosting/{accountId}/php GET /api/hosting/{accountId}/database-users POST /api/hosting/{accountId}/database-users DELETE /api/hosting/{accountId}/database-users GET /api/hosting/{hostingId}/jetbackup/account GET /api/hosting/{hostingId}/jetbackup/downloads GET /api/hosting/{accountId}/php/installed POST /api/hosting/{accountId}/wordpress/import POST /api/hosting/{accountId}/wordpress/install POST /api/hosting/{accountId}/wordpress/backup GET /api/hosting/{accountId}/wordpress/backups POST /api/hosting/{accountId}/wordpress/upgrade POST /api/hosting/{accountId}/wordpress/clone POST /api/hosting/{accountId}/wordpress/staging POST /api/hosting/{accountId}/files/write GET /api/hosting/{accountId}/disk-quota GET /api/hosting/{accountId}/databases PUT /api/hosting/{accountId}/database-users/password POST /api/hosting/{accountId}/database-users/privileges DELETE /api/hosting/{accountId}/database-users/privileges GET /api/hosting/{accountId}/cron-jobs POST /api/hosting/{accountId}/cpanel/reset-password

Email Services

Email forwarding, verification, and spam protection

Billing & Payments

Invoices, payment methods, ordering, and credits

Account & Settings

User profiles, teams, contacts, and account preferences

Support System

Support tickets, helpdesk, and attachments