Use the Test Connection to Email Server REST Service to test whether
the configured email server is reachable by sending a test email.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/ckms/notification/channel/email/testConnection
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 code that is specified by the status
property. |
status |
Returns a message that indicates the status of the 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 test connection
-
POST https://localhost:port/SKLM/rest/v1/ckms/notification/channel/email/testConnection
- Success response
-
{
"code": "0",
"status": "Succeeded"
}
- Incorrect service request
-
POST https://localhost:port/SKLM/rest/v1/ckms/notification/channel/email/testConnection
- Error response
-
{
"code": "CTGKM6243E",
"message": "CTGKM6243E Problem in sending E-mail. Please check logs for more detail."
}