Read the SMTP configuration

GET

/admin/system/smtp

• Local development behind nginx (port 8088 by default)

Authorizations

• cookieAuth
• bearerAuth

Responses

200

Current SMTP config

object

host

required

string

Example

smtp.example.com

port

required

integer

Example

587

encryption

required

string

Allowed values: none starttls tls

Example

starttls

username

string

password

Write-only. Provide to set or rotate the SMTP password; omit (or send empty string) on PATCH to keep the current value. The response never echoes this field — read password_set instead to check whether one is on file. Stored at rest encrypted via the AA_MASTER_KEY-backed atrest package; never sent back to clients.

string format: password

password_set

True when a password is currently stored. Set by the server on GET responses; ignored if sent on PATCH.

boolean

from_address

required

string

Example

ArtSite <noreply@example.com>

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed