v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Restores (File)

Create file restore

post/v1/restore/file

Request body

device_idstring required

ID of a device

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",
  "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

expires_atstring date-time

Expiration timestamp

file_restore_idstring required

ID of a file restore

purpose'test' | 'disaster' required

Purpose for creating the virtual machine or file restore. If this is set to disaster, Slide Support will recieve a notification that you are in a disaster. File restores not created by the slide box for file system verification will have this field set to disaster.

snapshot_idstring required

ID of a snapshot

Example response

{
  "agent_id": "a_0123456789ab",
  "created_at": "2024-08-23T01:25:08Z",
  "device_id": "d_0123456789ab",
  "expires_at": "2024-08-23T01:25:08Z",
  "file_restore_id": "fr_0123456789ab",
  "purpose": "disaster",
  "snapshot_id": "s_0123456789ab"
}