OpenRelay API Documentation

Beta: the snapshot record is created, but snapshot capture is not yet enabled on the data plane.

Authorization

apiKey

AuthorizationBearer <token>

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

In: header

id*string

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

curl -X POST "https://example.com/v1/vms/string/snapshots" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "id": "string",
  "name": "string",
  "status": "string"
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}

The orl CLI wraps this endpoint:

orl vms snapshot create <id> --name <name>