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

List an org's VM snapshots (optionally filtered by source VM)

Command line

The orl CLI wraps this endpoint:

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

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

In: header

Path Parameters

orgId*string

Query Parameters

vmId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orgs/string/snapshots"
[  {    "id": "string",    "organizationId": "string",    "sourceVmId": "string",    "nodeId": "string",    "name": "string",    "diskPath": "string",    "diskSizeGb": 0,    "sizeBytes": 0,    "chainDepth": 0,    "templateId": "string",    "gpuModelId": "string",    "gpuCount": 0,    "resourceSize": "string",    "imageUrl": "string",    "envVars": {      "property1": "string",      "property2": "string"    },    "containerPort": 0,    "status": "string",    "errorMessage": "string",    "createdAt": "string",    "deletedAt": "string"  }]