Get System Details REST Service
Use Get System Details REST Service to request IBM® Security Guardium® Key Lifecycle Manager server configuration details.
You can use Get System Details REST Service to
get the following details:
- IP address of the server
- Keystore initialization status
- TCP transports initialization status
- TCP port number
- TLS configuration status
- TLS port number
- KMIP implementation status
- KMIP TLS port number of the server
- KMIP initialization status
- Operation
GET
- URL
- To retrieve all system details:
- https://<host>:<port>/SKLM/rest/v1/systemDetails
- To retrieve a single system detail:
- https://<host>:<port>/SKLM/rest/v1/systemDetails/<systemDetailType>
- To retrieve multiple system details:
- https://<host>:<port>/SKLM/rest/v1/systemDetails?systemDetailType=<value>
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 host name 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. |
systemDetailType | Optional. Specify the configuration detail of
the IBM Security Guardium Key Lifecycle Manager
server. All the configuration details of the server are returned if
this parameter is not specified. You can specify any of the following
values:
You can specify multiple comma-separated values. |
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. |
Success response body
JSON object with the following specification:
JSON property name | Description |
---|---|
IPAddr | Returns the IP address or host name of the IBM Security Guardium Key Lifecycle Manager server. |
keyStoreInitialized | Indicates whether the keystore is initialized in the server. |
TCPTransportsInitialized | Indicates whether the TCP transport is initialized for message communications. |
TLSTransportsInitialized | Indicates whether the TLS transport is initialized in the server for secure communications. |
TCPport | Returns the TCP port number of the IBM Security Guardium Key Lifecycle Manager server. |
TLSConfigured | Indicates whether TLS is configured for the IBM Security Guardium Key Lifecycle Manager server to use a TLS connection |
TLSport | Returns the TLS port number on which the server listens for TLS requests. |
KMIPConfigured | Indicates whether the KMIP settings are configured in the IBM Security Guardium Key Lifecycle Manager server. |
KMIPTLSport | Returns the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests to communicate over the TLS socket by using KMIP. |
KMIPStatus | Indicates whether KMIP is used for key management operations by the IBM Security Guardium Key Lifecycle Manager server. |
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 get all system details
GET https://<host>:<port>/SKLM/rest/v1/systemDetails Content-Type: application/json Accept : application/json Authorization : SKLMAuth userAuthId=37ea1939-1374-4db7-84cd-14e399be2d20 Accept-Language : en
- Service request to get a single system detail
GET https://<host>:<port>/SKLM/rest/v1/systemDetails?systemDetailType=IPAddr OR GET https://<host>:<port>/SKLM/rest/v1/systemDetails/IPAddr Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=37ea1939-1374-4db7-84cd-14e399be2d20 Accept-Language: en
- Service request to get multiple system details
GET https://<host>:<port>/SKLM/rest/v1/systemDetails?systemDetailType= TCPTransportsInitialized,TCPport Content-Type: application/json Accept : application/json Authorization : SKLMAuth userAuthId=37ea1939-1374-4db7-84cd-14e399be2d20 Accept-Language : en