Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeVMs

List an org's VMs (cursor-paginated)

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.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl vms list
GET
/v1/orgs/{orgId}/vms

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string

Query Parameters

limit?integer
cursor?string
activeOnly?boolean

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 Body

Page of VMs

application/json
  1. response
items*array<>
nextCursor?string
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/vms'
Example Response
{  "items": [    {      "id": "string",      "organizationId": "string",      "name": "string",      "status": "string",      "statusReason": "string",      "gpuModelId": "string",      "gpuCount": 0,      "endpointUrl": "string",      "volumeGb": 0,      "public": true,      "createdAt": "string",      "provisioningStage": "string",      "resourceSize": "string",      "tier": "string",      "diskSizeGb": 0,      "gpuModelName": "string",      "gpuManufacturer": "string",      "pricePerHourCents": 0,      "serviceType": "string",      "managedBy": "string",      "capabilityTier": "string",      "computeClass": "string",      "imageUrl": "string"    }  ],  "nextCursor": "string"}

Overview

GPU virtual machines: create, stop, restart or terminate a VM, manage its disks and SSH keys, and read its live burn rate and runway.

Get a VM by id GET

Returns one VM or pod of the caller's organization as a VmSummary: its status and reason, GPU model and count, endpoint URL, visibility and hourly price.