VPS
107 endpoints. Servers, power, reinstall, backups, snapshots, IP addresses, firewall and SSH keys.
Servers
- GET List VPS instances
/vps - GET Get a VPS
/vps/{id} - GET List running jobs on a VPS
/vps/{id}/active-jobs - DELETE Cancel a running VPS backup or restore
/vps/{id}/active-jobs - GET Get VPS bandwidth usage for this period
/vps/{id}/bandwidth - GET Get VPS details and action gates
/vps/{id}/details - GET Check VPS reachability from the internet
/vps/{id}/diagnostics/connectivity - DELETE Remove a VPS disk limit
/vps/{id}/disk-throttle - GET List VPS disks
/vps/{id}/disks - DELETE Delete a VPS disk
/vps/{id}/disks/{diskName} - GET Get the hostname of a VPS
/vps/{id}/hostname - PUT Change the hostname of a VPS
/vps/{id}/hostname - GET Get live memory use of a VPS
/vps/{id}/memory - PUT Set display labels for a VPS
/vps/{id}/metadata - GET Get usage metrics of a VPS
/vps/{id}/metrics - GET Get the live status of a VPS
/vps/{id}/status - GET Get the disks and filesystems of a VPS
/vps/{id}/storage - GET Get the storage allowance of a VPS
/vps/{id}/storage-quota - GET List CPU and memory use of all VPS
/vps/metrics - GET Get paid-through dates for VPS
/vps/paid-periods
Power
- POST Hard reboot a VPS
/vps/{id}/actions/reset - POST Restart a VPS
/vps/{id}/actions/restart - POST Shut down a VPS
/vps/{id}/actions/shutdown - POST Start a VPS
/vps/{id}/actions/start - POST Force a VPS to power off
/vps/{id}/actions/stop
Reinstall and boot
- POST Reinstall a VPS
/vps/{id}/actions/rebuild - GET Get VPS firmware mode
/vps/{id}/firmware - PUT Change the firmware mode of a VPS
/vps/{id}/firmware - GET List ISO images and CD/DVD drives
/vps/{id}/iso - DELETE Delete an ISO image
/vps/{id}/iso/{volid} - POST Add an empty CD/DVD drive
/vps/{id}/iso/actions/attach-empty - POST Download an ISO image from a URL
/vps/{id}/iso/actions/from-url - POST Mount an ISO image on a VPS
/vps/{id}/iso/actions/mount - POST Set the boot order of a VPS
/vps/{id}/iso/actions/set-boot-order - POST Unmount an ISO image from a VPS
/vps/{id}/iso/actions/unmount - GET List the operating systems for a VPS
/vps/{id}/templates
Backups
- GET List VPS backup schedules
/vps/{id}/backup-schedules - POST Set a VPS backup schedule
/vps/{id}/backup-schedules - PATCH Update VPS backup settings
/vps/{id}/backup-schedules - DELETE Delete a VPS backup schedule
/vps/{id}/backup-schedules/{scheduleId} - GET List VPS backups
/vps/{id}/backups - POST Create a VPS backup
/vps/{id}/backups - DELETE Delete a VPS backup
/vps/{id}/backups/{backupId} - POST Restore a VPS from a backup
/vps/{id}/backups/{backupId}/actions/restore - POST Restore a backup to a new Cloud VPS
/vps/{id}/backups/{backupId}/actions/restore-to-payg - POST Restore a backup of another VPS
/vps/{id}/backups/actions/restore-from-vps - GET List backups to restore from other VPS
/vps/{id}/backups/restore-sources
Snapshots
- GET Get the snapshot schedule of a VPS
/vps/{id}/snapshot-schedules - POST Set the snapshot schedule of a VPS
/vps/{id}/snapshot-schedules - DELETE Delete the snapshot schedule of a VPS
/vps/{id}/snapshot-schedules - GET List the snapshots of a VPS
/vps/{id}/snapshots - POST Take a snapshot of a VPS
/vps/{id}/snapshots - DELETE Delete a snapshot of a VPS
/vps/{id}/snapshots/{snapshotId} - POST Restore a snapshot on a VPS
/vps/{id}/snapshots/{snapshotId}/actions/restore
Access and console
- GET List saved SSH keys
/ssh-keys - POST Save an SSH key
/ssh-keys - POST Reset a VPS password
/vps/{id}/actions/reset-password - POST Replace the saved SSH keys on a VPS
/vps/{id}/actions/reset-ssh-keys - GET Get guest agent status or command output
/vps/{id}/agent/exec - POST Run a command inside a VPS
/vps/{id}/agent/exec - GET Open a VPS console
/vps/{id}/console - GET List the SSH keys that can log in to a VPS
/vps/{id}/ssh-access - PATCH Change the SSH keys that can log in to a VPS
/vps/{id}/ssh-access - GET List saved SSH keys for a VPS
/vps/{id}/ssh-keys - GET Check SSH password login on a VPS
/vps/{id}/ssh-password-login - PATCH Turn SSH password login on or off
/vps/{id}/ssh-password-login
SSH keys
Network and IP addresses
- GET List routed IPv6 pools and routes
/routed-ipv6 - POST Allocate an IPv6 /48 or route a subnet
/routed-ipv6 - DELETE Release a routed IPv6 /48
/routed-ipv6/{id} - DELETE Delete a routed IPv6 route
/routed-ipv6/routes/{id} - GET Get DDoS scrubbing status
/vps/{id}/ddos-scrubbing - POST Enable DDoS scrubbing
/vps/{id}/ddos-scrubbing - DELETE Disable DDoS scrubbing
/vps/{id}/ddos-scrubbing - GET Get DDoS filtering measurements
/vps/{id}/ddos-scrubbing/traffic - GET Get the mail relay status of a VPS
/vps/{id}/mail-relay - POST Turn pay-as-you-go mail relay sending on or off
/vps/{id}/mail-relay/charge-consent - POST Buy a higher monthly mail relay limit
/vps/{id}/mail-relay/quota-requests - GET Get the network setup of a VPS
/vps/{id}/network - POST Change the network setup of a VPS
/vps/{id}/network - GET Get VPS routed IPv6 (deprecated)
/vps/{id}/routed-ipv6 - POST Add VPS routed IPv6 (deprecated)
/vps/{id}/routed-ipv6 - DELETE Remove VPS routed IPv6 (deprecated)
/vps/{id}/routed-ipv6
Firewall
- GET List VPS firewall rules
/vps/{id}/firewall - POST Add a VPS firewall rule
/vps/{id}/firewall - PUT Replace a VPS firewall rule
/vps/{id}/firewall/{pos} - DELETE Delete a VPS firewall rule
/vps/{id}/firewall/{pos} - GET Get VPS firewall options
/vps/{id}/firewall/options - PUT Update VPS firewall options
/vps/{id}/firewall/options
Plan, renewal and cancellation
- POST Add a disk to a VPS
/vps/{id}/actions/add-disk - GET List VPS billing cycle options
/vps/{id}/actions/billing-cycle - POST Change a VPS billing cycle
/vps/{id}/actions/billing-cycle - POST Cancel a VPS
/vps/{id}/actions/cancel - POST Change VPS resources
/vps/{id}/actions/config - POST Renew a VPS
/vps/{id}/actions/renew - POST Resize a VPS disk
/vps/{id}/actions/resize-disk - GET List VPS plan change options
/vps/{id}/actions/upgrade - POST Change the plan of a VPS
/vps/{id}/actions/upgrade - DELETE Cancel a scheduled VPS change
/vps/{id}/actions/upgrade - GET Get VPS auto-renewal setting
/vps/{id}/autorenew - POST Turn VPS auto-renewal on or off
/vps/{id}/autorenew - GET Get VPS cancellation status
/vps/{id}/cancellation - DELETE Remove a VPS cancellation
/vps/{id}/cancellation - GET List pending maintenance of a VPS
/vps/{id}/maintenance - POST Extend a VPS maintenance deadline
/vps/{id}/maintenance/actions/extend