Skip to content
Exhale

Set the mail server for email reminders (owners only)

POST
/api/v1/settings/smtp
curl --request POST \
  --url http://127.0.0.1:8484/api/v1/settings/smtp \
  --header 'Content-Type: application/json' \
  --data '{ "from": "example", "host": "example", "password": "example", "port": 1, "tls": "starttls", "username": "example" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
from
required

Sender address, e.g. reminders@example.com

string
host
required

SMTP server, e.g. smtp.example.com

string
password

Leave empty to keep the saved password

string
port

Default: 587 with starttls, 465 with tls, 25 with none

integer format: int64
tls

Starttls (default), tls (implicit, port 465) or none (local relays)

string
Allowed values: starttls tls none
username
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
allowPrivate
required

Webhooks and ntfy may reach private-network addresses

boolean
allowPrivateSource
string
Allowed values: env settings
ntfy
required
object
hasToken
required

An access token is saved; it is never returned

boolean
server
required

Where members subscribe to their topic

string
source

Empty: the default public server

string
Allowed values: env settings
publicUrl

Address used for links in messages; empty when the server was started without –public-url

string
smtp
required
object
configured
required
boolean
from
string
hasPassword
required

A password is saved; it is never returned

boolean
host
string
port
integer format: int64
source

Env: set by EXHALE_SMTP_* on the server and not editable in the web

string
Allowed values: env settings
tls
string
Allowed values: starttls tls none
username
string

Example 

{
  "$schema": "https://example.com/api/schemas/ChannelsStatus.json",
  "allowPrivateSource": "env",
  "ntfy": {
    "source": "env"
  },
  "smtp": {
    "source": "env",
    "tls": "starttls"
  }
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}