Update SMTP alert profile
Updates an existing SMTP email profile.
Valid notification frequency values are: IMMEDIATELY, SUMMARY or NEVER. Information alerts can’t be sent more frequently than Warning alerts, and Warning alerts can’t be sent more frequently than Severe alerts.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/file-devices/alerts/smtp/profiles/{profileId}
Parameters
| Name | Type | Required | Values | Description |
| discloseDetails | BODY | N | boolean | Disclose details in the emails (IP addresses, etc). |
| excludeAttachments | BODY | N | boolean | Excludes attachments for this profile. |
| htmlFormat | BODY | N | boolean | Sends the emails in HTML format. |
| ignoreNdmpEvents | BODY | N | boolean | Ignore NDMP events in emails which are sent immediately. |
| isEnabled | BODY | N | boolean | Enables/disables the profile. |
| maxEmailLength | BODY | N | integer | Maximum possible email length, in bytes. |
| notificationFrequencyInfo | BODY | N | string | Frequency to send Information severity alerts. |
| notificationFrequencyWarning | BODY | N | string | Frequency to send Warning severity alerts. |
| notificationFrequencySevere | BODY | N | string | Frequency to send Severe severity alerts |
| profileId | URI_PARAM | Y | string | Specifies the email alert profile object ID. |
| recipients | BODY | N | list of strings | List of all email recipients. |
| sendDailyStatusEmails | BODY | N | boolean | Sends a daily status email. |
| sendEmptyEmails | BODY | N | boolean | Sends empty summary emails if there are no alerts to send. |
| summaryTimes | BODY | N | list of strings | List of times that summary emails will be sent. Times must be of the form HH:MM. Two summary times can be specified. |
| text | BODY | N | string | Arbitrary text to include at the beginning of the email body. |
| uuEncode | BODY | N | boolean | Uuencode diagnostic emails. |
Return codes
| Code | Data | Description |
| 204 | No Data | SMTP alert profile successfully updated. |
| 400 | Error Message | Missing or invalid request contents. |
| 403 | Error Message | Operation forbidden by access level. |
| 500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 204 indicates that the API did not complete successfully.
Request example: Update profile to send daily status emails at 09:00 and 12:00
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/file-devices/alerts/smtp/profiles/6d61696e3a3a3a303a3a3a4f49445f24232140255f56 -X PATCH -d '{"summaryTimes":["09:00", "12:00"], "sendDailyStatusEmails":true}'
Response example
HTTP/1.1 204 No Content
Request example: Update profile to user HTML formatting, and send severe events immediately
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/file-devices/alerts/smtp/profiles/6d61696e3a3a3a303a3a3a4f49445f24232140255f56 -X PATCH -d '{"htmlFormat":true, "notificationFrequencySevere":"IMMEDIATELY"}'
Response example
HTTP/1.1 204 No Content