Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Vaults/ Migrating Resources
Updated on 2025-10-24 GMT+08:00
View PDF

Migrating Resources

Function

This API is used to associate resources with another vault and migrate the resource backups to that destination vault.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. Default value: N/A

vault_id

Yes

String

Vault ID. Default value: N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

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

Yes

String

ID of the destination vault. Default value: N/A

resource_ids

Yes

Array of strings

IDs of resources to be migrated. Use commas (,) to separate multiple resource IDs. The resource IDs are in UUID format. Default value: N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

migrated_resources

Array of strings

List of resources to be migrated. Range: N/A

Example Requests

Migrating resources as well as their backups to a different vault

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

{
  "resource_ids" : [ "abcdde3f-e0e3-403a-b690-fc259dd70008" ],
  "destination_vault_id" : "fe578a6c-d1a8-4790-bd52-5954af4d446c"
}

Example Responses

Status code: 200

OK

{
  "migrated_resources" : [ "fe578a6c-d1a8-4790-bd52-5954af4d446c" ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Vaults