Developer API

Server detail (backbone-scrubbed — no upstream provider, no provisioning logs).

Live CPU / memory / network / disk usage.

Disk snapshots (restore points) for the server.

Every IP on the server with its current PTR record. `zoneHosted: false` means the reverse zone is not on our DNS and the PTR cannot be managed here.

Plans this server can resize to — same family, same disk size (a plan change never alters disk). Returns the current plan and the switchable options, cheapest first.

Power the server start, stop, or reboot. `:action` ∈ {start,stop,reboot}.

Issue a short-lived URL that logs into the dashboard for this server.

{ "next": "/optional/path" }

Switch to another plan in the same family with the same disk size — an in-place vCPU/RAM resize. The server reboots (~1 min) to apply; disk is never changed. Only the recurring price changes: no proration on an up-switch, no credit on a down-switch — the next renewal bills the new plan. Use GET /servers/:id/plan-options for valid targets.

{ "productId": "..." }

Add-ons this server's plan offers — extra IPs, /24 class blocks, the SEO IP Pack (7 dedicated IPs, each from a different /24, for SEO hosting and sender-reputation isolation) and backups. Prices are in cents: `monthly_usd_cents` recurs, `prorated_usd_cents` is what a purchase costs today. Only ONE add-on per type can be active, so `owned_by_type: true` means not orderable until the active one is removed. `available: false` with a `stock_note` means temporarily out of stock.

Attach an add-on to a running server. Debits your prepaid balance **immediately**, prorated to the end of the current cycle, and the add-on then renews with the server every month. For IP add-ons the addresses are routed to your server but must be configured inside the guest OS yourself. Returns 400 if an add-on of the same type is already active (remove it first), if stock is short, or if your balance will not cover it.

{ "addonId": "seoip7pk" }

Cancel an add-on. **No refund** is issued for the remainder of the current period — the recurring price drops from the next renewal. For IP add-ons this is immediate and disruptive: the addresses are released and stop routing to your server, so anything bound to them (sites, SSL, mail) breaks — unconfigure them first. Changing tier (8 IPs to 16 IPs) is a DELETE followed by a POST.

Take a disk snapshot. Honours an optional Idempotency-Key header.

{ "name": "pre-upgrade", "description": "before kernel bump" }

Remove a snapshot (non-destructive to the live disk).

Point the IP's PTR record at a hostname (e.g. `mail.example.com`). Idempotent upsert.

{ "hostname": "mail.example.com" }

Remove the PTR record for the IP.

DESTRUCTIVE — wipe the disk and rebuild from an OS template. Honours Idempotency-Key.

{ "osTemplate": "ubuntu-22.04", "os": "ubuntu" }

DESTRUCTIVE — roll the live disk back to a snapshot.

DESTRUCTIVE — permanently terminate the server.

Monthly price for a pool shape, with a per-unit breakdown and the resolved figures (vCPU, GB, addresses) so you can show the customer what they are actually getting. Nothing is charged. The purchase re-prices server-side, so a total worked out client-side is displayed but never trusted.

{ "productId": "...", "vcpu": 16, "ram2gb": 16, "disk100": 10, "ip16": 1 }

Every capacity pool on the account, with its quotas, status, monthly price and renewal date.

One pool plus live `usage` — the vCPU, RAM, disk, IPs and server count currently committed inside it — and the servers we know are in it. Usage counts PROVISIONED resources, not live consumption: a powered-off server still holds its allocation, because you can switch it back on. Also returns `bounds` (the range a resize may move each unit between, from the live catalogue) and, on the pool itself, `rates_cents` — the per-unit prices this pool was SOLD at, which is what a resize is charged at.

Buys a capacity pool and provisions it. Debits your prepaid balance immediately for the first month. Returns 400 if your balance will not cover it or the selection falls outside the product bounds. Once active, build free servers into it with POST /v1/pools/:id/servers.

{ "productId": "...", "label": "prod-cluster", "vcpu": 16, "ram2gb": 16, "disk100": 10, "ip16": 1 }

Prices a new shape without applying it: the new monthly, the difference, and `charge_now_usd_cents` — the prorated amount taken immediately for the days left in the cycle. Priced at the rates the pool was SOLD at, never at today's catalogue, so the figure matches what PATCH will charge.

{ "vcpu": 32, "ram2gb": 32, "disk100": 20, "ip16": 2 }

Changes the pool's shape. Takes the WHOLE shape in absolute units, not deltas — to add 8 vCPU to a 16-vCPU pool, send 24. **Growing is a purchase**: charged immediately, prorated, at the rates the pool was sold at. **Shrinking is not refunded** and lowers the price from the next renewal. Refuses to shrink below what the pool's servers already hold — delete servers first.

{ "vcpu": 32, "ram2gb": 32, "disk100": 20, "ip16": 2 }

Creates a server inside the pool. **It is free** — no charge now, no monthly price, no renewal; the pool carries the bill, and the server is checked against its quota instead of your balance. ⚑ `ipCount` chooses how many of the pool's own public addresses it takes (default 1). **`ipCount: 0` is private-only: no public interface, no default route, and no internet at all** — reachable from the pool's other servers on its private network and through the web console. Linux only.

