Viewing External CipherTrust Manager Key Versions
Use the get /v1/cckm/external-cm/keys/{id}/versions API to view the list of external CipherTrust Manager key versions.
Syntax
curl -k '<IP>/api/v1/cckm/external-cm/keys/{id}/versions?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
Request Query Parameters
| Parameter | Type | Description |
|---|---|---|
| version_id | string | ID of the version resource on the CipherTrust Manager. |
| key_state | string | State of the external CipherTrust Manager key version. |
| version | integer | ID of the external CipherTrust Manager key version. This is different than version_id. |
| unexportable | boolean | Whether the key is exportable or not. |
| undeletable | boolean | Whether the key is deletable or not. |
| gone | boolean | Whether the key version exists in 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/external-cm/keys/03fe3378-efe4-41cc-9177-12e778258f84/versions?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjNGU3MDM0MC1lNWE4LTQ5NjYtYTczYS0xYzY4NGMzMzA2YTMiLCJzdWIiOiJsb2NhbHwxNDc1MmJiOS02MTQ5LTRmZDctODM1Mi04NmVhOTE2ZTYxMTQiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsby85NzU5MmRkYi0xNDQ0LTRhZGEtYmFhZC0xMDUwNTc2NTI5ODUiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJhZG1pbiIsImN1c3QiOnsiY2xpZW50X3R5cGUiOiJ1bnJlZ2lzdGVyZWQiLCJkb21haW5faWQiOiI5NzU5MmRkYi0xNDQ0LTRhZGEtYmFhZC0xMDUwNTc2NTI5ODUiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYzgwN2ZjNTItMTI4OC00YzY5LTlkN2UtMDQ1MjM3ZDFjZWY2Iiwiem9uZV9pZCI6IjQ5N2RlYzI2LTA0M2YtNDhmZi05ZmZhLTAyNTFkODk0NWEwOCJ9LCJqd3RpZCI6IjBmZGM0Yjk3LTMxMGYtNDdmOC04Yzk2LWZiNmRmZjllZmM5MiIsImlhdCI6MTY4MzAyMTk2MCwiZXhwIjoxNjgzMDIyMjYwfQ.CCGmSWIEiRdoQwx1VQb00VNOy163SJ9QSRs4TxUrTa0' -H 'accept: application/json' --compressed
Example Response
{
"skip": 0,
"limit": 2,
"total": 4,
"resources": [
{
"id": "6f9b87d8-f383-4d52-beff-3a73787a6383",
"uri": "kylo:kylo:cckm:external-cm-key:6f9b87d8-f383-4d52-beff-3a73787a6383",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2023-03-30T05:31:35.557088Z",
"updatedAt": "2023-03-30T05:31:35.555667Z",
"domain_id": "60b48c3e-b365-4984-9150-19cd083c1cde",
"gone": false,
"cm_key_params": {
"key_name": "key1",
"key_usage_mask": 12,
"object_type": "Symmetric Key",
"version": 0,
"algorithm": "AES",
"key_size": 256,
"unexportable": true,
"undeletable": false,
"never_exported": true,
"never_exportable": true,
"format": "raw",
"key_id": "d532ee8ddb23406db74627f7ecfdf11f3fc255777ea34f1a9d9683e89c933017",
"key_state": "Active"
}
},
{
"id": "7098f1fe-d6eb-469c-8c65-5d136e0e1061",
"uri": "kylo:kylo:cckm:external-cm-key:7098f1fe-d6eb-469c-8c65-5d136e0e1061",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2023-03-30T05:31:35.554238Z",
"updatedAt": "2023-03-30T05:31:35.552917Z",
"domain_id": "60b48c3e-b365-4984-9150-19cd083c1cde",
"gone": false,
"cm_key_params": {
"key_name": "key1",
"key_usage_mask": 12,
"object_type": "Symmetric Key",
"version": 1,
"algorithm": "AES",
"key_size": 256,
"unexportable": true,
"undeletable": false,
"never_exported": true,
"never_exportable": true,
"format": "raw",
"key_id": "4bee9bc4cfd9403e951bfcfd2e974c298c662cd52f4e4d6dab3167ea3d804459",
"key_state": "Active"
}
}
]
}
The output shows the list of external CipherTrust Manager key versions available on the CipherTrust Manager.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
