Skip to content
Start in Cloud

Get mail status

GET
/api/admin/system/mail
curl --request GET \
--url https://hitkeep.com/api/admin/system/mail \
--cookie hk_token=<hk_token>

Returns configured mail driver, host, port, encryption, sender identity, masked username, password presence, and last test result.

System mail status

Media type application/json
object
configured
boolean
driver
string
encryption
string
from_address
string
from_name
string
host
string
last_test_at
string format: date-time
last_test_ok
boolean
password_set
boolean
port
integer
username
string
Example generated
{
"configured": true,
"driver": "example",
"encryption": "example",
"from_address": "example",
"from_name": "example",
"host": "example",
"last_test_at": "2026-04-15T12:00:00Z",
"last_test_ok": true,
"password_set": true,
"port": 1,
"username": "example"
}