Configure SMTP email server settings

post

http://127.0.0.1:8080/gmsSMTP

Creates or updates the SMTP (Simple Mail Transfer Protocol) server configuration for sending email notifications and alerts. Not available for Cloud Orchestrator deployments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

SMTP server configuration object containing mail server address, authentication credentials, and connection settings.

Request body for configuring SMTP server settings. Uses alternate property names for JSON serialization.

emailServer

string

required

SMTP server hostname or IP address. Maps to 'server' field internally.

emailSender

string

required

Email address used as sender (From address) for outgoing emails.

emailSsl

boolean

required

Defaults to false

Enable SSL/TLS encryption. When true, port defaults to 465; when false, defaults to 25.

emailAuthentication

boolean

required

Defaults to false

Enable SMTP authentication. When true, emailUser and emailPassword are required.

emailUser

string

Username for SMTP authentication. Required when emailAuthentication is true.

emailPassword

password

Password for SMTP authentication. Required when emailAuthentication is true.

smtpPort

integer

0 to 65535

Defaults to 0

SMTP server port. If 0 or omitted, defaults to 25 (non-SSL) or 465 (SSL).

requireEmailVerification

boolean

Defaults to true

Require email verification before sending notifications. Defaults to true if not specified.

Responses

204

SMTP configuration saved successfully. No content returned.

401

Unauthorized - Valid authentication credentials with READ_WRITE role required.

403

Forbidden - User does not have READ_WRITE permission.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/html

400Bad Request - Cannot update SMTP settings for Cloud Orchestrator deployments.

500Internal Server Error - Failed to save SMTP configuration due to an I/O error.