GET
/
api
/
v1
/
settings
/
notifications
/
email
Get Email Notification Settings
curl --request GET \
  --url http://localhost:8080/api/v1/settings/notifications/email \
  --header 'Authorization: Basic <encoded-value>'
{
  "status": "success",
  "data": {
    "notification.email.username": "[email protected]",
    "notification.email.host": "smtp.example.com",
    "notification.email.port": 587,
    "notification.email.password": "**********",
    "notification.email.max_conns": 10,
    "notification.email.idle_timeout": "15s",
    "notification.email.wait_timeout": "5s",
    "notification.email.auth_protocol": "PLAIN",
    "notification.email.email_address": "[email protected]",
    "notification.email.max_msg_retries": 3,
    "notification.email.tls_type": "STARTTLS",
    "notification.email.tls_skip_verify": false,
    "notification.email.hello_hostname": "example.com",
    "notification.email.enabled": true
  }
}

Authorizations

Authorization
string
header
required

Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>

Response

200
application/json

Email notification settings response

The response is of type object.