Replication Stop REST Service

Use Replication Stop REST Service to stop the replication server so that the current IBM Guardium Key Lifecycle Manager active files and data are not replicated to the clone servers.

Operation: POST
URL: https://<host>:<port>/GKLM/rest/v1/replicate/stop

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`.

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 array that contains JSON objects 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 stop task: `CTGKM2210W` `IBM Guardium Key Lifecycle Manager replication task is already down.` `CTGKM2208I` .`IBM Guardium Key Lifecycle Manager replication task stopped successfully.` `CTGKM2209E` `IBM Guardium Key Lifecycle Manager replication task failed to stop.` `CTGKM2222E` `No valid replication config file exists.`

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 stop task:

CTGKM2210W: IBM Guardium Key Lifecycle Manager replication task is already down.
CTGKM2208I: .IBM Guardium Key Lifecycle Manager replication task stopped successfully.
CTGKM2209E: IBM Guardium Key Lifecycle Manager replication task failed to stop.
CTGKM2222E: No valid replication config file exists.

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 stop the replication task

POST https://localhost:<port>/GKLM/rest/v1/replicate/stop
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m

Success response

[
		Status Code : 200 OK
		{"code": "CTGKM2208I","message": "CTGKM2208I IBM Guardium Key Lifecycle Manager replication task has stopped successfully."}
 ]

Error response

[
		{"code": "CTGKM2222E","message": "CTGKM2222E No valid replication 
			config file exists."}
 ]