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

List an org's VMs (cursor-paginated)

Command line

The orl CLI wraps this endpoint:

orl vms list
GET
/v1/orgs/{orgId}/vms
AuthorizationBearer <token>

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

In: header

Path Parameters

orgId*string

Query Parameters

limit?integer
cursor?string
activeOnly?boolean

Return only non-terminated VMs.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orgs/string/vms"
{  "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",      "pricePerHourCents": 0,      "serviceType": "string",      "managedBy": "string",      "capabilityTier": "string",      "computeClass": "string",      "imageUrl": "string"    }  ],  "nextCursor": "string"}