Update Email Server REST Service
Use the Update Email Server REST Service to update the details of the email server that is configured as an email notification channel.
- Operation
PUT
- URL
- https://host:port/SKLM/rest/v1/ckms/notification/channel/email
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 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.
JSON property name | Description |
---|---|
toEmailAddress | Specify the email address to which you want to send the event notification.
You can specify multiple email addresses in comma-separated format. For example,
|
password | Specify the password for the email address of sender. |
fromEmailAddress | Specify the email address of the sender. |
smtpHost | Specify the hostname or IP address of the email server. |
smtpPort | Specify the port of the email server. |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
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 update the email notification channel
-
PUT https://localhost:port/SKLM/rest/v1/ckms/notification/channel/email { "toEmailAddress": "user01@james.local", "password": "1234", "fromEmailAddress": "user02@james.local", "smtpHost": "email_server", "smtpPort": "465" }
- Success response
-
{ "code": "0", "status": "Succeeded" }
- Incorrect service request
-
PUT https://localhost:port/SKLM/rest/v1/ckms/notification/channel/email { "toEmailAddress": "", "password": "1234", "fromEmailAddress": "user02@james.local", "smtpHost": "email_server", "smtpPort": "465" }
- Error response
-
{ "code": "CTGKM0550E", "message": "CTGKM0550E Input value cannot be an empty string for parameter toEmailAddress." }