Version Info REST Service

Use the Version Info REST Service to obtain version information of installed IBM Security Guardium Key Lifecycle Manager and its components. You can also view the build level of IBM Security Guardium Key Lifecycle Manager.

Operation
GET
URL
https://host:port/SKLM/rest/v1/ckms/versionInfo

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.

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
Guardium Key Lifecycle Manager Version Returns the version number of IBM Security Guardium Key Lifecycle Manager.
Guardium Key Lifecycle Manager Build Level Returns the build level of installed IBM Security Guardium Key Lifecycle Manager.
Embedded WAS Version Returns the version number of WebSphere Application Server Liberty.
DB2 Version Returns the version number of DB2®.
Java Version Returns the version number of Java™.
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 obtain version information of IBM Security Guardium Key Lifecycle Manager and its components
GET https://localhost:port/SKLM/rest/v1/ckms/versionInfo
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
Success response
{
  "tklm_version": "4.1.0.0",
  "build_level": "202011210125",
  "was_version": "9.0.5.5",
  "db_version": "DB2/NT64 SQL110540",
  "java_version": "JRE 1.8.0_261 IBM J9 VM 2.9",
  "os_version": "Windows Server 2012 R2:6.3:amd64",
  "agent_version": "2.0"
}
Error response
Status Code : 400 Bad Request
Content-Language: en
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user 
authentication ID or invalid request format."}