Client API: Cloud Compute

Cloud Compute VM instances (power, console, backups, and details). Paths remain under /api/v1/client/vps.

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Client API reference.

GET /api/v1/client/vps

List all VPS instances owned by the current user.

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/templates

OS templates ready for order/rebuild: enabled and ready on at least one active node.

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}

Get VPS instance details including template metadata.

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/backups

List backups for this instance.

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/vps/{uuid}/backups

Create a new backup of this instance.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json

DELETE /api/v1/client/vps/{uuid}/backups/{backup_id}

Delete a backup.

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/vps/{uuid}/backups/{backup_id}/restore

Restore from a backup. This will restart the VPS.

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/bandwidth

Get current billing period bandwidth usage vs plan traffic allotment (TB).

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/vps/{uuid}/cloud-init/regenerate

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/config

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/console

Mint a VNC console session (WebSocket path + RFB password).

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/credentials

Username + whether a password is stored (no plaintext).

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/graphs

Get RRD graph data from Proxmox.

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/guest

Authentication: an access token, sent as Authorization: Bearer <token>.

PATCH /api/v1/client/vps/{uuid}/hostname

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

GET /api/v1/client/vps/{uuid}/ips

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/vps/{uuid}/name

Give the instance a name in a zone the customer holds: A and AAAA records for its addresses, optionally the same name as reverse DNS and as the guest hostname.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

POST /api/v1/client/vps/{uuid}/power

Execute a power action on the VPS.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

GET /api/v1/client/vps/{uuid}/ptr

Reverse DNS of every address attached to the instance.

Authentication: an access token, sent as Authorization: Bearer <token>.

PATCH /api/v1/client/vps/{uuid}/ptr

Set the reverse DNS of one attached address (the primary by default).

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

POST /api/v1/client/vps/{uuid}/rebuild

Rebuild the VPS with a new OS template. This destroys all data.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

POST /api/v1/client/vps/{uuid}/rescue/enter

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

POST /api/v1/client/vps/{uuid}/rescue/exit

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/rescue/media

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/vps/{uuid}/reset-password

Reset the root/admin password. Requires QEMU guest agent.

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/vps/{uuid}/resize-preview

Capacity/mode preview for a plan change resize (billing via /services change-plan).

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

GET /api/v1/client/vps/{uuid}/snapshots

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/vps/{uuid}/snapshots

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

DELETE /api/v1/client/vps/{uuid}/snapshots/{snapshot_id}

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/vps/{uuid}/snapshots/{snapshot_id}/rollback

Authentication: an access token, sent as Authorization: Bearer <token>.

PUT /api/v1/client/vps/{uuid}/ssh-keys

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

GET /api/v1/client/vps/{uuid}/status

Get real-time VM status from Proxmox (enriched).

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/vps/{uuid}/tasks

Authentication: an access token, sent as Authorization: Bearer <token>.