Sign in
mail

view status of automatic e-mail notifications

Changed on
<h3>Administrator views the status of sending automatic e-mail notifications sent by automatic certificate renewal job.</h3>
get/mail/mail-notification-status

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/mail/mail-notification-status
  • Auth: API key in header Authorization

Response

e-mail notifications status

enabled_notificationsMailNotificationType[]

array containing the mail notification types that are enabled

configuration_presentboolean

whether automatic e-mail has been configured

recipients_emailsstring[]

configured recipients e-mail addresses

Example response

{
  "enabled_notifications": [
    "ACME_FAILURE"
  ]
}

Changes

  • 458c3746158cRevision changes
    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ○

      added the optional property to the response with the status