Skip to main content

Get Email Server​

Select

SaaS
Customer Managed

Retrieves SMTP server details

Responses

OK

Schema
  • 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

    only when useAuthentication is true, username would be populated

GET /v4/emailserver

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/EmailServer' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'