We've Moved! Product Documentation has moved to docs.hitachivantara.com

Get SMTP alert profiles

Last updated
Save as PDF

Get SMTP email alert profiles used to send alerts. Unlike syslog and SNMP traps, email alerts can be configured to have multiple different profiles, which can send the alerts at different frequencies, and in different format.

HTTP request syntax (URI)

GET <base_URI>/v8/storage/file-devices/alerts/smtp/profiles

Return codes

Code	Data	Description
200	emailProfiles	SMTP email profiles successfully retrieved.
500	Error message	Error associated with the storage system.

Any HTTP status code other than 200 indicates that the API did not complete successfully.

Request example

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/file-devices/alerts/smtp/profiles

Response example

HTTP/1.1 200 OK
{
  "emailProfiles": [
    {
      "discloseDetails": true,
      "excludeAttachments": false,
      "htmlFormat": true,
      "ignoreNdmpEvents": false,
      "isEnabled": true,
      "maxEmailLength": 65536,
      "name": "main",
      "notificationFrequencyInfo": "NEVER",
      "notificationFrequencySevere": "IMMEDIATELY",
      "notificationFrequencyWarning": "IMMEDIATELY",
      "objectId": "6d61696e3a3a3a303a3a3a4f49445f24232140255f56",
      "recipients": [
        "frank@example.com"
      ],
      "sendDailyStatusEmails": true,
      "sendEmptyEmails": true,
      "summaryTimes": [
        "08:00"
      ],
      "text": "",
      "uuEncode": true
    }
  ]
}

Quick Links