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

orl vms fork

Fork a new VM from a snapshot, part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing. Usage, every flag and an example.

orl vms fork --snapshot-id <snapshot-id>

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.

Flags

FlagTypeRequired
--container-portintno
--disk-size-gbintno
--env-varsmap[string]stringno
--gpu-countintno
--gpu-model-idstringno
--image-urlstringno
--namestringno
--resource-sizestringno
--snapshot-idstringyes
--ssh-key-ids[]stringnoOrg SSH key ids for the fork. Omit to carry the source VM's keys over. Every resulting id must name a live key of this org, so forking a source whose keys are gone requires naming a replacement set here.
--bodystringnoa JSON object of request body fields, merged under any of this command's own flags that are also set, e.g. {"key":"value"}
--body-filestringnoread the --body JSON object from a file (- for stdin)

This wraps the forkVm API operation.

On this page