Host

Hosts are the hypervisor machines that run instances (typically an administrator-scoped read).

Resource base path: /restapi/host

Method	Path	Description
GET	/restapi/host/hostList	Host List

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Host List

Host List.

GET /restapi/host/hostList

Parameters

Parameter	In	Type	Required	Description
uuid	query	string	No	UUID of the resource.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/host/hostList" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listHostResponse": [
    {
      "cpuAllocated": "string",
      "memoryUsedPercentage": "string",
      "cpuUsed": "string",
      "memoryAllocatedPercentage": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCores": "string",
      "memoryTotal": "string",
      "hypervisor": "string",
      "name": "example-name",
      "podName": "example-name",
      "vmCount": "string",
      "status": "Active"
    }
  ]
}