Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Vaults/ Updating the Backup Expiration Time of a Vault
Updated on 2026-08-10 GMT+08:00

Updating the Backup Expiration Time of a Vault

Function

This API is used to update the backup expiration time of a vault.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

PUT /v3/{project_id}/vaults/{vault_id}/update-backup-expiration-time

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. Default value: N/A

For details about how to obtain the project ID, see Obtaining a Project ID.

vault_id

Yes

String

Vault ID. Default value: N/A

For details about how to obtain the vault ID, see Querying the Vault List.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

expect_expiration_date

No

String

Expected expiration time. The format is YYYY-MM-DD.

time_zone

Yes

String

Time zone where the user is located, for example, UTC+08:00.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

affected_backups_count

Integer

Number of backups whose expiration time is successfully changed.

new_expiration_day

String

New backup expiration time. The format is YYYY-MM-DD.

operation_log_id

String

Task ID.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "affected_backups_count" : 30,
  "new_expiration_day" : "2026-01-30",
  "operation_log_id" : "8985df6c-7ba6-46db-abdb-2c6613326b91"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.