Creating Azure Cloud Key Backups
Use the post /v1/cckm/azure/keys/{id}/backups API to create a backup of an Azure cloud key.
Note
To use this API, CCKM Users should have keycreate or keyupload ACL.
Syntax
curl -k '<IP>/api/v1/cckm/azure/keys/{id}/backups' -X POST -H 'Authorization: Bearer AUTHTOKEN' --compressed
Here, {id} represents the key ID.
Request Parameter
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
| description (optional) | string | Description of the key backup. |
| name (optional) | string | Name for the key backup. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/azure/keys/mvz6/backups' -X POST -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmMDIzNjMxNC05ZGFkLTRlYmMtODZlYS03ZjU0OGU0N2ZhN2EiLCJzdWIiOiJsb2NhbHxlZmYwMjIwNy03NDFhLTRjZDAtYTFmYy1jYTkzMTMzYmNlMzkiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODM3Yzg0MGQtNzVkZC00YjRmLWEzMTgtNzljYjE2Y2EyNDhkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjBmMjUzZmU0LWVmMGQtNGZhZS05OWI5LWYxYTk2MmNkMDE3YiIsImlhdCI6MTcxNjU0NzQ1NiwiZXhwIjoxNzE2NTQ3NzU2fQ.tm6BBAMqsH4rmlIhIjOaES0AVFW809KfL-sxaAiUHqbd0zK2oR5KZ8I004MmYsAtM5aYyW8l96-aABUT0-q_lw' -H 'accept: application/json' --compressed
Example Response
{
"id": "fa89931d-18dd-4139-abfe-1832dc51850d",
"uri": "kylo:kylo:cckm:azure-pit-key-backup:fa89931d-18dd-4139-abfe-1832dc51850d",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2024-01-05T09:33:11.200004Z",
"updatedAt": "2024-01-05T09:33:11.19909Z",
"name": "test",
"description": "test description",
"tenant": "qa883erg-48e6-xyza-a4a9-24cfxxxa123xx",
"subscription_id": "xxxxx3b3-f1ce-xxxx-b5bc-02xxxx0cxx12a",
"subscription_name": "test subscription",
"vault_name": "test-keyvault-name",
"key_vault": "test-keyvault-name::xxxxx3b3-f1ce-xxxx-b5bc-02xxxx0cxx12a",
"key_name": "key-name",
"region": "eastus",
"cloud_name": "AzureCloud",
"backup": "6102b540395c4dc091b6c6a40a930d0eac98e69172cc4720941eb4785a8a264b",
"type": "manual",
"gone": false
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
