Deleting a SAP Key Backup from CCKM
Use the post /v1/cckm/sap/keys/{id}/delete-backup API to delete the backup of a key from the CCKM but keep its metadata.
A key needs to be deleted from SAP before its backup can be deleted from the CCKM. Refer to Deleting a Key from SAP for details.
Syntax
curl -k '<IP>/api/v1/cckm/sap/keys/{id}/delete-backup' -X POST -H 'Authorization: Bearer AUTHTOKEN' --compressed
Here, {id} is the resource ID of the SAP key on the CipherTrust Manager. Note that the resource id is different from sap_key_id on SAP. Run the get /v1/cckm/sap/keys API to view the resource ID (id) of the SAP key on the CipherTrust Manager.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/sap/keys/fcdad52b-0464-4b07-9162-94a6f3fb9103/delete-backup' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZjRlNmJkNi0wMzgzLTQ4MGMtYWZmZS0wYTQxNDgzZmVlNmUiLCJzdWIiOiJsb2NhbHxlNjM3NTVjOS01YzRhLTQ0NzUtOWI0Zi0wN2JjNzQxYjQ1MGEiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODJlZTQ2MzAtNjQwMi00MTQ3LTliNDYtNWE5YzU1OGVjZWU4Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImI4MThiN2MzLTk5NzItNDU0YS1iMjI0LWQ2NGQwOWVlOGRmNSIsImlhdCI6MTYzNDU0MzE0OSwiZXhwIjoxNjM0NTQzNDQ5fQ.KEXK5uaMecdIQT8QWsIqVn6szCz5VBPetDh8i2ePiLU' --compressed
Example Response
{
"id": "fcdad52b-0464-4b07-9162-94a6f3fb9103",
"uri": "kylo:kylo:cckm:sap-key:fcdad52b-0464-4b07-9162-94a6f3fb9103",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2021-11-24T09:09:10.129255Z",
"updatedAt": "2021-11-24T09:20:22.083968236Z",
"cloud_name": "sap",
"tenant": "thales-preprod",
"sap_param": {
"enabled": true,
"exportable": true,
"groupId": "489ac34d-3e9c-4be3-8c1c-2c383bf31461",
"sap_key_id": "0df1f137-5c6b-46d7-abdf-b8354b236b62",
"keystoreContext": {
"customerHeld": false
},
"meta": {
"created": "2021-11-24T09:09:08Z",
"creatorId": "69f41156-5197-490d-aa5f-f1ffb0ab4e66",
"creatorName": "creator.name@xyz.com",
"imported": true,
"primaryVersion": 0,
"totalVersions": 1
},
"name": "ab-cm-sap-key1",
"operations": [
"ENCRYPT"
],
"role": "UNSPECIFIED",
"size": 256,
"type": "AES"
},
"cckm_group_name": "Gooey_1",
"cckm_group_id": "94596874-b882-46a0-84eb-20e88abaec4b",
"gone": true,
"origin": "unknown",
"auto_rotate": false,
"sap_application": "S4H",
"sap_group_name": "Gooey_1",
"refreshed_at": "2021-11-24T09:10:48.505378Z",
"backup_key_time": "2021-11-24T09:11:02Z",
"backup_key_status": "SUCCESS",
"status": "DELETED"
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
