Get VPS

Returns detailed information about a single VPS, including live status and configuration from the hosting provider.

Request

GET /api/v1/vps/{id}

Required scope: vps:read

Path Parameters

Parameter	Type	Description
`id`	string	The VPS ID

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,
    "ips": 1,
    "backupSlots": 0,
    "networkSpeed": 1000,
    "os": "Ubuntu 22.04",
    "iso": null,
    "datacenter": "SkyLink Data Center BV",
    "country": "NL",
    "cpuUsage": 1.02,
    "memUsage": 42.31,
    "nvmeUsage": 0.44,
    "hddUsage": 0,
    "availability": 100,
    "ipv4": [
      {
        "address": "45.84.196.79",
        "gateway": "45.84.196.1",
        "rdns": "my-server.site.quest"
      }
    ],
    "ipv6": [],
    "config": { ... },
    "liveStatus": { ... },
    "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
`cores`	number	Number of CPU cores
`mem`	number	RAM in GB
`nvme`	number	NVMe storage in GB
`hdd`	number	HDD storage in GB
`ips`	number	Number of IP addresses
`backupSlots`	number	Number of backup slots
`networkSpeed`	number	Network speed in Mbit/s
`os`	string	Operating system
`iso`	string \| null	Mounted ISO image, if any
`datacenter`	string	Datacenter name
`country`	string	Country code
`cpuUsage`	number	CPU usage percentage
`memUsage`	number	Memory usage percentage
`nvmeUsage`	number	NVMe usage percentage
`hddUsage`	number	HDD usage percentage
`availability`	number	Uptime percentage
`ipv4`	array	IPv4 addresses with gateway and rDNS
`ipv6`	array	IPv6 addresses
`config`	object \| null	Live configuration from hosting provider
`liveStatus`	object \| null	Live status from hosting provider
`subscription`	object \| null	Subscription status (see below)
`createdAt`	string	ISO 8601 creation timestamp

Subscription Fields

Field	Type	Description
`cancelledAt`	string \| null	When the subscription was cancelled (ISO 8601), or `null` if active
`expiresAt`	string \| null	When the subscription expires (ISO 8601), or `null` if renewing
`interval`	string \| null	Billing interval (e.g. `"1 month"`, `"12 months"`)

Sensitive fields like password and username are stripped from the config object.

Errors

Status	Code	Description
404	`NOT_FOUND`	VPS not found or access denied

Example

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

MCP

This data is also available via the get_vm MCP tool.