This is the multi-page printable view of this section. Click here to print.
List Backup Restore Histories
1 - 1.2
scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]
Description
List Backup restore histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| page optional | integer | Page | 0 |
| size optional | integer | Size | 20 |
| sort optional | string | Sort | backup_start_time:desc |
| restore_state optional | **** | Restore state | COMPLETED |
| start_time optional | string | Start time | 2024-09-30T15:00:00Z |
| end_time optional | string | End time | 2024-10-31T14:59:59Z |
Responses
| Name | Description | Example |
|---|---|---|
| backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time | Backup time | 2024-10-28T05:38:48 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| restore_end_time | Restore completion time | 2024-10-28T05:52:47 |
| restore_server_id | Restored server ID | 26895cb7-2059-49e7-b6fe-9c9c4b0d3db0 |
| restore_server_name | Restore server name | restoretest1 |
| restore_start_time | Restore start time | 2024-10-28T05:52:47 |
| restore_state | Restore state | COMPLETED |
| schedule_name | Schedule name | INCREMENTAL_DAILY_15:00:00-chg4By |
2 - 1.1
scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]
Description
List Backup restore histories.
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 |
| page optional | integer | Page | 0 |
| size optional | integer | Size | 20 |
| sort optional | string | Sort | backup_start_time:desc |
| restore_state optional | **** | Restore state | COMPLETED |
| start_time optional | string | Start time | 2024-09-30T15:00:00Z |
| end_time optional | string | End time | 2024-10-31T14:59:59Z |
Responses
| Name | Description | Example |
|---|---|---|
| backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time | Backup time | 2024-10-28T05:38:48 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| restore_end_time | Restore completion time | 2024-10-28T05:52:47 |
| restore_server_id | Restored server ID | 26895cb7-2059-49e7-b6fe-9c9c4b0d3db0 |
| restore_server_name | Restore server name | restoretest1 |
| restore_start_time | Restore start time | 2024-10-28T05:52:47 |
| restore_state | Restore state | COMPLETED |
| schedule_name | Schedule name | INCREMENTAL_DAILY_15:00:00-chg4By |
3 - 1.0
scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]
Description
List Backup restore histories.
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 |
| page optional | integer | Page | 0 |
| size optional | integer | Size | 20 |
| sort optional | string | Sort | backup_start_time:desc |
| restore_state optional | **** | Restore state | COMPLETED |
| start_time optional | string | Start time | 2024-09-30T15:00:00Z |
| end_time optional | string | End time | 2024-10-31T14:59:59Z |
Responses
| Name | Description | Example |
|---|---|---|
| backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time | Backup time | 2024-10-28T05:38:48 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| restore_end_time | Restore completion time | 2024-10-28T05:52:47 |
| restore_server_id | Restored server ID | 26895cb7-2059-49e7-b6fe-9c9c4b0d3db0 |
| restore_server_name | Restore server name | restoretest1 |
| restore_start_time | Restore start time | 2024-10-28T05:52:47 |
| restore_state | Restore state | COMPLETED |
| schedule_name | Schedule name | INCREMENTAL_DAILY_15:00:00-chg4By |