Sign up

Get a VPS

GET/api/v1/vps/{vps_uuid}

One VPS with its status, addresses and this month's traffic.

Parameters

NameInDescription
vps_uuidpath, stringrequiredVPS id, from Create a VPS or List VPS

Example request

curl -X GET "https://platform.serverscamp.com/api/v1/vps/$VPS_UUID" \
  -H "Authorization: Bearer $API_TOKEN"

Answer

Status 200 with this body.

FieldTypeDescription
vps_uuidstringrequiredVPS id
namestringrequiredName given at create
plan_idstringrequiredPlan id
plan_namestring, optionalPlan name
planVpsPlan, optionalThe plan, also when it is no longer on sale
plan.idstringrequiredPlan id, for create and plan changes
plan.namestringrequiredName shown in the Cloud Panel
plan.vcpuintegerrequiredvCPU cores
plan.cpu_limitnumber, optionalShare of the cores the server may use, set on plans below one full core
plan.ram_gbnumberrequiredMemory, GB
plan.disk_gbintegerrequiredDisk, GB
plan.traffic_gbintegerrequiredOutbound traffic a month, GB; after it the port runs at 100 Mbit/s
plan.net_mbitintegerrequiredPort speed, Mbit/s
plan.disk_iopsintegerrequiredDisk operations a second
plan.disk_mbpsintegerrequiredDisk throughput, MB/s
plan.price_monthlynumberrequiredPrice a month, EUR, billed by the hour
plan.backup_sharenumberrequiredDaily backups add this share of the plan price
imagestringrequiredImage id of the installed system
backupsbooleanrequiredDaily backups on
statusstringrequiredqueued, cloning, configuring, starting, running, stopped, restoring, reinstalling, deleting, unpaid (stopped when the balance ran out) or error
ipv4string, optionalPublic IPv4 address
ipv6_prefixstring, optionalIPv6 /56 of the server; its first address is ::1
ptrstring, optionalReverse DNS name of the addresses
ptr_custombooleanrequiredReverse DNS was set by you, not the default name
cpu_modelstring, optionalCPU model of the host
diskstring, optionalDisk type of the host: NVMe or SSD
errorstring, optionalWhat went wrong, when status is error
created_atstring, optionalWhen it was created, ISO 8601
net_cappedbooleanrequiredThe port is at 100 Mbit/s until the next month: the quota is used up
uptimeinteger, optionalSeconds since the server was last started; lower than before once a reboot is done (a reset leaves it as it is). Only in Get a VPS, not in List VPS
trafficVpsTrafficrequired
traffic.monthstringrequiredCalendar month, UTC, as YYYY-MM
traffic.out_bytesintegerrequiredOutbound bytes this month; counts against the plan quota
traffic.in_bytesintegerrequiredInbound bytes this month; free
{
  "vps_uuid": "12d46f8c-d66e-4163-99aa-1245d5b06e5b",
  "name": "web-1",
  "plan_id": "vps2-1",
  "plan_name": "VPS 1",
  "image": "ubuntu-26.04",
  "backups": true,
  "status": "running",
  "ipv4": "185.236.9.61",
  "ipv6_prefix": "2a01:ea05:0:f00::/56",
  "ptr": "web-1-a1b2c3.vm.scamp.pro",
  "ptr_custom": false,
  "cpu_model": "Intel Xeon Gold 6154",
  "disk": "NVMe",
  "error": null,
  "created_at": "2026-10-23T08:12:40+00:00",
  "net_capped": false,
  "traffic": {
    "month": "2026-10",
    "out_bytes": 1830000000,
    "in_bytes": 920000000
  }
}

Errors

StatusWhen
401No token, or a token that is not valid
404No such VPS in your account
422The body or a parameter is not what the operation takes

Every operation can also answer 401 without a valid token. All errors