Use the Delete Key REST Service to delete a key entry from the
keystore.
- Operation
DELETE
- URL
- https://host:port/SKLM/rest/v1/keys/
By default, Guardium Key Lifecycle Manager server
listens to the secure port 9443 (HTTPS) for communication.
During IBM Security Guardium Key Lifecycle Manager installation, you can modify this
default port.
Request Parameters
Parameter |
Description |
host |
Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server. |
port |
Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests. |
Request Headers
Header name |
Value |
Content-Type |
application/json |
Accept |
application/json |
Authorization |
SKLMAuth userAuthId=<authIdValue> |
Accept-Language |
Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or
de. |
Request body
JSON property name |
Description |
At least specify one of the following properties. If both are
specified, the key is deleted on the basis of the keyId value. |
alias |
Specify the unique alias name of the key to be deleted. |
keyId |
Specify the unique ID of the key to be deleted. |
Response Headers
Header name |
Value and description |
Status Code |
- 200 OK
- The request was successful. The response body contains the requested representation.
- 400 Bad Request
- The authentication information was not provided in the correct format.
- 401 Unauthorized
- The authentication credentials were missing or incorrect.
- 404 Not Found Error
- The processing of the request fails.
- 500 Internal Server Error
- The processing of the request fails because of an unexpected condition on the server.
|
Content-Type |
application/json |
Content-Language |
Locale for the response message. |
Success response
body
JSON object with
the following specification:
JSON property name |
Description |
status |
Returns the status to indicate the key deletion. |
Error Response Body
JSON object with the following specification.
JSON property name |
Description |
code |
Returns the application error code. |
message |
Returns a message that describes the error. |
Examples
- Service request to delete a key entry from the keystore by its alias name
DELETE https://localhost:port/SKLM/rest/v1/keys?alias=abc0050f04d6000000001
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
- Success response
Status Code: 200 OK
{"code":"0","status":"Succeeded"}
- Service request to delete a key entry from the keystore by its uid (keyId)
-
DELETE https://localhost:port/SKLM/rest/v1/keys?keyId=KEY-50f04d6-82eaab65-dcb8-4e9e-91f5-5d4ae8cd0207
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
- Invalid service request example (alias is incorrect)
-
DELETE https://localhost:port/SKLM/rest/v1/keys?alias=abc
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
- Error response
-
"code": "CTGKM0565E",
"message": "CTGKM0565E The key cannot be found: abc. Specify a valid key, and retry the operation."