Admin > SMTP configuration

Get SMTP configuration

Retrieve the SMTP configuration used by your self-hosted tenant to send email. This endpoint is accessible only to self-hosted customers. When no configuration has been saved through the API, the response returns the SMTP settings from the tenant environment.

get/api/v1/admin/smtp

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/admin/smtp
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Response

Successful response

addressstring

SMTP server address

portinteger

SMTP server port

domainstring nullable

Domain sent during the SMTP greeting

user_namestring nullable

User name used for SMTP authentication

auth_typestring nullable

Authentication mode. One of plain, login, or cram_md5

encryption_modestring

Encryption mode. One of none, tls, starttls_auto, or starttls_strict

verify_ssl_certificateboolean

Whether the SMTP server's TLS certificate is verified

ca_pathstring nullable

Path to a directory of CA certificates on the self-hosted installation

ca_filestring nullable

Path to a CA certificate file on the self-hosted installation

open_timeoutinteger

SMTP connection open timeout in seconds

read_timeoutinteger

SMTP connection read timeout in seconds

sourcestring

Where the settings were loaded from. database means settings saved through this API; environment means no API-managed configuration exists and settings come from the tenant environment

password_setboolean

Whether a password is configured. The password itself is never returned

warningsobject nullable

Configuration warnings keyed by field. Only present for database-managed settings that have warnings

Changes

No recorded changes to this operation across all 1 revision of this API.