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.

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 GET /api/vps-products GET /api/firewall-groups POST /api/firewall-groups GET /api/private-networks POST /api/private-networks GET /api/floating-ip GET /api/vm/{vmid}/agent/exec POST /api/vm/{vmid}/agent/exec GET /api/notifications/{id} POST /api/notifications/{id} GET /api/volumes GET /api/vm/{vmid}/firewall/group POST /api/vm/{vmid}/firewall/group DELETE /api/vm/{vmid}/firewall/group POST /api/lookup-nameservers GET /api/vm/{vmid}/status POST /api/vm/{vmid}/status GET /api/port25/requests POST /api/port25/requests GET /api/vm/{vmid}/details-poll GET /api/vps-accounts/{id} GET /api/vm/{vmid}/details GET /api/vm/{vmid}/autorenew POST /api/vm/{vmid}/autorenew GET /api/vm/{vmid}/agent/memory GET /api/vm/{vmid}/console GET /api/vm/{vmid}/firewall POST /api/vm/{vmid}/firewall PUT /api/vm/{vmid}/firewall DELETE /api/vm/{vmid}/firewall GET /api/vm/{vmid}/firewall/options PUT /api/vm/{vmid}/firewall/options GET /api/vm/{vmid}/backup-schedules POST /api/vm/{vmid}/backup-schedules DELETE /api/vm/{vmid}/backup-schedules POST /api/server-tags DELETE /api/server-tags GET /api/vm/{vmid}/backups POST /api/vm/{vmid}/backups PUT /api/vm/{vmid}/backups GET /api/vm/{vmid}/storage GET /api/vm/{vmid}/disks GET /api/product-overview/vps GET /api/cloud/limits GET /api/vm/{vmid}/iso POST /api/vm/{vmid}/iso DELETE /api/vm/{vmid}/iso GET /api/vm/{vmid}/storage-quota GET /api/vm/{vmid}/upgrade POST /api/vm/{vmid}/upgrade GET /api/vm/{vmid}/network POST /api/vm/{vmid}/network GET /api/vm/{vmid}/billing-cycle POST /api/vm/{vmid}/billing-cycle GET /api/vm/{vmid}/firmware PUT /api/vm/{vmid}/firmware POST /api/vps/pending-maintenance GET /api/vm/{vmid}/crowdsec POST /api/vm/{vmid}/crowdsec GET /api/vm/{vmid}/hostname POST /api/vm/{vmid}/hostname GET /api/vm/{vmid}/routed-ipv6 POST /api/vm/{vmid}/routed-ipv6 DELETE /api/vm/{vmid}/routed-ipv6 GET /api/vm/{vmid}/templates GET /api/vm/{vmid}/snapshots DELETE /api/vm/{vmid}/snapshots POST /api/vm/{vmid}/snapshots POST /api/vm/{vmid}/reset-password GET /api/vm/{vmid}/snapshot-schedules POST /api/vm/{vmid}/snapshot-schedules GET /api/firewall-groups/{id} PUT /api/firewall-groups/{id} DELETE /api/firewall-groups/{id} POST /api/vm/{vmid}/rebuild GET /api/vm/{vmid}/maintenance GET /api/private-networks/{id} DELETE /api/private-networks/{id} POST /api/vm/{vmid}/reset-ssh-keys DELETE /api/vm/{vmid}/backups/{volid} POST /api/vm/{vmid}/maintenance/extend

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/email-verification/status GET /api/verify/status POST /api/domain-check GET /api/dyndns/update 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 DELETE /api/redirects GET /api/domain-products GET /api/company-representatives GET /api/nameserver-templates POST /api/nameserver-templates GET /api/domains/hosting-status POST /api/create-order GET /api/cdn/proxy-rules PUT /api/cdn/proxy-rules POST /api/cdn/proxy-rules DELETE /api/cdn/proxy-rules GET /api/email-forwarding POST /api/email-forwarding DELETE /api/email-forwarding GET /api/dns/zones GET /api/dns-test POST /api/cdn/batch-status POST /api/domain-exists GET /api/audit-log GET /api/whois GET /api/domain-preferences POST /api/domain-preferences POST /api/cancel-hosting GET /api/domain-order/{id} GET /api/domain-details/{id} POST /api/email-verification/confirmed POST /api/domain-access GET /api/email-endpoints POST /api/email-endpoints GET /api/redirects/check-dns GET /api/dns/domain/{domain} POST /api/domain-transfers/generate GET /api/domain-contacts/{id} POST /api/domain-contacts/{id} GET /api/domains/{domainId}/dyndns POST /api/domains/{domainId}/dyndns POST /api/email-verification/resend POST /api/contact POST /api/email-forwarding/enable POST /api/domains/bulk/renew POST /api/domains/bulk/autorenew POST /api/registry-lock/request-unlock POST /api/domains/{id}/status-sync GET /api/domains/{domainId}/webhotel-check GET /api/domains/{domainId}/dnssec POST /api/domains/{domainId}/dnssec POST /api/feedback GET /api/domains/{domainId}/dnssec-auto POST /api/domains/{domainId}/dnssec-auto POST /api/monitoring/status GET /api/domain-check/{jobId} POST /api/domains/{domainId}/nameservers PUT /api/email-forwarding/catch-all GET /api/product-overview/tlds/{tld} POST /api/domains/bulk/dns/add GET /api/domain-verify-identity/{domainId} POST /api/email-forwarding/disable GET /api/jobs/{jobId} POST /api/domain-edit/{id} PUT /api/dns/zones/{zoneId}/records/{recordId} DELETE /api/dns/zones/{zoneId}/records/{recordId} POST /api/domain-epp/{id} POST /api/domain-transfer/{id} GET /api/domains/{domainId}/dyndns/{configId}/logs GET /api/domains/{id}/billing-cycle POST /api/domains/{id}/billing-cycle GET /api/domains/{domainId}/glue-records POST /api/domains/{domainId}/glue-records POST /api/domain-renew/{id} DELETE /api/domains/{id}/delete PATCH /api/domains/{domainId}/dyndns/{configId} DELETE /api/domains/{domainId}/dyndns/{configId} GET /api/hosting/{accountId}/domains GET /api/domain-pending-renewal/{id} POST /api/domain-identity-verification-links/{domainId} POST /api/notifications/url-monitors/{id}/test GET /api/notifications/url-monitors/{id}/history DELETE /api/domains/{domainId}/dnssec/{recordId} POST /api/email-endpoints/{id}/verify PUT /api/email-endpoints/{id}

Web Hosting Services

Web hosting account operations and features

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

Billing & Payments

Invoices, payment methods, ordering, and credits

Account & Settings

User profiles, teams, contacts, and account preferences

Support System

Support tickets, helpdesk, and attachments