Delete Certificate REST Service

Use the Delete Certificate REST Service to delete a certificate from the IBM® Security Guardium® Key Lifecycle Manager server. The certificate can be in any state, such as active.

You cannot delete a certificate that is:

Associated with a certificate that is marked as default or partner
Scheduled for a future rollover
Active SSLSERVER certificate

Operation: DELETE
URL: https://host:port/SKLM/rest/v1/certificates/{alias}

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

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`.

Path parameter

Parameter	Description
alias	Specify the alias of the certificate to be deleted.

Response

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 certificate 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 certificate

DELETE https://localhost:port/SKLM/rest/v1/certificates/sklmCertificate
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en

Success response

Status Code : 200 OK
Content-Language: en
{"code":"0","status":"Succeeded"}

Incorrect service request example (where the alias is incorrect)

DELETE https://localhost:port/SKLM/rest/v1/certificates/alias1
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en

Error response

Status Code : 500 Bad Request
Content-Language: en
{
  "code": "CTGKM0567E",
  "message": "CTGKM0567E The certificate cannot be found: alias1. Specify a valid certificate value, and retry the operation."
}