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

SaveAlertSmtpConfig

Save or update the global SMTP configuration for email notifications

PUT/api/v1/alerting/smtp-config

Operation ID

SaveAlertSmtpConfig

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
    String

    SMTP server hostname

    Example: smtp.example.com

  • port
    Integer

    SMTP server port

    Example: 587

  • encryption
    String

    Encryption mode: none, ssl, or starttls

    Example: starttls

  • username
    String

    SMTP authentication username

    Example: alerts@example.com

  • password
    String

    SMTP authentication password

    Example: secret

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • host
    String

    SMTP server hostname

    Example: smtp.example.com

  • port
    Integer

    SMTP server port

    Example: 587

  • encryption
    String

    Encryption mode: none, ssl, or starttls

    Example: starttls

  • username
    String

    SMTP authentication username

    Example: alerts@example.com

  • fromAddr
    String

    Sender email address

    Example: alerts@example.com

  • fromName
    String

    Sender display name

    Example: ZCF Alerts

  • createDate
    String

    Timestamp when the SMTP config was created

    Example: 2026-01-15T08:00:00Z

  • lastOpDate
    String

    Timestamp of the last SMTP config update

    Example: 2026-01-15T08:00:00Z

  • authMethod
    String

    Authentication method: none, plain, or oauth2 (XOAUTH2)

    Example: oauth2

Change History

View all change history

  • Change Time

    AddedRequest body fields accessToken, authMethodAddedResponse fields authMethod
    View API