v2

latestOpenAPI 3.1.02026-08-07139158192.4 KB
VMs

Get a VM with its GPU/node/template info and price

get/v1/vms/{id}/detail

Path parameters

idstring required

Response

The VM detail

capabilityTierstring

compute-fabric capability tier (e.g. "pod"); empty for a plain VM

computeClassstring

compute-fabric compute class (interruptible|reserved); empty for a plain VM

containerPortinteger
createdAtstring required
diskSizeGbinteger required
diskTotalBytesinteger
diskUsedBytesinteger
endpointUrlstring
gpuCountinteger required
gpuModelIdstring
healthyboolean required
idstring required
imageUrlstring
internalIpstring
namestring required
nodeIdstring
nonBillableboolean

This VM's usage is recorded but never charged: a provider org consuming GPUs on a node it owns under its own reservation. pricePerHourCents still reports the real rate — the measurement is kept, the charge is waived — so a client showing a rate MUST also show this or it will display a bill that never arrives.

organizationIdstring required
osTypestring
persistentDiskPathstring
pricePerHourCentsinteger

bundled hourly rate. When the VM has an open usage session this is the rate LOCKED at session open (what settlement charges); otherwise the rate a session WOULD lock: the fabric admission snapshot for a pod, else the current catalog rate for the VM's shape.

provisioningStagestring
publicboolean

true = open endpoint (no data-plane auth); false = require an org API key

rdpPasswordstring
rdpPortinteger
resourceSizestring required
serviceTypestring

managed-service tag; empty for a plain VM

sshCommandstring

ready-to-paste ssh command (ssh <handle>@<host>)

sshHandlestring

RunPod-style SSH handle (first label of endpointUrl); used as the SSH username

sshHoststring

data-plane SSH gateway host, e.g. ssh.run.beta.openrelay.inc

sshPortinteger
sshReadyboolean

true once the VM is running and its data-plane route exists

sshUserstring

login user the gateway lands as inside the VM (e.g. ubuntu)

startedAtstring
statusstring required
statusReasonstring

human-readable cause for failed/stuck states

tierstring required
updatedAtstring required