VPS Services

Fixed-cycle VPS instances, actions, backups, snapshots, console, networking, and maintenance

97 endpoints

Backups 11 Firewall 6 Images & Rebuild 9 Monitoring & Jobs 5 Networking 2 Plans & Billing 5 Snapshots 7 Storage 5 VM 47

Backups 11 endpoints

GET /api/v2/vps/{id}/backup-schedules

List VPS backup schedules read:vm

POST /api/v2/vps/{id}/backup-schedules

Create or replace VPS backup schedule write:vm

PATCH /api/v2/vps/{id}/backup-schedules

Update VPS backup settings write:vm

DELETE /api/v2/vps/{id}/backup-schedules/{scheduleId}

Delete VPS backup schedule write:vm

GET /api/v2/vps/{id}/backups

List VPS backups read:vm

POST /api/v2/vps/{id}/backups

Create VPS backup backup:vm

DELETE /api/v2/vps/{id}/backups/{backupId}

Delete VPS backup backup:vm

POST /api/v2/vps/{id}/backups/{backupId}/actions/restore

Restore VPS backup backup:vm

POST /api/v2/vps/{id}/backups/{backupId}/actions/restore-to-payg

Restore backup to a new Cloud VM backup:vm, write:billing

POST /api/v2/vps/{id}/backups/actions/restore-from-vps

Restore backup from another VPS backup:vm

GET /api/v2/vps/{id}/backups/restore-sources

List restore source backups backup:vm

Firewall 6 endpoints

GET /api/v2/vps/{id}/firewall

List VPS firewall rules read:vm

POST /api/v2/vps/{id}/firewall

Add VPS firewall rule write:vm

PUT /api/v2/vps/{id}/firewall/{pos}

Replace VPS firewall rule write:vm

DELETE /api/v2/vps/{id}/firewall/{pos}

Delete VPS firewall rule write:vm

GET /api/v2/vps/{id}/firewall/options

Get VPS firewall options read:vm

PUT /api/v2/vps/{id}/firewall/options

Update VPS firewall options write:vm

Images & Rebuild 9 endpoints

POST /api/v2/vps/{id}/actions/rebuild

Rebuild VPS write:vm, rebuild:vm

GET /api/v2/vps/{id}/iso

List VPS ISO media read:vm

DELETE /api/v2/vps/{id}/iso/{volid}

Delete VPS ISO media write:vm, write:storage

POST /api/v2/vps/{id}/iso/actions/attach-empty

Attach empty CD/DVD device write:vm, write:storage

POST /api/v2/vps/{id}/iso/actions/from-url

Download ISO from URL write:vm, write:storage

POST /api/v2/vps/{id}/iso/actions/mount

Mount ISO on VPS write:vm, write:storage

POST /api/v2/vps/{id}/iso/actions/set-boot-order

Set VPS boot order write:vm, write:storage

POST /api/v2/vps/{id}/iso/actions/unmount

Unmount VPS ISO write:vm, write:storage

GET /api/v2/vps/{id}/templates

List VPS rebuild templates read:vm

Monitoring & Jobs 5 endpoints

GET /api/v2/vps/{id}/maintenance

Get VPS maintenance state read:vm

POST /api/v2/vps/{id}/maintenance/actions/extend

Extend VPS maintenance deadline write:vm

GET /api/v2/vps/{id}/metrics

Get VPS metrics read:vm

GET /api/v2/vps/{id}/status

Get VPS live status read:vm

GET /api/v2/vps/metrics

List live VPS metrics read:services

Networking 2 endpoints

GET /api/v2/vps/{id}/network

Get VPS network state read:vm

POST /api/v2/vps/{id}/network

Change VPS network state write:vm, write:network

Plans & Billing 5 endpoints

GET /api/v2/vps/{id}/actions/billing-cycle

Get VPS billing-cycle options read:services

POST /api/v2/vps/{id}/actions/billing-cycle

Change VPS billing cycle write:billing

GET /api/v2/vps/{id}/actions/upgrade

Get VPS upgrade options read:services

POST /api/v2/vps/{id}/actions/upgrade

Change VPS plan write:billing

DELETE /api/v2/vps/{id}/actions/upgrade

Cancel scheduled VPS change write:billing

Snapshots 7 endpoints

GET /api/v2/vps/{id}/snapshot-schedules

Get VPS snapshot schedule read:vm

POST /api/v2/vps/{id}/snapshot-schedules

Set VPS snapshot schedule write:vm

DELETE /api/v2/vps/{id}/snapshot-schedules

Delete VPS snapshot schedule write:vm

GET /api/v2/vps/{id}/snapshots

List VPS snapshots read:services

POST /api/v2/vps/{id}/snapshots

Create VPS snapshot backup:vm

DELETE /api/v2/vps/{id}/snapshots/{snapshotId}

Delete VPS snapshot backup:vm

