Update Config Property REST Service

Use Update Config Property REST Service to update one or more properties in one of the following IBM® Security Guardium® Key Lifecycle Manager configuration files: SKLMConfig.properties (controls the IBM Security Guardium Key Lifecycle Manager server operations), MMConfig.properties (controls the Multi-Master cluster operations).

Operation
PUT
URL
https://host:port/SKLM/rest/v1/configProperties

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 property name Description
Property names Specify the configuration property that you want to update in the configuration file. You can specify multiple comma-separated properties. For example, {"fips" : "on", "KMIPListener.ssl.port" : "5678"}
type Optional. Specify the value MM when you want to update properties in the MMConfig.properties file.

When this parameter is not specified, the REST API updates properties in the SKLMConfig.properties file.

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
property Returns the name of the property that is updated.
status Returns the status to indicate the configuration file updates.
Note: The success response code 200 OK is returned even if the property you requested is not found. An appropriate message is returned in the response body.
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 update a single server configuration property
PUT https://localhost:<port>/SKLM/rest/v1/configProperties
{ "KMIPListener.ssl.port" : "10000"}
Success response
Status Code : 200 OK
[{"property":"KMIPListener.ssl.port","status":"CTGKM0607I Update 
successful, server restart required for change to take effect"}]
Error response
Status Code : 400 Bad Request
{"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: 
Invalid user authentication ID or invalid request format"}
Service request to update multiple server configuration properties
PUT https://localhost:<port>/SKLM/rest/v1/configProperties
 {"fips" : "on", "KMIPListener.ssl.port" : "5678"}
Success response
Status Code : 200 OK
[{"property":"KMIPListener.ssl.port","status":"CTGKM0607I Update 
successful, server restart required for change to take effect"},{"
property":"fips","status":"CTGKM0606I Update successful, change will 
take effect immediately"}]
Error response
Status Code : 400 Bad Request
Content-Language: en
{"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: 
Invalid user authentication ID or invalid request format"}
Service request to update the Db2® password change in Multi-Master configuration (MMConfig.properties) file
PUT https://localhost:port/SKLM/rest/v1/configProperties
{ "Db2PasswordChangeActivity" : "true", "type" : "MM"}
Success response
Status Code : 200 OK
[{"property":"Db2PasswordChangeActivity","status":"CTGKM0607I Update 
successful, change will take effect immediately"}]
Error response
Status Code : 400 Bad Request
{"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: 
Invalid user authentication ID or invalid request format"}