API Documentation

List VPS

Returns all VPS instances accessible to the authenticated API key.

Request

GET /api/v1/vps

Required scope: vps:read

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Response

{
  "data": [
    {
      "id": "699cdea2ab57a244bb5273fd",
      "name": "my-server",
      "status": "RUNNING",
      "cores": 4,
      "mem": 8,
      "nvme": 20,
      "hdd": 0,
      "os": "Ubuntu 22.04",
      "datacenter": "SkyLink Data Center BV",
      "country": "NL",
      "ip": "45.84.196.79",
      "cpuUsage": 1.02,
      "memUsage": 42.31,
      "nvmeUsage": 0.44,
      "hddUsage": 0,
      "availability": 100,
      "subscription": {
        "cancelledAt": null,
        "expiresAt": null,
        "interval": "1 month"
      },
      "createdAt": "2026-02-23T23:11:30.525Z"
    }
  ]
}

Response Fields

Field Type Description
id string Unique server identifier
name string Server display name
status string Current status: RUNNING, STOPPED, INSTALLING, etc.
cores number Number of CPU cores
mem number RAM in GB
nvme number NVMe storage in GB
hdd number HDD storage in GB
os string Operating system
datacenter string Datacenter name
country string Country code (ISO 3166-1 alpha-2)
ip string | null Primary IPv4 address
cpuUsage number CPU usage percentage (0–100)
memUsage number Memory usage percentage (0–100)
nvmeUsage number NVMe usage percentage (0–100)
hddUsage number HDD usage percentage (0–100)
availability number Uptime percentage (0–100)
subscription object | null Subscription status: cancelledAt, expiresAt, interval
createdAt string ISO 8601 creation timestamp

Example

curl https://hosting.site.quest/api/v1/vps \
  -H "Authorization: Bearer sq_live_a94ecfca096d..."

MCP

This data is also available via the list_vms MCP tool.