Get Replication Config Properties List REST Service
Use Get Replication Config Properties List REST Service to retrieve a list of all configuration properties from the ReplicationSKLMConfig.properties configuration file.
- Operation
GET
- URL
- https://<host>:<port>/SKLM/rest/v1/replicationConfigProperties
By default, Guardium® Key Lifecycle Manager server
listens to non-secure port 9080 (HTTP) and secure port 9443
(HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager
installation, you can modify these default ports.
Note: The non-secure port 9080 is not applicable
when IBM Security Guardium Key Lifecycle Manager is deployed in a containerized
environment.
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. |
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 a list of comma-separated replication properties. Each property represents 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 return a list of all properties
GET https://localhost:<port>/SKLM/rest/v1/replicationConfigProperties Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=139aeh34567m Accept-Language : en
- Success response
Status Code : 200 OK Content-Language: en { "backup.ClientPort1:1024, replication.role:master,replication. MaxLogFileSize:2000,replication.auditLogName:test.log"}
- Error response
Status Code : 400 Bad Request Content-Language: en {"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}