SystemSettingsSMTP¶

SystemSettingsSMTP - List¶

Lists all SMTP System Settings.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SystemSettingsSMTP

Success Response

[
    {
        "id": "59193916d8aaa438912a79a6",
        "login_required": true,
        "smtp_port": 25,
        "smtp_sender_email": "[email protected]",
        "smtp_sender_name": "John Doe",
        "smtp_server": "192.168.1.34",
        "smtp_username": "[email protected]",
        "username_in_email_field": ""
    }
]

SystemSettingsSMTP - SMTPTest¶

Tests SMTP Settings.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SystemSettingsSMTP/smtptest

Parameter

Field	Label in UI	Type	Description
email	Email	String	Receiver’s Email address. Mandatory Field
login_required	Login Required	String	Value must be “on” if login is mandatory for sending email from the given address. Optional Field
message	Message	String	Body of the Email. Mandatory Field
smtp_password	Password	String	Password for authentication. Mandatory only when the value of the login_required parameter is “on”. Optional Field
smtp_port	Port	int	SMTP Server Port number. Default Value = 25. Optional Field
smtp_sender_email	Email	String	Sender’s Name. Mandatory Field
smtp_sender_name	Sender Name	String	Sender’s Name. Mandatory Field
smtp_server	Server	String	Hostname or IP Address of the SMTP Server. Mandatory Field
smtp_username	Username	String	Username for authentication. Mandatory only when the value of the login_required parameter is “on”. Optional Field
subject	Subject	String	Subject of the Email. Mandatory Field

Request Example

{
    "data": {
        "email": "[email protected]",
        "login_required": "on",
        "message": "This is a test",
        "smtp_password": "ram",
        "smtp_port": 25,
        "smtp_sender_email": "[email protected]",
        "smtp_sender_name": "ram",
        "smtp_server": "192.168.1.34",
        "smtp_username": "ram",
        "subject": "SMTP configuration test"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

SystemSettingsSMTP - Save¶

Updates the existing SMTP System Settings.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SystemSettingsSMTP

Parameter

Field	Label in UI	Type	Description
login_required	Login Required	String	Value must be “on” if login is mandatory for sending email from the given address. Optional Field
smtp_password	Password	String	Password for authentication. Mandatory only when the value of the login_required parameter is “on”. Optional Field
smtp_port	Port	int	SMTP Server Port number. Default Value = 25. Optional Field
smtp_sender_email	Email	String	Sender’s Email. Mandatory Field
smtp_sender_name	Sender Name	String	Sender’s Name. Mandatory Field
smtp_server	Server	String	Hostname or IP Address of the SMTP Server. Mandatory Field
smtp_username	Username	String	Username for authentication. Mandatory only when the value of the login_required parameter is “on”. Optional Field

Request Example

{
    "data": {
        "login_required": "on",
        "smtp_password": "ram",
        "smtp_port": 25,
        "smtp_sender_email": "[email protected]",
        "smtp_sender_name": "ram",
        "smtp_server": "192.168.1.34",
        "smtp_username": "ram"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?