{ "productId": "...", "label": "web-1", "os": "ubuntu", "osTemplate": "ubuntu-24.04", "ipCount": 1 }

Every IPv4 address the pool owns, with its PTR and which server holds it (`assignedTo: null` means free in the block). These came with the pool, so assigning one costs nothing — to get MORE, resize the pool's `ip16`.

Assign, move or return addresses within the pool's own block, in ONE batch. `serverId` names a server INSIDE this pool; `null` returns the address to the block. Free. Addresses never leave the block. The set is validated whole and refused entire if any entry names a server that is not in this pool. ⚑ The guest OS is not reconfigured for you, and moving an address away stops it routing at once — anything bound to it breaks. Rate limited to 6 calls per minute: each call reprograms the router once regardless of batch size, so send every change together rather than looping.

{ "changes": [ { "ip": "203.0.113.10", "serverId": "uuid" }, { "ip": "203.0.113.11", "serverId": null } ] }

DESTRUCTIVE — every server in the pool is powered off (preserved, not destroyed), the whole IP block is returned and the private network is deleted. **No refund** for the remainder of the cycle.

Hosting account detail (connection info, backbone-scrubbed).

Attach a custom domain to a hosting account.

{ "domain": "example.com" }

Re-check DNS and attach the custom domain once it points to us.

Detach the custom domain from the hosting account.

Tail the access or error log. Query: `kind` ∈ {access,error}, `lines`.

Retry the Let's Encrypt certificate issue now.

Switch the account's PHP-FPM version.

{ "php_version": "8.3" }

Read the crontab (header + jobs).

Replace the crontab.

{ "jobs": [ { "schedule": "0 3 * * *", "command": "php cron.php" } ] }

Password-protected directories (htpasswd).

Add or update a password-protected directory.

{ "path": "/admin", "basic_user": "u", "password": "…" }

Remove protection. Query: `path`.

ModSecurity WAF status for the account.

Whether temporary WAF-log access is active.

Request temporary access to WAF logs.

Whether browser-SSH terminal access is enabled.

Enable browser-SSH terminal access.

Start a browser-SSH session; returns a session URL/token.

Stop the browser-SSH session.

Git-deploy status for the account.

The SSH deploy key to add to your repo.

The push-to-deploy webhook URL/secret.

Enable push-to-deploy.

Disable push-to-deploy.

Clone/deploy a repo into the site.

{ "repo_url": "git@…", "branch": "main", "subdir": "" }

Pull the latest commit for the deployed repo.

Disconnect git deploy from the site.

List a directory. Query: `path` (default /public_html).

Read a text file's contents. Query: `path`.

Create or overwrite a text file.

{ "path": "/public_html/x.txt", "content": "…" }

Delete a file or directory. Query: `path`, `recursive`.

Stream a file as an attachment. Query: `path`.

Upload a file (multipart form field `file`). Query: `path`.

Create a directory.

{ "path": "/public_html/new" }

Rename or move a file/directory.

{ "from": "/a", "to": "/b" }

Site backups (restore points).

Create a new site backup.

Delete a backup.

Restore the site from a backup.

Stream a backup archive (gzip).

Visitor statistics. Query: `period` ∈ {24h,7d,30d}.

Extra MySQL databases on the account.

Create an extra MySQL database.

{ "suffix": "wp2" }

Delete an extra MySQL database.

Every mail domain on the account.

Enable email hosting for a domain.

{ "domain": "example.com" }

Disable email hosting for a domain (removes its mailboxes and aliases).

Mailboxes under one mail domain.

Forwarding aliases under one mail domain.

Every mailbox across all your mail domains.

Create a mailbox on a mail domain.

{ "domain_id": 12, "local_part": "info", "password": "…", "quota_mb": 2048 }

Set a new password for a mailbox.

{ "password": "…" }

Permanently delete a mailbox and its mail.

Create a forwarding alias (source → destination).

{ "domain_id": 12, "source_local": "sales", "destination": "info@example.com" }

Remove a forwarding alias.

Domain detail.

Update auto-renew, transfer lock, WHOIS privacy, or nameservers.

{ "auto_renew": true, "transfer_lock": true, "nameservers": ["ns1.example.com","ns2.example.com"] }

Single invoice with line items.

Prepaid wallet balance and state.

Recent wallet transactions. Query: limit.

Configure automatic wallet top-up when the balance drops below a threshold. Returns the updated wallet state.

{ "enabled": true, "threshold_usd_cents": 500, "amount_usd_cents": 2000 }

Ticket detail with the message thread.

Open a support ticket. Honours Idempotency-Key.

{ "subject": "Need help", "message": "…", "department": "technical", "priority": "medium" }

Post a customer reply on a ticket.

{ "body": "Thanks, that worked." }

Close the ticket.

Subscribe a URL to events. Secret returned ONCE.

{ "url": "https://example.com/hooks", "events": ["*"], "description": "prod" }

Webhook subscription detail (secret masked).

Change url, events, description, or pause/resume (isActive).

Delete a subscription.

Issue a fresh signing secret (returned ONCE). Old secret stops immediately.

Recent delivery attempts. Query: limit.

Re-queue a past delivery for another attempt.