Get Multiple Config Properties REST Service
Use Get Multiple Config Properties REST Service to retrieve one or more properties from the SKLMConfig.properties configuration file. You can also retrieve the Multi-Master cluster configuration properties that are stored in the MMConfig.properties file.
- Operation
GET
- URL
- https://<host>:<port>/SKLM/rest/v1/configProperties
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
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. |
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. |
JSON property name | Description |
---|---|
properties | Specify the configuration property names that you want to retrieve. You can
specify multiple comma-separated properties. For a list of the valid property names, see Server configuration properties and database values and Multi-Master cluster configuration properties. |
type | Optional. If you want to retrieve Multi-Master cluster configuration properties, specify the value as MM. |
Response
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
JSON array that contains JSON objects with the following specification:
JSON property name | Description |
---|---|
property | Returns the name of the requested configuration property. |
value | Returns the value of the configuration property. This JSON property is present only when the property is found in the configuration file. |
status | Returns the status to indicate that the requested
property does not exist. This JSON property is present only when the property is not found in the configuration file. |
200
OK
is
returned even if the property you requested is not found. An appropriate
message is returned in the 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 a single configuration property
GET https://localhost:<port>/SKLM/rest/v1/configProperties?properties= KMIPListener.ssl.port
- Success response
Status Code : 200 OK Content-Language: en [{"property":"KMIPListener.ssl.port","value":"5696"}]
- Error response
Status Code : 400 Bad Request Content-Language: en {"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}
- Service request to get multiple configuration properties
GET https://localhost:<port>/SKLM/rest/v1/configProperties?properties= KMIPListener.ssl.port,ghtj,TransportListener.ssl.timeout
- Success response
Status Code : 200 OK Content-Language: en [ { "property": "KMIPListener.ssl.port", "value": "5696" }, { "property": "ghtj", "status": "CTGKM0556E Cannot find the property in configuration file: ghtj " }, { "property": "TransportListener.ssl.timeout", "value": "10" } ]
- Error response
Status Code : 400 Bad Request Content-Language: en {"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}