Skip to main content

Update Email Server​

Update the SMTP server settings

Request Body
  • SMTPServerName string

    The name of the mail server that sends alerts, scheduled reports, log files, and additional information.

  • SMTPPort int32

    The port number that connects to the mail server.

  • senderEmail string

    The sender email address used for emails sent from the software.

  • senderName string

    The sender name used for emails sent from the software.

  • encryptionAlgorithm string

    Possible values: [NONE, TLS, SSL]

    Default value: NONE

  • useAuthentication boolean

    The option to use authentication on the mail server. This is typically used in external or internet mail server configurations.

  • username string

    when useAuthentication is true, username must be present

  • password string

    Password must be in base 64 encoded format. Password attribute can be left out to reuse the already saved password

Responses

OK

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/emailserver

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
Body
{

  "SMTPServerName": "string",

  "SMTPPort": 0,

  "senderEmail": "string",

  "senderName": "string",

  "encryptionAlgorithm": "NONE",

  "useAuthentication": true,

  "username": "string",

  "password": "string"

}

curl -L -X PUT 'https://localhost/webconsole/api/V4/EmailServer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "SMTPServerName": "string",
  "SMTPPort": 0,
  "senderEmail": "string",
  "senderName": "string",
  "encryptionAlgorithm": "NONE",
  "useAuthentication": true,
  "username": "string",
  "password": "string"
}'