Use Restart Server REST Service to restart the IBM® Security Guardium® Key Lifecycle Manager server. Restart of the server causes the
server to read its configuration and accept the configuration changes, if any.
- Operation
POST
- URL
- https://<host>:<port>/SKLM/rest/v1/ckms/servermanagement/restartServer
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. |
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 value that is specified by the message
property. |
message |
Returns the status message that indicates success or failure of the server
restart operation. |
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 restart the IBM Security Guardium Key Lifecycle Manager
server
POST https://localhost:<port>/SKLM/rest/v1/ckms/servermanagement/restartServer
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
- Success response
Status Code : 200 OK
{"code": "CTGKM2936I","message": "CTGKM2936I Guardium Key Lifecycle Manager Server restarted successfully.
After restarting the server, it will be unavailable for few minutes."}}
- Error response
Status Code : 200 OK
{"code": "CTGKM2937E","message": "CTGKM2937E Error restarting IBM Security Guardium Key Lifecycle Manager Server,
plesae check logs for more information."}