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

orl vms list

List an org's VMs (cursor-paginated), part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing. Usage, every flag and an example.

orl vms list

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.

Flags

FlagTypeRequired
--limitintno
--cursorstringno
--active-onlyboolnoReturn 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.
--allboolnofollow every page (nextCursor) and merge their items into one list

This wraps the listOrgVms API operation.

On this page