GET /dashboard/service/{id}/vps/overview

Get VPS overview

Retrieve detailed information about a specific VPS by its service ID.

Parameters

Name	Type	In	Description
`id`*	`integer`	path	The service ID of the VPS to retrieve.

Response

200

403

404

dataobject

vmidinteger

statusstring

ipstring

namestring

uptimeinteger

nodestring

diskinteger

maxdiskinteger

diskreadinteger

diskwriteinteger

cpunumber

meminteger

maxmeminteger

netoutinteger

netininteger

cpusinteger

maxcpuinteger

operating_systemstring

operating_system_versionstring

uplinkinteger

suspendedboolean

suspension_reasonstring

successboolean

Request

curl -X GET "https://api.royalehosting.net/dashboard/service/{id}/vps/overview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-organization-id: YOUR_ORG_ID"

Request

const response = await fetch("https://api.royalehosting.net/dashboard/service/{id}/vps/overview", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "x-organization-id": "YOUR_ORG_ID",
  },
});

const data = await response.json();

Request

import requests

response = requests.get(
    "https://api.royalehosting.net/dashboard/service/{id}/vps/overview",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "x-organization-id": "YOUR_ORG_ID",
    }
)

print(response.json())

Response

{
  "data": {
    "vmid": 0,
    "status": "string",
    "ip": "string",
    "name": "string",
    "uptime": 0,
    "node": "string",
    "disk": 0,
    "maxdisk": 0,
    "diskread": 0,
    "diskwrite": 0,
    "cpu": 0,
    "mem": 0,
    "maxmem": 0,
    "netout": 0,
    "netin": 0,
    "cpus": 0,
    "maxcpu": 0,
    "operating_system": "string",
    "operating_system_version": "string",
    "uplink": 0,
    "suspended": true,
    "suspension_reason": "string"
  },
  "success": true
}