Get Instance

API Version: 1.1.0 (06-Jan-2025)

Get VPS instance details

Get VPS instance details

GEThttps://api.cloud.onidel.com/vm/{vm_id}

Authorization

api_key

Path parameters

vm_id*string (uuid)

VPS UUID that need to be considered for filter

Query parameters

Response

200400401

Successful operation

Body

application/json

idstring (uuid)

Example: "c1d45377-b2a9-4407-ab8d-6909c34dfaac"

namestring (string)

Example: "ubuntu-vm-4vcpu-8gb"

vcpuinteger (int64)

Example: 2

raminteger (int64)

Example: 4096

diskinteger (int64)

Example: 40

bw_usednumber (float)

Example: 12.5

main_ipv4string (string)

Example: "160.22.79.122"

main_ipv6string (string)

Example: "2401:a4a0:1:90::1"

usernamestring (string)

Example: "root"

passwordstring (string)

Example: "aHbf6!&8sH"

templatestring (string)

Example: "Ubuntu 24.04 x64 LTS"

created_atstring (datetime)

Example: "2024-10-04T10:20:22.922772Z"

renewed_atstring (datetime)

Example: "2024-10-04T10:20:22.922772Z"

due_datestring (datetime)

Example: "2024-10-04T10:20:22.922772Z"

recurring_amountnumber (float)

Example: 5.5

payment_currencystring (string)

Example: "AUD"

billing_cycleinteger (int64)

Example: 1

statusinteger (int64)

Example: 1

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.cloud.onidel.com/vm/{vm_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "c1d45377-b2a9-4407-ab8d-6909c34dfaac",
  "name": "ubuntu-vm-4vcpu-8gb",
  "vcpu": 2,
  "ram": 4096,
  "disk": 40,
  "bw_used": 12.5,
  "main_ipv4": "160.22.79.122",
  "main_ipv6": "2401:a4a0:1:90::1",
  "username": "root",
  "password": "aHbf6!&8sH",
  "template": "Ubuntu 24.04 x64 LTS",
  "created_at": "2024-10-04T10:20:22.922772Z",
  "renewed_at": "2024-10-04T10:20:22.922772Z",
  "due_date": "2024-10-04T10:20:22.922772Z",
  "recurring_amount": 5.5,
  "payment_currency": "AUD",
  "billing_cycle": 1,
  "status": 1
}