Use the Add Certificate to Liberty Keystore REST Service to export a
TLS or KMIP certificate to the Liberty keystore.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/certificates/addCertToLibertyKeystore
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 Object with the following specification:
JSON property name |
Description |
alias |
Specify the alias of the certificate for export. |
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 addition. |
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. |
Example
- Request to add a certificate file to the Liberty keystore
-
PUT https://localhost:port/SKLM/rest/v1/certificates/addCertToLibertyKeystore
{"alias": "server1"}
- Success response
-
{
"code": "0",
"status": "Succeeded",
"message": "CTGKM6231I Certificate is added to the Liberty keystore. Restart the server for the change to take effect."
}
- Incorrect request example
-
PUT https://localhost:port/SKLM/rest/v1/certificates/addCertToLibertyKeystore
{"alias": "cert1"}
- Error response
-
{
"code": "CTGKM6230E",
"message": "CTGKM6230E Failed to add the certificate because its alias could not be found in the database. Ensure that the certificate alias exists in the database, and retry the operation."
}