This is the multi-page printable view of this section. Click here to print.
Restore Agent Backup
1 - 1.2
scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]
Description
Restore the Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| restore_target_id required | string | Restore target ID | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| restore_server_uuid required | string | Restored server ID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| filesystem_paths required | array | List of filesystem backup path | '{"destination": "/", "source": "/"}' |
| overwrite optional | boolean | Overwrite | True |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| resource | Resource |
2 - 1.1
scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]
Description
Restore the Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| restore_target_id required | string | Restore target ID | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| restore_server_uuid required | string | Restored server ID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| filesystem_paths required | array | List of filesystem backup path | '{"destination": "/", "source": "/"}' |
| overwrite optional | boolean | Overwrite | True |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| resource | Resource |
3 - 1.0
scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]
Description
Restore the Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| restore_target_id required | string | Restore target ID | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| restore_server_uuid required | string | Restored server ID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| filesystem_paths required | array | List of filesystem backup path | '{"destination": "/", "source": "/"}' |
| overwrite optional | boolean | Overwrite | True |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| resource | Resource |