Skip to main content
ZStack
Alerting & Response/Alert Channels & Integrations

TestAlertSmtpConfig

Test SMTP connectivity without saving the configuration Fixed RI-AN-NI01: standalone SMTP connectivity test

POST/api/v1/alerting/channels/smtp/test

Operation ID

TestAlertSmtpConfig

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • host
    StringRequired

    SMTP server hostname

    Example: smtp.example.com

  • port
    IntegerRequired

    SMTP server port

    Example: 587

  • username
    StringRequired

    SMTP authentication username

    Example: alerts@example.com

  • password
    StringRequired

    SMTP authentication password

    Example: secret

  • encryption
    StringRequired

    Encryption mode: none, ssl, or starttls

    Example: starttls

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    Boolean

    Whether the SMTP connectivity test succeeded

    Example: true

  • errorMessage
    String

    Error message if the test failed

    Example: authentication failed