Sign in
hypervisors

Fetch a hypervisor by ID.

Changed on
get/hypervisors/{id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/hypervisors/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

cpu_bookableinteger required

cpu_effective_total minus reserved, existing-guest, and Waggle-committed vCPU.

cpu_effective_totalinteger required

Schedulable vCPU pool: cpu_total x cpu_overcommit_ratio, rounded down.

cpu_overcommit_rationumber double required

vCPU sold per physical core on this node. 1.0 is no overcommit.

cpu_reservedinteger required
cpu_totalinteger required

Physical cores on the node.

cpu_usedinteger required

vCPU allocated to existing guests (from discovery).

created_atstring date-time required
datacenter_idstring required
disk_gb_bookableinteger required
disk_gb_reservedinteger required
disk_gb_totalinteger required
disk_gb_usedinteger required

Disk (GB) allocated to existing guests (from discovery).

idstring required
last_synced_atstring date-time
namestring required
ram_gb_bookableinteger required
ram_gb_reservedinteger required
ram_gb_totalinteger required
ram_gb_usedinteger required

RAM (GB) allocated to existing guests (from discovery).

schedulableboolean required

When false, placement excludes this hypervisor.

updated_atstring date-time required

Example response

{
  "$schema": "/api/v1/schemas/HypervisorView.json"
}

Changes

  • 17fb0e434059Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status