Skip to content

VPS API ​

Virtual Private Servers

Endpoints ​

MethodPathDescription
GET/v1/vpsList VPS
POST/v1/vpsCreate VPS
GET/v1/vps/plans/List plans
GET/v1/vps/os-templates/List OS templates
GET/v1/vps/{vps_id}Get VPS
GET/v1/vps/{vps_id}/statusGet status
POST/v1/vps/{vps_id}/startStart VPS
POST/v1/vps/{vps_id}/stopStop VPS
POST/v1/vps/{vps_id}/rebootReboot VPS

GET /v1/vps ​

List VPS

Get all VPS instances with hostname, IP addresses, power state, and resource allocation.

Response:

FieldTypeDescription
totalinteger
vps_instancesarray

Example:

bash
curl https://api.wayscloud.services/v1/vps \
  -H "X-API-Key: YOUR_API_KEY"

POST /v1/vps ​

Create VPS

Provision a new VPS. Takes 1-3 minutes. Include SSH keys for passwordless access.

Request Body:

FieldTypeDescription
hostnamestringRequired. Server hostname (FQDN recommended)
plan_codestringRequired. VPS plan code (from GET /v1/vps/plans/)
regionstringRequired. Location as an ISO 3166-1 country code, any letter case: no for Norway, or se, de, nl and other VPS locations. oslo, norway and no-oslo-1 are also accepted. Responses return the code in upper case (NO).
os_templatestringRequired. Operating system template (name from GET /v1/vps/os-templates/)
display_namestringUser-friendly name for dashboard display
ssh_keysarraySSH public keys for server access (recommended)
tagsarrayTags for grouping: at most 20, lowercase letters, digits and hyphens, up to 50 characters each
labelsobjectKey-value labels: at most 20, keys up to 50 and values up to 200 characters

Response:

FieldTypeDescription
idstring
provider_vm_idstringIdentifier of the virtual machine on its host platform; empty until provisioned
hostnamestring
display_namestring
plan_codestring
plan_namestring
regionstringCountry code of the location, upper case (NO). Requests accept any letter case.
os_templatestring
vcpuinteger
ram_mbinteger
disk_gbinteger
ipv4_addressstring
ipv6_addressstring
statusstringLifecycle state, for example provisioning, active, stopped or error
power_statestringon or off (unknown before the first status check)
monthly_pricenumber
currencystring
tagsarrayUser-defined tags for grouping
labelsobjectKey-value labels
disk_formatstringDisk image format: qcow2 or raw
snapshot_supportedbooleanWhether snapshots and backups are available for this VPS
created_atstring
provisioned_atstring
metricsobjectLive usage, filled in by GET /v1/vps/{vps_id} for an active VPS when the host answers; null otherwise

Example:

bash
curl -X POST https://api.wayscloud.services/v1/vps \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{...}'

GET /v1/vps/plans/ ​

List plans

Get available VPS configurations with vCPU, RAM, storage, bandwidth, and pricing.

Response:

Example:

bash
curl https://api.wayscloud.services/v1/vps/plans/ \
  -H "X-API-Key: YOUR_API_KEY"

GET /v1/vps/os-templates/ ​

List OS templates

Get available operating systems for VPS provisioning: Ubuntu, Debian, Rocky, AlmaLinux, and Windows Server.

Response:

Example:

bash
curl https://api.wayscloud.services/v1/vps/os-templates/ \
  -H "X-API-Key: YOUR_API_KEY"

GET /v1/vps/ ​

Get VPS

Get complete VPS details: hostname, IP addresses, OS, plan, and configuration.

Response:

FieldTypeDescription
idstring
provider_vm_idstringIdentifier of the virtual machine on its host platform; empty until provisioned
hostnamestring
display_namestring
plan_codestring
plan_namestring
regionstringCountry code of the location, upper case (NO). Requests accept any letter case.
os_templatestring
vcpuinteger
ram_mbinteger
disk_gbinteger
ipv4_addressstring
ipv6_addressstring
statusstringLifecycle state, for example provisioning, active, stopped or error
power_statestringon or off (unknown before the first status check)
monthly_pricenumber
currencystring
tagsarrayUser-defined tags for grouping
labelsobjectKey-value labels
disk_formatstringDisk image format: qcow2 or raw
snapshot_supportedbooleanWhether snapshots and backups are available for this VPS
created_atstring
provisioned_atstring
metricsobjectLive usage, filled in by GET /v1/vps/{vps_id} for an active VPS when the host answers; null otherwise

Example:

bash
curl https://api.wayscloud.services/v1/vps/{vps_id} \
  -H "X-API-Key: YOUR_API_KEY"

GET /v1/vps/{vps_id}/status ​

Get status

Check power state (running/stopped), uptime, and health indicators.

Response:

FieldTypeDescription
vps_idstring
statusstring
power_statestringon or off
uptimestring
cpu_usagestring
ram_usagestring
disk_usagestring
traffic_instringNot reported yet: always null
traffic_outstringNot reported yet: always null
traffic_totalstringNot reported yet: always null

Example:

bash
curl https://api.wayscloud.services/v1/vps/{vps_id}/status \
  -H "X-API-Key: YOUR_API_KEY"

POST /v1/vps/{vps_id}/start ​

Start VPS

Power on a stopped VPS. Accessible within 30-60 seconds.

Response:

FieldTypeDescription
okboolean
actionstring
vps_idstring
messagestring

Example:

bash
curl -X POST https://api.wayscloud.services/v1/vps/{vps_id}/start \
  -H "X-API-Key: YOUR_API_KEY"

POST /v1/vps/{vps_id}/stop ​

Stop VPS

Gracefully shut down a running VPS. Stopped VPS still incurs storage costs.

Response:

FieldTypeDescription
okboolean
actionstring
vps_idstring
messagestring

Example:

bash
curl -X POST https://api.wayscloud.services/v1/vps/{vps_id}/stop \
  -H "X-API-Key: YOUR_API_KEY"

POST /v1/vps/{vps_id}/reboot ​

Reboot VPS

Graceful reboot. Back online within 1-2 minutes.

Response:

FieldTypeDescription
okboolean
actionstring
vps_idstring
messagestring

Example:

bash
curl -X POST https://api.wayscloud.services/v1/vps/{vps_id}/reboot \
  -H "X-API-Key: YOUR_API_KEY"