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

Create a snapshot of a VM

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.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl vms snapshot create <id> --name <name>
POST
/v1/vms/{id}/snapshots

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

Request Body

application/json
  1. body
name*string

Response Body

Created

application/json
  1. response
id*string
name*string
status*string
Example Request
curl -X POST 'https://api.openrelay.inc/v1/vms/string/snapshots' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "id": "string",  "name": "string",  "status": "string"}

Overview

Point-in-time VM snapshots and forking new VMs from them: snapshot a VM, list snapshots (optionally by source VM), soft-delete one, or fork a new VM from it.

List VM snapshots, optionally by source VM GET

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.