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

List VM snapshots, optionally by source VM

Returns the org's VM snapshots as one array, or only one source VM's with vmId. Soft-deleted snapshots are included and carry deletedAt.

Required permission

Requires the compute.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl snapshots list
GET
/v1/orgs/{orgId}/snapshots

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Query Parameters

vmId?string

Response Body

OK

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/snapshots'
Example Response
[  {    "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"  }]

Create a snapshot of a VM POST

Beta: the snapshot record is created and returned with status creating, but snapshot capture is not yet enabled on the data plane. A terminated VM answers 400, and a VM with a snapshot already being created answers 409.

Soft-delete a snapshot DELETE

Soft-deletes a snapshot: its status becomes deleting, deletedAt is set and the call answers 204. A snapshot that is already being deleted answers 409.