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 |
|
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