Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Vaults/ Applying a Policy to a Vault
Updated on 2025-10-17 GMT+08:00
View PDF
Share

Applying a Policy to a Vault

Function

This API is used to apply a policy to a vault.

Debugging

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

URI

POST /v3/{project_id}/vaults/{vault_id}/associatepolicy

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 Obtaining a Vault ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Default value: N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

destination_vault_id

No

String

Destination vault ID. This parameter is mandatory only when a replication policy is set. Default value: N/A

For details, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region.

policy_id

No

String

Policy ID. Default value: N/A

Specify either policy_id or add_policy_ids.

For details about how to obtain the backup policy ID, see Obtaining a Backup Policy ID.

add_policy_ids

No

Array of strings

IDs of new policies associated in the multi-policy scenario. Specify either policy_id or add_policy_ids. Default value: N/A

For details about how to obtain the backup policy ID, see Obtaining a Backup Policy ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

associate_policy

VaultPolicyResp object

Details of applying a policy to a vault
Table 5 VaultPolicyResp

Parameter

Type

Description

destination_vault_id

String

Vault ID of the destination region. This parameter is available only when a replication policy is configured.

For details, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region.

policy_id

String

Policy ID. Range: N/A

vault_id

String

Vault ID of the policy. Range: N/A

Example Requests

Applying a policy to a vault

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/associatepolicy

{
  "policy_id" : "7075c397-25a0-43e2-a83a-bb16eaca3ee5"
}

Example Responses

Status code: 200

OK

{
  "associate_policy" : {
    "vault_id" : "2402058d-8373-4b0a-b848-d3c0dfdc71a8",
    "policy_id" : "7075c397-25a0-43e2-a83a-bb16eaca3ee5"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Vaults