Fetching List of Azure Keys
Use the get /v1/cckm/azure/keys
API to fetch the list of Azure keys. The results can be filtered using the query parameters.
Syntax
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Request Query Parameters
Parameter | Type | Description |
---|---|---|
id | string | Internal ID of the Azure key. |
key_vault | string | Name of the Azure key vault. |
key_vault_id | string | ID of the key vault. |
key_name | string | Name of the key. |
cloud_name | string | Name of the cloud. |
region | string | Region name. |
crv | string | EC curve ID. |
status | string | Status of the key. |
backup | string | Backed up keys. |
enabled | boolean | Enabled keys. |
key_size | string | Size of the key. |
job_config_id | string | ID of the scheduler configuration job. |
deleted_in_azure | boolean | Fetches keys based on their availability in Azure. |
algorithm | string | Algorithm type. |
kid | string | Azure key ID. |
gone | boolean | Fetches keys based on their existence in the cloud. |
version | string | Fetches keys based on version. |
rotation_job_enabled | boolean | Fetches key based on the rotation job status. |
key_material_origin | string | Source of the key material. The origin of the key can be: • cckm: Key material is created on CCKM. • native: Key material is created on the Azure cloud. • unknown: Source of the key material is unknown. It is different than CCKM and the native 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
Example Response
The sample output shows the list of Azure keys.
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.