Get Multiple Replication Config Properties REST Service

Edit online

Use Get Multiple Replication Config Properties REST Service to retrieve one or more properties from the ReplicationSKLMConfig.properties configuration file.

Operation: GET
URL: https://<host>:<port>/GKLM/rest/v1/replicationConfigProperties?properties=<propertyName1>,<propertyName2>,<....>

By default, IBM® Guardium® Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM 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 Guardium Key Lifecycle Manager server.
port	Specify the port number on which the IBM 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 Guardium Key Lifecycle Manager. For example, `en` or `de`.

*Query parameters*
JSON property name	Description
properties	Specify the replication configuration property names that you want to retrieve. You can specify multiple comma-separated property names.

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
property	Returns the replication configuration property name that you requested.
value	Returns the value of the replication configuration property. This JSON property is present only when the configuration property is found in the replication configuration file.
status	Returns the status to indicate that the requested property does not exist. This JSON property is present only when the configuration property is found in the replication configuration file.

Note: The success response code 200 OK is returned even if the property you requested is not found. An appropriate message is returned in the response body.

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 return a single configuration property

GET https://localhost:<port>/GKLM/rest/v1/replicationConfigProperties?
properties=replication.role
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en

Success response

Status Code : 200 OK
Content-Language: en
[{"property":"replication.role","value":"master"}]

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 return multiple configuration properties

GET https://localhost:<port>/GKLM/rest/v1/replicationConfigProperties?
propertyName=replication.role,ghtj,backup.ClientPort1
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en

Success response

Status Code : 200 OK
Content-Language: en
[
       {
           "property":"replication.role",
	          "value":"master"
       },
       {
           "property": "ghtj",
           "status": "CTGKM0556E Cannot find the property in 
            configuration file: ghtj "
       },
       {
           "property": "backup.ClientPort1",
           "value": "1024"
       }
    ]

Error response

Status Code : 400 Bad Request
Content-Language: en
{"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid 
user authentication ID or invalid request format."}