Key Server Status REST Service

Use Key Server Status REST Service to obtain the status of the key server, an internal component of the IBM Security Guardium Key Lifecycle Manager server.

Operation
GET
URL
https://host:port/SKLM/rest/v1/keyServerStatus

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.
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 the status of the Key Server
GET https://localhost:port/SKLM/rest/v1/keyServer Status
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
Success response
Status Code : 200 OK
{
    "Keystores initialized": true,
    "TCP transports initialized": true,
    "TLS transports initialized": true,
    "3592 Primary Certificate defined": false,
    "3592 Secondary Certificate defined": false,
    "Accepting unknown 3592 devices": false,
    "Pending unknown 3592 devices": false,
    "Any 3592 devices defined": false,
    "LTO Default Keygroup defined": false,
    "LTO accepting unknown devices": false,
    "Pending unknown LTO devices": false,
    "Any LTO Devices Defined": false,
    "DS5000 accepting unknown devices": false,
    "Pending unknown DS5000 devices": true,
    "Any DS5000 devices defined": true,
    "Accepting unknown DS8000 devices": false,
    "Pending unknown DS8000 devices": false,
    "Any DS8000 devices defined": false,
    "Transport TCP port": "3801",
    "Transport TLS port": "1441",
    "Transport TLS certificate alias": "sslserver",
    "KMIP TLS port": "5696",
    "KMIP TLS transports initialized": true
}
Error response
Status Code : 400 Bad Request
Content-Language: en
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user 
authentication ID or invalid request format."}