VPS

List all VPS servers

get/vps/

Get all VPS servers in your organization with complete details including specifications, status, and network configuration.

Authorization

Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Responses

Successful Response

application/json

array<VPSListItem>

id*integer

label*string

name*string

hostname*string

status*string

user*string

plan?VPSPlanInfo | null

Resources and price of the plan the server runs on.

Properties (6)

plan_name*string

ram*integer

Memory in MB.

cpu*integer

Number of vCPUs.

storage*integer

Disk size in GB.

bandwidth*integer

Included monthly traffic in TB.

price_per_hour*number

template?VPSTemplateInfo | null

Operating system or application image installed on the server.

Properties (3)

template_name?string | null

os_name*string

operating_system?string | null

floating_ips*VPSFloatingIPs

Public IPs attached to the server and their combined hourly price.

Properties (2)

list*array<VPSFloatingIPItem>

Properties (5)

address*string

netmask*string

type*string

IPv4 or IPv6.

protection_type*string

DDoS protection tier applied to this address.

is_primary*boolean

price_per_hour*number

ssh_keys?array<VPSSSHKeyInfo>

Properties (2)

name*string

fingerprint?string | null

location?VPSLocationInfo | null

Datacenter the server runs in.

Properties (2)

description?string | null

location_name*string

cpu?VPSCpuInfo | null

CPU vendor and family of the physical host the server runs on (never the exact model).

Properties (2)

vendor*string

AMD or Intel.

family*string

e.g. AMD EPYC, AMD Ryzen, AMD Ryzen Threadripper, Intel Xeon.

network?VPSNetworkInfo | null

Private network the server is attached to.

Properties (6)

id*integer

name*string

label?string | null

ip_range*string

prefix*integer

assigned_ip*string

firewall_groups?array<VPSFirewallGroupInfo>

Properties (4)

id*integer

name*string

rules_count*integer

enabled?boolean | null

firewall_enabled?boolean | null

project?VPSProjectInfo | null

Project the server belongs to.

Properties (3)

id*integer

name*string

description?string | null

addons?array<ServiceAddonCustomerOut>

Properties (17)

uuid*string

slug*string

name*string

description?string | null

category*string

unit_label?string | null

quantity*integer

monthly_unit_price*number

monthly_total*number

hourly_total?number | null

setup_fee*number

billing_mode*string

status*string

contracted_at?string | null

cancel_effective_at?string | null

reference?string | null

currency?string

Default"USD"

addons_monthly_total?number

Default0

addons_price_per_hour?number

Default0

rescue?VPSRescueSummary | null

Rescue mode of the server, when it is in rescue (null otherwise).

Properties (2)

state*string

Value in"entering""active""exiting""failed"

configured*boolean

Whether the rescue system has its network, password and SSH keys applied.

source_snapshot_uuid?string | null

deploy_health?string | null