Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Restores (Image)

Create image export

post/v1/restore/image

Request body

boot_modsstring[]

Optional boot mods to enable on the restore

device_idstring required

ID of a device

image_type'vhdx' | 'vhdx-dynamic' | 'vhd' | 'vmdk' | 'vmdk-flat' | 'qcow2' | 'raw' required

Image type of the image export

iscsiboolean

Whether the image export should be shared over iSCSI

nfsboolean

Whether the image export should be shared over NFS

nfs_clientsstring[]
passphrasestring

User passphrase. If the agent has a user passphrase, you must provide it here.

snapshot_idstring required

ID of a snapshot

Example request

{
  "device_id": "d_0123456789ab",
  "image_type": "vhdx",
  "nfs_clients": [
    "192.168.1.0/24"
  ],
  "passphrase": "Super Secret Passphrase",
  "snapshot_id": "s_0123456789ab"
}

Response

Created

agent_idstring required

ID of an agent

created_atstring date-time required

Creation timestamp

device_idstring required

ID of a device

image_export_idstring required

ID of an image export

image_type'vhdx' | 'vhdx-dynamic' | 'vhd' | 'vmdk' | 'vmdk-flat' | 'qcow2' | 'raw' required

Image type of the image export

iscsiboolean

Whether the image export should be shared over iSCSI

nfsboolean

Whether the image export should be shared over NFS

nfs_clientsstring[]
passwordstring password

Samba password

snapshot_idstring required

ID of a snapshot

Example response

{
  "agent_id": "a_0123456789ab",
  "created_at": "2024-08-23T01:25:08Z",
  "device_id": "d_0123456789ab",
  "image_export_id": "ie_0123456789ab",
  "image_type": "vhdx",
  "nfs_clients": [
    "192.168.1.0/24"
  ],
  "snapshot_id": "s_0123456789ab"
}