Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Restores (Push)

Push a file to the protected system

post/v1/restore/file/{file_restore_id}/push

Path parameters

file_restore_idstring required

ID of a file restore

Example:fr_0123456789ab

Request body

destination_folderstring required

The folder on the protected system where the pushed file is restored. For security reasons, restores are only permitted to a SlideRestore folder rooted at a known mount point on the agent: for Windows agents, the root of a drive (e.g. C:\SlideRestore); for Linux agents, an absolute path under a mounted volume that ends in /SlideRestore (e.g. /SlideRestore for the root mount, or /data/SlideRestore for a /data mount).

source_file_pathstring required

Path of the file as it appears inside the mounted file restore — not the file's path on the protected system. The leading path component is the source volume's identifier (the drive letter for Windows, e.g. C, or root for the root mount on Linux), followed by forward-slash-separated path components (e.g. C/Users/Administrator/Documents/ImportantFile.docx for a Windows C: drive, or root/home/admin/important.txt for a Linux root mount).

Example request

{
  "destination_folder": "C:\\SlideRestore",
  "source_file_path": "C/Users/Administrator/Documents/ImportantFile.docx"
}

Response

Created

destination_folderstring required

The folder on the protected system where the pushed file is restored. For security reasons, restores are only permitted to a SlideRestore folder rooted at a known mount point on the agent: for Windows agents, the root of a drive (e.g. C:\SlideRestore); for Linux agents, an absolute path under a mounted volume that ends in /SlideRestore (e.g. /SlideRestore for the root mount, or /data/SlideRestore for a /data mount).

end_timestring date-time

Timestamp of when the push operation ended

file_restore_idstring required

ID of a file restore

file_restore_push_idstring required

ID of a file restore push

sizeinteger

Size of the file in bytes

source_file_pathstring required

Path of the file as it appears inside the mounted file restore — not the file's path on the protected system. The leading path component is the source volume's identifier (the drive letter for Windows, e.g. C, or root for the root mount on Linux), followed by forward-slash-separated path components (e.g. C/Users/Administrator/Documents/ImportantFile.docx for a Windows C: drive, or root/home/admin/important.txt for a Linux root mount).

start_timestring date-time required

Timestamp of when the push operation started

state'created' | 'in_progress' | 'completed' | 'failed' | 'canceled' required

Current state of the push operation

Example response

{
  "destination_folder": "C:\\SlideRestore",
  "end_time": "2024-08-23T01:25:08Z",
  "file_restore_id": "fr_0123456789ab",
  "file_restore_push_id": "frp_0123456789ab",
  "size": 21536,
  "source_file_path": "C/Users/Administrator/Documents/ImportantFile.docx",
  "start_time": "2024-08-23T01:25:08Z",
  "state": "completed"
}