POST /api/v2/vps/{id}/snapshots/{snapshotId}/actions/restore

Restore VPS snapshot backup:vm

Storage 5 endpoints

DELETE /api/v2/vps/{id}/disk-throttle

Remove VPS disk throttle write:vm

GET /api/v2/vps/{id}/disks

List VPS disks read:vm

DELETE /api/v2/vps/{id}/disks/{diskName}

Delete VPS disk write:vm, write:storage

GET /api/v2/vps/{id}/storage

Get VPS storage state read:vm

GET /api/v2/vps/{id}/storage-quota

Get VPS storage quota read:vm

VM 47 endpoints

GET /api/v2/routed-ipv6

List account routed IPv6 read:network, read:vm

POST /api/v2/routed-ipv6

Allocate a routed IPv6 pool or route a subnet write:network

DELETE /api/v2/routed-ipv6/{id}

Release an empty routed IPv6 pool write:network

DELETE /api/v2/routed-ipv6/routes/{id}

Delete a routed IPv6 route write:network

GET /api/v2/ssh-keys

List VPS SSH keys read:vm

POST /api/v2/ssh-keys

Create VPS SSH key write:account

PATCH /api/v2/ssh-keys/{id}

Rename VPS SSH key write:account

DELETE /api/v2/ssh-keys/{id}

Delete VPS SSH key write:account

GET /api/v2/vps

List VPS instances read:services

GET /api/v2/vps/{id}

Get VPS details read:services

POST /api/v2/vps/{id}/actions/add-disk

Add VPS disk write:vm, write:storage

POST /api/v2/vps/{id}/actions/cancel

Cancel VPS write:billing

POST /api/v2/vps/{id}/actions/config

Change VPS resource options write:billing

POST /api/v2/vps/{id}/actions/renew

Renew VPS write:billing

POST /api/v2/vps/{id}/actions/reset

Reset VPS power:vm

POST /api/v2/vps/{id}/actions/reset-password

Reset VPS root password write:vm

POST /api/v2/vps/{id}/actions/reset-ssh-keys

Reset VPS SSH keys write:vm

POST /api/v2/vps/{id}/actions/resize-disk

Resize VPS disk write:vm, write:storage

POST /api/v2/vps/{id}/actions/restart

Restart VPS power:vm

POST /api/v2/vps/{id}/actions/shutdown

Shutdown VPS power:vm

POST /api/v2/vps/{id}/actions/start

Start VPS power:vm

POST /api/v2/vps/{id}/actions/stop

Stop VPS power:vm

GET /api/v2/vps/{id}/active-jobs

List active VPS jobs read:vm

DELETE /api/v2/vps/{id}/active-jobs

Cancel active VPS job by type backup:vm

GET /api/v2/vps/{id}/agent/exec

Get VPS guest-agent command state read:vm, write:vm

POST /api/v2/vps/{id}/agent/exec

Run command inside VPS write:vm

GET /api/v2/vps/{id}/autorenew

Get VPS auto-renewal setting read:vm

POST /api/v2/vps/{id}/autorenew

Set VPS auto-renewal write:vm

GET /api/v2/vps/{id}/cancellation

Get VPS cancellation status read:vm

DELETE /api/v2/vps/{id}/cancellation

Remove VPS cancellation write:billing

GET /api/v2/vps/{id}/console

Create VPS console session console:vm

GET /api/v2/vps/{id}/details

Get detailed VPS state read:vm

GET /api/v2/vps/{id}/firmware

Get VPS firmware mode read:vm

PUT /api/v2/vps/{id}/firmware

Change VPS firmware mode write:vm, write:storage

GET /api/v2/vps/{id}/hostname

Get VPS hostname read:vm

PUT /api/v2/vps/{id}/hostname

Change VPS hostname write:vm

GET /api/v2/vps/{id}/mail-relay

Get VPS mail-relay status read:vm

POST /api/v2/vps/{id}/mail-relay/charge-consent

Update VPS mail-relay billing consent write:billing

POST /api/v2/vps/{id}/mail-relay/quota-requests

Create prepaid mail-relay quota invoice write:billing

GET /api/v2/vps/{id}/memory

Get VPS guest memory read:vm

PUT /api/v2/vps/{id}/metadata

Update VPS display metadata write:vm

GET /api/v2/vps/{id}/routed-ipv6

Deprecated: VPS routed IPv6 state read:network

POST /api/v2/vps/{id}/routed-ipv6

Deprecated: allocate routed IPv6 for a VPS write:network

DELETE /api/v2/vps/{id}/routed-ipv6

Deprecated: release routed IPv6 for a VPS write:network

GET /api/v2/vps/{id}/ssh-keys

List VPS SSH keys read:vm

GET /api/v2/vps/{id}/ssh-password-login

Get VPS SSH password-login state read:vm

PATCH /api/v2/vps/{id}/ssh-password-login

Set VPS SSH password login write:vm