Replication Start REST Service
Use Replication Start REST Service to start the replication server for replicating the current IBM Security Guardium Key Lifecycle Manager active files on clone servers based on a configured schedule.
Note: IBM Security Guardium Key Lifecycle Manager data is replicated based on a
configured schedule only when new cryptographic objects are added to the master server.
- Operation
POST
- URL
- https://<host>:<port>/SKLM/rest/v1/replicate/start
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 |
---|---|
code | Returns the value that is specified by the message property. |
message | Returns the status message that indicates the
success or failure of the replication task:
|
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 start the replication task
POST https://localhost:<port>/SKLM/rest/v1/replicate/start Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m
- Service request to start the replication task without specifying the configuration file
POST https://localhost:<port>/SKLM/rest/v1/replicate/start Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=139aeh34567m