Get SMTP server settings status
GET /api/system_settings/smtp_server_status
GET /api/system_settings/smtp_server_statusInteractive request editor loads with JavaScript.
X-API-KEY<token>
In: header
Response Body
application/json
application/json
curl -X GET "$API_BASE_URL/api/system_settings/smtp_server_status"Successfully retrieved the SMTP server connection status.
{
"value": {
"enable": true
}
}Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
{
"value": {},
"error_msg": "error message"
}Complete operation details and schema variants
GET /api/system_settings/smtp_server_status
Get SMTP server settings status
Get the health and readiness status of the configured SMTP server settings. This endpoint helps verify whether current configuration can be used for email sending.
Parameters
Responses
200: Successfully retrieved the SMTP server connection status.- allOf variant 1
value(object, optional): The specific resource.- allOf variant 2
value(object, optional):value.enable(boolean, optional): Enable SMTP Server.400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.value(object, optional): The specific resource.error_msg(string, optional): The error message.
cURL
curl -X GET '$API_BASE_URL/api/system_settings/smtp_server_status'