Add Master REST Service

Use the Add Master REST Service to add a master server to a Multi-Master cluster by specifying details of the Guardium® Key Lifecycle Manager server instance that is part of the cluster.

Operation: POST
URL: https://host:port/SKLM/rest/v1/ckms/config/nodes/addNodes

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

Request body

JSON object with the following specification:

Property name	Description
clusterName	Required. Specify the name for the Multi-Master cluster to which the master server is to be added. Valid value: `multimaster`
primaryHadrPort	Specify the port number for the HADR primary database. You must specify the value for this property for the first time only when stand-alone Guardium Key Lifecycle Manager server instance is configured as a primary master server along with Standby or Node.
type	Specify the Guardium Key Lifecycle Manager server instance type. Possible values: `Standby` `Node`
ipHostname	Specify the host name of the Guardium Key Lifecycle Manager server.
standbyPriorityIndex	Specify the priority index value for the standby database. You can set the priority index to any value in the range 1-3. The standby server with a higher priority index level (lower number) takes precedence over the lower-priority databases for being promoted to primary when the primary database is down.
httpPort	Specify the port number on which the Guardium Key Lifecycle Manager server server listens for requests from devices that communicate by using the TLS protocol.
sklmUsername	Specify the name of the Guardium Key Lifecycle Manager server administrator.
sklmPassword	Specify the password for the Guardium Key Lifecycle Manager server administrator.
autoaccept	Specify whether the cluster automatically accepts the certificate of the master server that is being added. This property has two values: `true`, `false`. The default value is `false`, which indicates that the cluster does not automatically accept the certificate of the master server that is being added.

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 added to 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 add master server to a Multi-Master cluster

Example for adding a standby master server.

POST https://localhost:port/SKLM/rest/v1/ckms/config/nodes/addNodes
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
[
{
"clusterName" : "multimaster",
"primaryHadrPort" : "60029"
},
{
"type" : "Standby",
"ipHostname" :  "cimkc2b151",
"httpPort" :  "9443",
"sklmUsername" :  "sklmadmin",
"sklmPassword" :  "your_sklmadmin_password",
"standbyPriorityIndex" : "1",
"autoaccept"  : "true"
}
]

Example for adding a master server.

POST https://localhost:port/SKLM/rest/v1/ckms/config/nodes/addNodes
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
[
{
"clusterName" : "multimaster"
},
{
"type" : "Node",
"ipHostname" :  "cimkc2b151",
"httpPort" :  "9443",
"sklmUsername" :  "sklmadmin",
"sklmPassword" :  "your_sklmadmin_password",
"autoaccept"  : "true"
}
]

Success response

Status Code: 200 OK
{"code":"0","status":"CTGKM3002I Successfully added the master in multi-master cluster."}

Error response

{"code":"CTGKM6002E",
"message":"CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}