Update Hostname REST Service

Use the Update Hostname REST Service to update the hostname of IBM® Security Guardium® Key Lifecycle Manager.


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 property name Description
newHostname Specify the new hostname value.


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
status Returns the status to indicate whether the objects were updated to use the new client certificate.
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.


Request to update the hostname
PUT https://localhost:port/SKLM/rest/v1/ckms/servermanagement/updateHostname
{ "newHostname" : "host2"}
Success response
  "code": "0",
  "status": "Succeeded"
Invalid request (no value is specified for newHostname)
PUT https://localhost:port/SKLM/rest/v1/ckms/servermanagement/updateHostname
{ "newHostname" : ""}
Error response
  "code": "CTGKM0550E",
  "message": "CTGKM0550E Input value cannot be an empty string for parameter newHostname."
Table 1. Topic change log
Date Change description
05 Oct 2021 Added the Update Hostname REST Service.
10 Sept 2021 Initial version.