Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Channels & Integrations
POSTAlertingSince 1.0SynchronousAuth Required

TestAlertSmtpConfig

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • hostStringRequired

    SMTP server hostname

    Example: smtp.example.com

  • portIntegerRequired

    SMTP server port

    Example: 587

  • usernameStringRequired

    SMTP authentication username

    Example: alerts@example.com

  • passwordStringRequired

    SMTP authentication password

    Example: secret

  • encryptionStringRequired

    Encryption mode: none, ssl, or starttls

    Example: starttls

Responses

200 OK

On success, this API returns the following response structure.

  • successBoolean

    Whether the SMTP connectivity test succeeded

    Example: true

  • errorMessageString

    Error message if the test failed

    Example: authentication failed

Endpoint

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

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

Operation ID

TestAlertSmtpConfig

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/channels/smtp/test' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"host":"smtp.example.com","port":587,"username":"alerts@example.com","password":"secret","encryption":"starttls","testRecipient":"ops@example.com"}'

Response Example

200
{
  "success": true,
  "errorMessage": "authentication failed"
}

Change History

This API has no change history records yet.

View all change history