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

Get a VM by id

GET
/v1/vms/{id}
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/vms/string"
{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "status": "string",
  "statusReason": "string",
  "gpuModelId": "string",
  "gpuCount": 0,
  "endpointUrl": "string",
  "public": true,
  "createdAt": "string",
  "provisioningStage": "string",
  "resourceSize": "string",
  "tier": "string",
  "diskSizeGb": 0,
  "gpuModelName": "string",
  "pricePerHourCents": 0,
  "serviceType": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl vms get <id>