Virtual Server

Get Information

Get information about a Virtual Server

get/api/services/{id}/vps/info

Request

Base URL: https://nodesty.com
URL: https://nodesty.com/api/services/{id}/vps/info
Auth: API key in header Authorization

Path parameters

idstring required

Example:1

Service ID

Response

Information about the VPS

diskinteger

Total disk space in bytes

hostnamestring

Hostname of the VPS

ipsstring[]

proxmoxIdinteger

Proxmox ID of the VPS

statusboolean

Current status of the VPS (true for active, false for inactive)

vpsIdinteger

Unique identifier for the VPS

Example response

{
  "cpu": {
    "cores": 4,
    "percent": 75.5
  },
  "disk": 10737418240,
  "hostname": "vps.example.com",
  "ips": [
    "192.168.1.100"
  ],
  "os": {
    "id": "debian",
    "name": "Debian GNU/Linux 12 (bookworm)"
  },
  "proxmoxId": 67890,
  "ram": {
    "free": 1073741824,
    "limit": 2147483648,
    "percent": 50,
    "used": 1073741824
  },
  "status": true,
  "vpsId": 12345
}

Changes

No recorded changes to this operation across all 3 revisions of this API.