Dissociating Resources
Function
This API is used to remove a resource from a vault. If a resource is removed, the backup of the resource in the vault will also be deleted.
URI
POST /v3/{project_id}/vaults/{vault_id}/removeresources
|
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
|
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
resource_ids |
Yes |
Array of strings |
IDs of resources to be removed. Use commas (,) to separate multiple resource IDs. The resource IDs are in UUID format. Default value: N/A Minimum length: 1 Maximum length: 256 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
remove_resource_ids |
Array of strings |
IDs of resources to be removed. Use commas (,) to separate multiple resource IDs. The resource IDs are in UUID format. |
Example Requests
Dissociating resources from a vault and deleting the backups of the resources
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/removeresources
{
"resource_ids" : [ "97595625-198e-4e4d-879b-9d53f68ba551" ]
}
Example Responses
Status code: 200
OK
{
"remove_resource_ids" : [ "97595625-198e-4e4d-879b-9d53f68ba551" ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
