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

Soft-delete a snapshot

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.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl snapshots delete <id>
DELETE
/v1/snapshots/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

Response Body

Deleted

Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/snapshots/string'
Example Response
Empty

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.

Fork a new VM from a snapshot POST

Creates a VM from a snapshot, taking its GPU model and count, image, env vars, port and the source VM's SSH keys unless the request overrides them. The disk is never smaller than the snapshot's, and an unnamed fork is called fork-<snapshot name>. A valid request with no free capacity answers 503. The response carries the new VM's id, name and status.