Fetching List of Azure Cloud Key Backups

Use the get /v1/cckm/azure/keys/{id}/backups API to return the list of backups of an Azure cloud key. The results can be filtered using the query parameters.

Syntax

curl -k '<IP>/api/v1/cckm/azure/keys/{id}/backups?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed

Here, {id} represents the key ID.

Request Parameter

Parameter	Type	Description
AUTHTOKEN	string	Authorization token.

Request Query Parameters

Parameter	Type	Description
backup_id	string	Internal ID of the backup.
name	string	Name of the key.
backup	string	Name of the backup.
vault_name	string	Name of the Azure key vault.
subscription_id	string	ID of the subscription.
subscription_name	string	Name of the subscription.
region	string	Region name.
type	string	The type of backup. It can be manual and automatic.
gone	boolean	Fetches keys based on their existence in the cloud.
tenant	string	Tenant ID of the Azure application.
cloud_name	string	Name of the cloud.
skip	integer	Number of records to skip. For example, if `"skip":5` is specified, the first five records will not be displayed in the output.
limit	integer	Numbers of records to display. For example, if `"limit":10` is specified, then the next 10 records (after skipping the number of records specified in the `skip` parameter) will be displayed in the output.
sort	string	Comma-delimited list of properties to sort the results.

Example Request

curl -k 'https://127.0.0.1/api/v1/cckm/azure/keys/mvz6/backups?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhNzBlNTQ0Yi03M2MxLTQ3NzItOTg4YS04MDU3NDcyYTAwNjAiLCJzdWIiOiJsb2NhbHwwNGU5YjJjOS1jZDE4LTRmNDUtOTMyMy03Y2IzZGRhMDI3OTEiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODM3Yzg0MGQtNzVkZC00YjRmLWEzMTgtNzljYjE2Y2EyNDhkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjE5OTZkN2EwLWZhNzYtNDRjYi05ZGRiLTRkZjU0ZDk3NDVmZCIsImlhdCI6MTcxNjY3MjIzOSwiZXhwIjoxNzE2NjcyNTM5fQ.1Brsmng_hCawGK1wTDIsmPKuom_gL7u4-_Nj0sUhos-aSN2EF0wwJdK3EGDwmUO6MMZRCq7jzJqkYNCjSvIGPg' -H 'accept: application/json' --compressed

Example Response

{
    "skip": 0,
    "limit": 10,
    "total": 2,
    "resources": [
        {
            "id": "64e06b16-455b-4439-9d94-654c71d0c9f7",
            "uri": "kylo:kylo:cckm:azure-pit-key-backup:64e06b16-455b-4439-9d94-654c71d0c9f7",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2024-01-05T09:30:34.088626Z",
            "updatedAt": "2024-01-05T09:30:34.086127Z",
            "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": "bc55fe571c154caea8e7a61d92afb30f0cc556b7b4034fe2a870c2a9f700fb1d",
            "type": "manual",
            "gone": false
        },
        {
            "id": "b4239e9b-d16a-41c2-9ef0-024befbaaeaf",
            "uri": "kylo:kylo:cckm:azure-pit-key-backup:b4239e9b-d16a-41c2-9ef0-024befbaaeaf",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2024-01-05T09:41:38.29955Z",
            "updatedAt": "2024-01-05T09:41:38.298341Z",
            "name": "test",
            "description": "test desc",
            "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": "142d6c4c68be4cfca971f033ac4e2fa6cdfd17ef6df74c94b3807864003834d1",
            "type": "manual",
            "gone": false
        }
    ]
}

Response Codes

Response Code	Description
2xx	Success
4xx	Client errors
5xx	Server errors

Refer to HTTP status codes for details.

Suggest A Change