Use Version Info REST Service to obtain version information of
installed IBM Security Key Lifecycle Manager and its components. You can
also view the build level of IBM Security Key Lifecycle Manager.
- Operation
GET
- URL
- https://<host>:<port>/SKLM/rest/v1/ckms/versionInfo
By default, IBM Security Key Lifecycle Manager server listens
to non-secure port 80 (HTTP) and secure port 443 (HTTPS) for communication.
During IBM Security Key Lifecycle Manager installation,
you can modify these default ports. If you are using the default port
for HTTP or HTTPS, the port is an optional part of the URL.
Request Parameters
Parameter |
Description |
host |
Specify the IP address or host name of the IBM Security Key Lifecycle Manager server. |
port |
Specify the port number on which the IBM Security 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 Key Lifecycle Manager. For example: en or de |
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.
- 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 bodyJSON object with the following specification.
JSON property name |
Description |
IBM Security Key Lifecycle Manager Version |
Returns the version number of IBM Security Key Lifecycle Manager. |
IBM Security Key Lifecycle Manager Build Level |
Returns the build level of installed IBM Security Key Lifecycle Manager. |
Embedded WAS Version |
Returns the version number of WebSphere® Application Server. |
DB2 Version |
Returns the version number of DB2. |
Java Version |
Returns the version number of Java. |
Error Response
BodyJSON 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 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
-
Status Code : 200 OK
Content-Language: en
{
"IBM Security Key Lifecycle Manager Version": "3.0.0.0",
"IBM Security Key Lifecycle Manager Build Level": "201702282314",
"Embedded WAS Version": "9.0.0.1",
"DB2 Version": "11.1.0.1527",
"Java Version": "JRE 1.8.0 IBM J9 VM 2.8"
}
- Error response
-
Status Code : 400 Bad Request
Content-Language: en
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user
authentication ID or invalid request format."}