Skip to content
You're viewing documentation for v2026.11.11-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Get the SMTP settings

Never returns the password: passwordSet reports whether one is stored.

GET/api/v1/alert-smtp
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

authUsernamestringrequired

Empty means no authentication

configuredbooleanrequired
fromstringrequired

Sender address

hellostringrequired

Name sent in EHLO; empty uses the default

passwordSetbooleanrequired

Whether a password is stored. No endpoint returns the password

passwordUnreadablebooleanrequired

The stored password cannot be decrypted; email is not sent until it is entered again

requireTlsbooleanrequired

Whether STARTTLS is required

smarthoststringrequired

host:port of the SMTP server

default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/alert-smtp' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "authUsername": "string",
  "configured": true,
  "from": "string",
  "hello": "string",
  "passwordSet": true,
  "passwordUnreadable": true,
  "requireTls": true,
  "smarthost": "string"
}