Archiving the SAP External Key
Use the post /v1/cckm/sap/ekm/keys/{id}/archive API to archive the SAP external key.
Syntax
curl -k '<IP>/api/v1/cckm/sap/ekm/keys/{id}/archive' -X POST -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
| id | string | ID of the SAP external key. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/sap/ekm/keys/89h9/archive' -X POST -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjZDFlYWU2MC1hOGJlLTRhOTEtODRlMS1iN2Q0ZWI0MmE0Y2UiLCJzdWIiOiJsb2NhbHw1YzRmMjg2ZC0wZmMxLTQyZWQtYjA0My1hZjYwNGNkMTQzMGIiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODM3Yzg0MGQtNzVkZC00YjRmLWEzMTgtNzljYjE2Y2EyNDhkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjE3NmU3MGNiLWFiODAtNDNkNi04ZjAxLTEyN2Y4ZjJkMDVhNyIsImlhdCI6MTcyNDkzNDA0MCwiZXhwIjoxNzI0OTM0MzQwfQ.P-luPfNyNVSsJJSDrvxa-8_J8Of3-IkqZQ4WkK9lYwakI9sY5aThbMglGj12RY4tIE-1H54CpbB4Q6_8pN6ucw' -H 'accept: application/json' --compressed
Example Response
{
"id": "abbccb49-33aa-4f2e-b2bb-92ba821adb60",
"uri": "kylo:kylo:cckm:sap-key:sapekmkey-abbccb49-33aa-4f2e-b2bb-92ba821adb60",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2024-03-15T10:07:13.676645Z",
"updatedAt": "2024-03-15T10:07:13.671552Z",
"name": "SAPEKMKey",
"description": "This is sap external key",
"keystore_id": "edafcd7d-a40a-4da6-86a7-e76fdf768632",
"size": 256,
"state": "ARCHIVED",
"algorithm": "AES",
"sap_tenant_id": "edafcd56d-a40a-4da6-84a7-e76fdf768456",
"source_key_tier": "local",
"blocked": false,
"auto_rotate": false,
"version_count": 1,
"version_id": "0397e4ed-d653-4329-811a-af84ab81f6c0"
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
