v1.0.0 OAS 3.0.0

HostUp API

Download OpenAPI Document

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

Authentication

Include your API key in the X-API-Key header with every request.

Create and manage API keys at cloud.hostup.se/api-management. You can define scopes for each key to limit permissions — for example, restrict a DNS key to only manage specific record types or zones.

For detailed setup instructions, see the API Authentication Guide.

Rate Limits

250 requests per minute per API key. When you exceed the limit, you'll receive a 429 Too Many Requests response.

Header Description
X-RateLimit-Limit Max requests allowed
X-RateLimit-Remaining Requests remaining in current window
X-RateLimit-Reset ISO timestamp when limit resets
Retry-After Seconds until retry (on 429 only)

Error Format

All errors return a consistent JSON structure:

{ "success": false, "error": "Error message", "code": 400 }

Integration Examples

Developer Tips

Explore the API in your browser

Our customer portal at cloud.hostup.se uses the exact same API that you have access to as a developer. Open your browser's DevTools (F12), go to the Network tab, and perform any action in the portal to see the API calls being made. This is a great way to discover endpoints and understand request/response formats.

Using an AI assistant?

Each endpoint page has a "Copy for LLM" button that copies a structured prompt with all the endpoint details. Paste it into ChatGPT, Claude, or your preferred AI assistant to quickly generate integration code, understand the endpoint, or troubleshoot issues.

Domains & DNS

Domain registration, transfers, nameservers, DNS, redirects, CDN, and forwarding

Operations
GET /api/client-domains GET /api/domains/hosting-status GET /api/dyndns/update GET /api/email-verification/status POST /api/domain-check GET /api/domain-lookup POST /api/dns/zones/{zoneId}/records GET /api/dns/zones/{zoneId}/records GET /api/domains/transfer-errors GET /api/dns-propagation POST /api/dns-propagation GET /api/cdn/zones PUT /api/cdn/zones GET /api/dns/zones GET /api/domain-products GET /api/email-forwarding POST /api/email-forwarding DELETE /api/email-forwarding GET /api/redirects POST /api/redirects DELETE /api/redirects GET /api/cdn/proxy-rules POST /api/cdn/proxy-rules PUT /api/cdn/proxy-rules DELETE /api/cdn/proxy-rules GET /api/nameserver-templates POST /api/nameserver-templates PUT /api/dns/zones/{zoneId}/records/{recordId} DELETE /api/dns/zones/{zoneId}/records/{recordId} POST /api/cdn/batch-status POST /api/domain-exists POST /api/lookup-nameservers GET /api/dns-test GET /api/whois GET /api/domain-details/{id} GET /api/domain-order/{id} POST /api/email-verification/confirmed GET /api/redirects/check-dns GET /api/dns/domain/{domain} POST /api/domain-access POST /api/domains/{id}/status-sync GET /api/domain-contacts/{id} POST /api/domain-contacts/{id} POST /api/domain-transfers/generate GET /api/domains/{id}/transfer-error POST /api/email-forwarding/enable GET /api/dns/verify/{domain} POST /api/dns/verify/{domain} DELETE /api/dns/verify/{domain} GET /api/domains/{domainId}/webhotel-check POST /api/email-verification/resend GET /api/domains/{id}/registry-status GET /api/domains/{domainId}/dyndns POST /api/domains/{domainId}/dyndns POST /api/domains/bulk/autorenew GET /api/domain-check/{jobId} POST /api/domains/bulk/dns/add GET /api/domain-preferences POST /api/domain-preferences POST /api/domains/bulk/renew POST /api/domain-transfer/{id} GET /api/domains/{domainId}/dnssec POST /api/domains/{domainId}/dnssec GET /api/domains/{domainId}/dnssec-auto POST /api/domains/{domainId}/dnssec-auto GET /api/domains/{domainId}/glue-records POST /api/domains/{domainId}/glue-records GET /api/domain-verify-identity/{domainId} POST /api/domain-edit/{id} POST /api/registry-lock/request-unlock POST /api/email-forwarding/disable POST /api/domains/{domainId}/nameservers PUT /api/email-forwarding/catch-all GET /api/domain-pending-renewal/{id} DELETE /api/domains/{id}/delete GET /api/domains/{domainId}/dyndns/{configId}/logs GET /api/domains/{id}/billing-cycle POST /api/domains/{id}/billing-cycle POST /api/domains/{domainId}/outgoing-transfer POST /api/domain-identity-verification-links/{domainId} POST /api/domain-epp/{id} POST /api/dns/zones/{zoneId}/smartcopy-scan POST /api/dns/zones/{zoneId}/smartcopy POST /api/domain-renew/{id} DELETE /api/domains/{domainId}/glue-records/{hostname} GET /api/domains/{id}/pending-order PATCH /api/domains/{domainId}/dyndns/{configId} DELETE /api/domains/{domainId}/dyndns/{configId} POST /api/domains/bulk/contacts POST /api/domains/bulk/redirects DELETE /api/dns/zones/{zoneId} DELETE /api/domains/{domainId}/dnssec/{recordId} POST /api/domains/{domainId}/retry-transfer POST /api/domains/bulk/dns/delete

Web Hosting

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

