Remove Master REST Service

Use Remove Master REST Service to remove node from the cluster by specifying Guardium Key Lifecycle Manager server instance details.

Operation
POST
URL
https://<host>:<port>/SKLM/rest/v1/ckms/config/nodes/removeNode

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.
Request body

JSON object with the following specification:

Property name Description
clusterName Specify the name of the multi-master cluster from which the master to be removed.
type Specify the Guardium Key Lifecycle Manager server instance type. For example, Primary, or Standby, or Node.
ipHostname Specify the host name of the Guardium Key Lifecycle Manager server server.

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
code Returns the code that is specified by the status property.
status Returns the status to indicate whether the master is removed from the multi-master cluster.
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 remove master from a multi-master cluster
POST https://localhost:<port>/SKLM/rest/v1/ckms/config/nodes/removeNode
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
[
  {  
   "clusterName" : "multimaster"
  },
  {
   "type" : "Node",
   "ipHostname" :  "klmdaisy"
  }
]
Success response
Status Code: 200 OK
{"code":"0","status":"Succeeded"}
Error response
{"code":"CTGKM6002E",
"message":"CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}