[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager

Update Product Smtp Settings V2

Description

This API is used to update SMTP Configuration settings. Its recommended to trigger get SMTP settings API, before performing this operation.

Request

Request

URL

URL


put
https://localhost:8080/lcm/lcops/api/v2/settings/smtp
Copy

Request Body

Request Body

SMTPConfigurationDTO of type(s) application/json Required

smtpConfigurationDTO

{
    "authenticationRequired": true,
    "smtpEncryptionPort": "587/465",
    "smtpHostName": "smtp.office365.com",
    "userName": "myvmwareaccount@vmware.com"
}
boolean
authenticationRequired Optional

Authentication required


string
encryptionType Optional

Possible values are: NONESSLTLS


string
fromEmail Optional

string
password Optional

string
smtpEncryptionPort Optional

SMTP port


string
smtpHostName Optional

SMTP host name


string
userName Optional

User name for SMTP server

Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

200 OK

Returns SMTPConfigurationDTO of type(s) application/json
{
    "authenticationRequired": true,
    "smtpEncryptionPort": "587/465",
    "smtpHostName": "smtp.office365.com",
    "userName": "myvmwareaccount@vmware.com"
}
boolean
authenticationRequired Optional

Authentication required


string
encryptionType Optional

Possible values are: NONESSLTLS


string
fromEmail Optional

string
password Optional

string
smtpEncryptionPort Optional

SMTP port


string
smtpHostName Optional

SMTP host name


string
userName Optional

User name for SMTP server


201 Created

Created

Errors

Errors

GenericErrorResponseDTO
400

Bad Request


401

Unauthorized


403

Forbidden


GenericErrorResponseDTO
404

Not Found


GenericErrorResponseDTO
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"authenticationRequired":true,"smtpEncryptionPort":"587/465","smtpHostName":"smtp.office365.com","userName":"myvmwareaccount@vmware.com"}' https://localhost:8080/lcm/lcops/api/v2/settings/smtp


[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager
Settings Controller Operations
Feedback

Was this page helpful?