Get SMTP server settings
GET /api/system_settings/smtp_server
GET /api/system_settings/smtp_serverInteractive 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"Successfully retrieved the SMTP server settings.
{
"value": {
"enable": true,
"address": "smtp.example.com:587",
"authentication_type": "TLS",
"ssl_verify": true,
"username": "smtp-user@example.com",
"password": "secretpassword123",
"from_name": "John Doe",
"from_address": "sender@example.com"
}
}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
Get SMTP server settings
Retrieve the current SMTP server settings configured for outbound email delivery. Use this endpoint when auditing email configuration or debugging mail issues.
Required IAM Permission: Action iam:GetSMTPServer, Resource arn:api7:iam:organization/*
Parameters
Responses
200: Successfully retrieved the SMTP server settings.- allOf variant 1
value(object, optional): The specific resource.- allOf variant 2
value(object, optional):value.enable(boolean, required): Enable SMTP Server.value.address(string, required): The SMTP server address in host:port format.value.authentication_type(string, optional): The authentication type of the SMTP server.value.ssl_verify(boolean, required): Whether to validate server-side SSL.value.username(string, required): Username used to authenticate with the SMTP server.value.password(string, required): Password used to authenticate with the SMTP server.value.from_name(string, required): Sender's name.value.from_address(string, required): Sender's email address.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'