Get Config Properties List REST Service
Use Get Config Properties List REST Service to retrieve a list of all properties from the IBM® Security Guardium® Key Lifecycle Manager configuration properties file. You can view and change the configuration properties.
- 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
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. |
Success response
body
JSON Object with the following specification:
JSON property name | Description |
---|---|
configProperty | Returns the JSON object that contains the properties. Each property includes the property name and its value. |
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 list all the configuration properties
GET https://localhost:<port>/SKLM/rest/v1/configProperties Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=139aeh34567m Accept-Language : en
- Success response
Status Code : 200 OK Content-Language: en { "KMIPListener.ssl.port": "5696", "TransportListener.ssl.timeout": "10", "Audit.handler.file.size": "10000", "config.keystore.name": "defaultKeyStore", "tklm.encryption.password": "******", "debug.output.file": "logs/debug/sklm_debug.log", "rest.user.inactive_time": "15", "debug.output": "simple_file", "Audit.event.types": "runtime,authorization,authorization_terminate, resource_management,key_management", "enableKeyRelease": "false", "TransportListener.tcp.port": "3801", "Audit.eventQueue.max": "0", "config.keystore.batchUpdateTimer": "60000", "Audit.handler.file.name": "logs/audit/sklm_audit.log", "enableClientCertPush": "false", "debug": "all", "TransportListener.tcp.timeout": "10", "backup.keycert.before.serving": "false", "TransportListener.ssl.protocols": "TLS", "cert.valiDATE": "false", "config.keystore.batchUpdateSize": "10000", "useSKIDefaultLabels": "false", "config.keystore.ssl.certalias": "test-key", "TransportListener.ssl.port": "1441", "fips": "off", "zOSCompatibility": "false", "Audit.event.outcome": "success,failure" }
- Error response
Status Code : 400 Bad Request Content-Language: en {"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}