Health REST Service

Use the Health REST Service to check the server health of IBM® Security Guardium® Key Lifecycle Manager container.

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

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
Request body
Parameter Description
Health-Authorization Specify the same value that is provided in the HEALTH_AUTHORIZATION_TOKEN parameter in the container run command. You can obtain its value from the values.yaml file.
componentType Specify an IBM Security Guardium Key Lifecycle Manager server component type to check its health.

You can specify one of the following server components:

  • IPP
  • IPP_SSL
  • KMIP
  • REST
  • GUI
  • DATABASE
  • AGENT
  • LICENSE
  • MASTERKEY_REPOSITORY

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
overall Returns the overall health status of the IBM Security Guardium Key Lifecycle Manager container when no value is specified for the componentType parameter.
ipp / ipp_ssl / kmip / rest / gui / database / agent / license / masterkey_repository Returns the health status of the component type that you specified.

Example

Service request to check overall health
GET https://localhost:port/SKLM/rest/v1/health
Success response
Status Code : 200 OK
Response body
{
  "overall": true
}
Service request to check health of a component
GET https://localhost:port/SKLM/rest/v1/health?componentType=IPP_SSL
Success response
Status Code : 200 OK
Response body
{
  "ipp_ssl": false
}
Invalid service request (when component type is invalid)
https://localhost:port/SKLM/rest/v1/health?componentType=MM
Error response
{
  "code": "CTGKM3471E",
  "message": "CTGKM3471E Invalid Component Type MM. Supported Component Type are IPP, IPP_SSL, KMIP, REST, GUI, DATABASE, AGENT, LICENSE, MASTERKEY_REPOSITORY."
}
Table 1. Topic change log
Date Change description
05 Oct 2021 Added the Health REST Service.
10 Sept 2021 Initial version.