This is the multi-page printable view of this section. Click here to print.
Update Retention Period
1 - 1.2
scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>
Description
Update the retention period.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| retention_period required | string | Backup retention period | WEEK_2 |
2 - 1.1
scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>
Description
Update the retention period.
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 |
| retention_period required | string | Backup retention period | WEEK_2 |
3 - 1.0
scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>
Description
Update the retention period.
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 |
| retention_period required | string | Backup retention period | WEEK_2 |