Update SMTP configuration.

put

https://helios.cohesity.com/v2/clusters/smtp

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters to update cluster SMTP configuration.

hostname

string

required

Specifies the IP address or the FQDN of the SMTP server.

isActive

boolean | null

Defaults to true

Specifies if the SMTP configuration is active.

port

int32

required

Specifies the SMTP port. Usually 465 or 587. For authenticated connection, it is generally 587.

senderEmailAddress

string | null

This is used for setting "Sender" field in SMTP header. This has to be in valid email format, and could be different from username, and it's a required field if the username is not of valid email address.

useSSL

boolean | null

Defaults to false

This is set to true when the SMTP server uses SSL/TLS without supporting STARTTLS. Typically, this is used for port 465.

username

string | null

Specifies the username which will be used to connect to the SMTP server. If username is not specified, then it would imply that SMTP server is set up for unauthenticated access.

password

string | null

Specifies the password of the SMTP user. This is required if username is specified in the request.

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Success

defaultError