Disaster Management APIs
These APIs are used to perform the following tasks:
Recovering Soft-Deleted Azure Keys
Use the post /v1/cckm/azure/keys/{id}/recover
API to recover a soft-deleted Azure key.
Syntax
Here, {id}
represents the key ID.
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Example Request
Example Response
The sample output shows that the parameter key_soft_deleted_in_azure
is set to false
. This indicates that the soft-deleted key (Test-key
) is recovered.
To know more about response parameters, refer to Response Parameters of Key Life Cycle Management APIs.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.
Restoring Backed up Keys
Use the post /v1/cckm/azure/keys/{id}/restore
API to restore a backed up key to the Azure key vault.
Note
Restoration of keys among cross-region vaults is not allowed.
Syntax
Here, {id}
represents the key ID.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
key_vault_id | string | Name or ID of the vault where the key will be restored. By default, the key will restored to the vault from where it was deleted. |
Example Request
Example Response
The sample output shows that the key (with ID 94a392f3-52e8-4542-90b6-b8554c046492
)is restored to Azure key vault (with vault id bedb82b9-582c-402d-9874-f3368722cf46
).
To know more about response parameters, refer to Response Parameters of Key Life Cycle Management APIs.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.