VMs

List an org's VMs (cursor-paginated)

Changed on

Returns the org's VMs as a cursor-paginated page of VmSummary items, without pods (listPods returns those); set activeOnly to leave out terminated VMs.

The nodes of the org's managed Kubernetes clusters are not listed either; listKubernetesNodes returns those.

Requires the compute.read permission. See Permissions for the roles and API key permissions that include it.

get/v1/orgs/{orgId}/vms

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/vms
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Query parameters

limitinteger
cursorstring
activeOnlyboolean

Return only non-terminated VMs. The rows returned depend on this parameter alone: the server reads either a sparse index of live VMs or the organization's full VM list filtered server side, and paging to the end returns the same rows either way, differing only in latency. A page may hold fewer than limit rows and still carry a nextCursor, so page until nextCursor is absent. Cursors are not interchangeable between activeOnly=true and activeOnly=false.

Response

Page of VMs

nextCursorstring

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status