Snapshots

Fork a new VM from a snapshot

Changed on

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.

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

post/v1/orgs/{orgId}/vms/fork

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/vms/fork
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Request body

containerPortinteger
diskSizeGbinteger
envVarsobject
gpuCountinteger
gpuModelIdstring
imageUrlstring
namestring
resourceSizestring
snapshotIdstring required
sshKeyIdsstring[]

Org 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.

Response

Created

idstring required
namestring required
statusstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 89b1cd0245c6Revision changes
    • warning

      the request property's maxLength was set to 256