Use the Modify Master REST Service to modify master server details to
meet your requirements. For example, you might want to update the IBM Security Guardium Key Lifecycle Manager administrator password.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/ckms/config/nodes/updateMaster
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 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 |
ipHostname |
Specify the host name of the Guardium Key Lifecycle Manager server server. |
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. |
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 update operation was
successful. |
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 modify a master details of multi-master cluster
POST https://localhost:port/SKLM/rest/v1/ckms/config/nodes/updateMaster
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
{
"ipHostname" : "cimkc2b151",
"httpPort" : "443",
"sklmUsername" : "sklmadmin",
"sklmPassword" : "your_sklmadmin_password",
}
- Success response
Status Code: 200 OK
{"code":"0","status":"CTGKM2989I Successfully modified the master."}
- Error response
{"code":"CTGKM6002E",
"message":"CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}