Operations
GET /api/hosting-accounts POST /api/hosting/billing-cycles/batch POST /api/hosting/wordpress/batch GET /api/webhotel-products POST /api/cpanel-sso GET /api/cart/existing-webhosting POST /api/get-account-details GET /api/hosting/{accountId}/email-accounts POST /api/hosting/{accountId}/email-accounts DELETE /api/hosting/{accountId}/email-accounts POST /api/hosting/{accountId}/addon-domains POST /api/hosting/{accountId}/ssh-keys GET /api/hosting/{accountId}/ssh-keys PUT /api/hosting/{accountId}/email-accounts/password POST /api/hosting/{accountId}/upgrade GET /api/hosting/{accountId}/upgrade PUT /api/hosting-accounts/{accountId}/name GET /api/hosting/{accountId}/files GET /api/hosting/{accountId}/domains GET /api/hosting/{accountId}/billing-cycle POST /api/hosting/{accountId}/billing-cycle GET /api/hosting/{accountId}/cpanel/account-info GET /api/hosting/{accountId}/wordpress GET /api/hosting/{accountId}/ssl-certificates GET /api/hosting/{accountId}/addons/storage POST /api/hosting/{accountId}/addons/storage GET /api/hosting/{accountId}/cpanel/server-info GET /api/hosting/{accountId}/error-log GET /api/hosting/{accountId}/email-routing GET /api/hosting/{accountId}/wordpress/scan POST /api/hosting/{accountId}/files/read GET /api/hosting/{accountId}/php GET /api/hosting/{accountId}/php/installed POST /api/hosting/{accountId}/redirects POST /api/hosting/{accountId}/email-forwarders GET /api/hosting/{accountId}/email-forwarders POST /api/hosting/{accountId}/wordpress/uninstall POST /api/hosting/{accountId}/ssh-keys/authorize

VPS & Cloud

Virtual machines, cloud capacity, networking, firewalls, backups, and maintenance

Operations
GET /api/vps-accounts/{id} GET /api/vm/{vmid}/active-jobs DELETE /api/vm/{vmid}/active-jobs GET /api/vm/{vmid}/rebuild-status GET /api/vm/{vmid}/firewall/group POST /api/vm/{vmid}/firewall/group DELETE /api/vm/{vmid}/firewall/group GET /api/firewall-groups POST /api/firewall-groups GET /api/vm/{vmid}/metrics GET /api/vps-accounts GET /api/vm/{vmid}/agent/exec POST /api/vm/{vmid}/agent/exec GET /api/vm/{vmid}/firmware PUT /api/vm/{vmid}/firmware GET /api/vm/{vmid}/hostname POST /api/vm/{vmid}/hostname GET /api/vps-products POST /api/vps/pending-maintenance GET /api/vm/{vmid}/firewall POST /api/vm/{vmid}/firewall DELETE /api/vm/{vmid}/firewall PUT /api/vm/{vmid}/firewall GET /api/vm/{vmid}/firewall/options PUT /api/vm/{vmid}/firewall/options GET /api/vm/{vmid}/backups POST /api/vm/{vmid}/backups PUT /api/vm/{vmid}/backups GET /api/vm/{vmid}/iso POST /api/vm/{vmid}/iso DELETE /api/vm/{vmid}/iso GET /api/vm/{vmid}/cpu-type PUT /api/vm/{vmid}/cpu-type GET /api/private-networks POST /api/private-networks GET /api/volumes GET /api/vm/{vmid}/snapshots DELETE /api/vm/{vmid}/snapshots POST /api/vm/{vmid}/snapshots GET /api/vm/{vmid}/snapshot-schedules POST /api/vm/{vmid}/snapshot-schedules GET /api/vm/{vmid}/details GET /api/vm/{vmid}/status POST /api/vm/{vmid}/status GET /api/vm/{vmid}/details-poll GET /api/vm/{vmid}/agent/memory GET /api/vm/{vmid}/maintenance GET /api/vm/{vmid}/autorenew POST /api/vm/{vmid}/autorenew GET /api/vm/{vmid}/backup-schedules POST /api/vm/{vmid}/backup-schedules DELETE /api/vm/{vmid}/backup-schedules GET /api/firewall-groups/{id} PUT /api/firewall-groups/{id} DELETE /api/firewall-groups/{id} GET /api/port25/requests POST /api/port25/requests GET /api/cloud/limits GET /api/vm/{vmid}/console GET /api/vm/{vmid}/network POST /api/vm/{vmid}/network GET /api/vm/{vmid}/templates GET /api/vm/{vmid}/routed-ipv6 POST /api/vm/{vmid}/routed-ipv6 DELETE /api/vm/{vmid}/routed-ipv6 GET /api/vm/{vmid}/storage GET /api/vm/{vmid}/storage-quota 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}/ddos-scrubbing POST /api/vm/{vmid}/ddos-scrubbing DELETE /api/vm/{vmid}/ddos-scrubbing GET /api/vm/{vmid}/disks POST /api/vm/{vmid}/rebuild GET /api/vm/{vmid}/network/ip-availability POST /api/vm/{vmid}/reset-password POST /api/vm/{vmid}/reset-ssh-keys GET /api/private-networks/{id} DELETE /api/private-networks/{id} POST /api/cloud/limits/request GET /api/cloud/{accountId}/resize POST /api/cloud/{accountId}/resize GET /api/vm/{vmid}/convert-to-cloud DELETE /api/vm/{vmid}/backups/{volid} POST /api/vm/{vmid}/add-disk POST /api/vm/{vmid}/resize-disk POST /api/vm/{vmid}/maintenance/extend

Object Storage

Buckets, objects, lifecycle settings, usage, and access keys

Billing & Orders

Invoices, payments, credits, pricing, and order creation

Account & Access

Profiles, delegated access, contacts, sessions, and account preferences

Support

Support tickets, availability, feedback, and attachments