This is the multi-page printable view of this section. Click here to print.
List Backup Histories
1 - 1.2
scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
List Backup histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time optional | string | Start time | 2024-09-30T15:00:00Z |
| backup_end_time optional | string | End time | 2024-10-31T14:59:59Z |
| backup_job_state optional | **** | Backup history state | SUCCESS |
| page optional | integer | Page | 0 |
| size optional | integer | Size | 20 |
| sort optional | string | Sort | backup_start_time:desc |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_time | End time | 2024-10-31T14:59:59Z |
| backup_job_guid | Backup job GUID | 3b1da7ba-3f38-45cb-9538-e921826f80d7 |
| backup_job_state | Backup history state | SUCCESS |
| backup_start_time | Start time | 2024-09-30T15:00:00Z |
| schedule_id | Schedule ID | f5b8e22b-0d88-4698-9996-fb44217c8227 |
| schedule_name | Schedule name | INCREMENTAL_DAILY_15:00:00-chg4By |
2 - 1.1
scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
List Backup 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 |
| backup_start_time optional | string | Start time | 2024-09-30T15:00:00Z |
| backup_end_time optional | string | End time | 2024-10-31T14:59:59Z |
| backup_job_state optional | **** | Backup history state | SUCCESS |
| page optional | integer | Page | 0 |
| size optional | integer | Size | 20 |
| sort optional | string | Sort | backup_start_time:desc |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_time | End time | 2024-10-31T14:59:59Z |
| backup_job_guid | Backup job GUID | 3b1da7ba-3f38-45cb-9538-e921826f80d7 |
| backup_job_state | Backup history state | SUCCESS |
| backup_start_time | Start time | 2024-09-30T15:00:00Z |
| schedule_id | Schedule ID | f5b8e22b-0d88-4698-9996-fb44217c8227 |
| schedule_name | Schedule name | INCREMENTAL_DAILY_15:00:00-chg4By |
3 - 1.0
scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
List Backup 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 |
| backup_start_time optional | string | Start time | 2024-09-30T15:00:00Z |
| backup_end_time optional | string | End time | 2024-10-31T14:59:59Z |
| backup_job_state optional | **** | Backup history state | SUCCESS |
| page optional | integer | Page | 0 |
| size optional | integer | Size | 20 |
| sort optional | string | Sort | backup_start_time:desc |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_time | End time | 2024-10-31T14:59:59Z |
| backup_job_guid | Backup job GUID | 3b1da7ba-3f38-45cb-9538-e921826f80d7 |
| backup_job_state | Backup history state | SUCCESS |
| backup_start_time | Start time | 2024-09-30T15:00:00Z |
| schedule_id | Schedule ID | f5b8e22b-0d88-4698-9996-fb44217c8227 |
| schedule_name | Schedule name | INCREMENTAL_DAILY_15:00:00-chg4By |