Deleting a Key from External CipherTrust Manager
Use the post /v1/cckm/external-cm/keys/{id}/delete API to delete a key from external CipherTrust Manager using the CCKM API. The API also returns the details of the deleted external CipherTrust Manager key.
Syntax
curl -k '<IP>/api/v1/cckm/external-cm/keys/{id}/delete' -X POST -H 'Authorization: Bearer AUTHTOKEN' --compressed
Here, {id} represents the ID of the key.
Request Parameter
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/external-cm/keys/d3296d8a-22bf-4b9c-8ff7-a41104b4631e/delete' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MmFmZDExNy02YzllLTRhNGUtOTAwYS1lYjlhNDNjYWE5ZDIiLCJzdWIiOiJsb2NhbHwzMTI5ODdkMS0wOWNiLTQxZTEtOThmNy1jZjRhNzgwNTZiMTMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDVmOWE3NWUtMzI1NC00NWJkLWE0NzYtOWU2NWUyNjdmNGVkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImU5ZDA4Mzc3LWUxNGEtNGY1Mi04MGJlLWU2ODQyNzcyNmViZSIsImlhdCI6MTYxNDc0OTg4OSwiZXhwIjoxNjE0NzUwMTg5fQ.P4njjTNAGdkIw4ZNz7ijS9Dwrow2DE-vG8bn0dKIr04' --compressed
Example Response
{
"application/json": {
"id": "c653cd63-00c9-443f-9032-9c4b8f44149e",
"uri": "kylo:kylo:cckm:external-cm-key:c653cd63-00c9-443f-9032-9c4b8f44149e",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2023-01-21T12:40:54.928828Z",
"updatedAt": "2023-01-23T10:30:30.541709Z",
"domain_id": "dfced667-0977-4d58-813e-ae26ec49336c",
"gone": false,
"refreshed_at": "2023-01-23T09:01:55.581565Z",
"cm_key_params": {
"key_name": "k7",
"key_usage_mask": 12,
"object_type": "Symmetric Key",
"version": 0,
"algorithm": "AES",
"key_size": 256,
"unexportable": false,
"undeletable": false,
"never_exported": true,
"never_exportable": false,
"key_id": "702766911f2c487ba76f809b838c9dc8eb2b5f235f0a457abf62957758d89eee",
"key_state": "DELETED"
}
}
The output shows the details of the deleted external CipherTrust Manager key with ID d3296d8a-22bf-4b9c-8ff7-a41104b4631e.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
