Retrieves current Mail Server configuration
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/settings/notification/mailServer
Response Parameters
applyToAlarms
Boolean
|
Indicates if this mail server settings should be applied to alarm categories (optional, default value will be "false")
|
fromAddress
String
|
Mail address that will be used to send mail notifications (required)
|
globalSubject
String
|
Subject that will be used in mail notifications (optional, default value will be empty string)
|
primaryMailServerAddress
String
|
Hostname/IP for Primary SMTP Server (required)
|
primaryMailServerPassword
String
|
Password for Primary SMTP Server (optional, default value will be empty string)
|
primaryMailServerPort
Integer
|
Port for Primary SMTP Server (required)
|
primaryMailServerUserName
String
|
Username for Primary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerAddress
String
|
Hostname/IP for Secondary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerPassword
String
|
Password for Secondary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerPort
Integer
|
Port for Secondary SMTP Server (optional, default value will be 0)
|
secondaryMailServerUserName
String
|
Username for Secondary SMTP Server (optional, default value will be empty string)
|
toAddress
String
|
Comma separated list of mail notification recipients (required)
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.64.88.203/webacs/api/v1/op/settings/notification/mailServer
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
<mailServerSettingsDTO>
<applyToAlarms>true</applyToAlarms>
<fromAddress>String value</fromAddress>
<globalSubject>String value</globalSubject>
<primaryMailServerAddress>String value</primaryMailServerAddress>
<primaryMailServerPassword>String value</primaryMailServerPassword>
<primaryMailServerPort>15</primaryMailServerPort>
<primaryMailServerUserName>String value</primaryMailServerUserName>
<secondaryMailServerAddress>String value</secondaryMailServerAddress>
<secondaryMailServerPassword>String value</secondaryMailServerPassword>
<secondaryMailServerPort>15</secondaryMailServerPort>
<secondaryMailServerUserName>String value</secondaryMailServerUserName>
<toAddress>String value</toAddress>
</mailServerSettingsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v1/op/settings/notification/mailServer.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/settings/notification/mailServer",
"@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
"mailServerSettingsDTO" : {
"applyToAlarms" : true,
"fromAddress" : "String value",
"globalSubject" : "String value",
"primaryMailServerAddress" : "String value",
"primaryMailServerPassword" : "String value",
"primaryMailServerPort" : 15,
"primaryMailServerUserName" : "String value",
"secondaryMailServerAddress" : "String value",
"secondaryMailServerPassword" : "String value",
"secondaryMailServerPort" : 15,
"secondaryMailServerUserName" : "String value",
"toAddress" : "String value"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/settings/notification/mailServer
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
applyToAlarms
Boolean
|
Indicates if this mail server settings should be applied to alarm categories (optional, default value will be "false")
|
fromAddress
String
|
Mail address that will be used to send mail notifications (required)
|
globalSubject
String
|
Subject that will be used in mail notifications (optional, default value will be empty string)
|
primaryMailServerAddress
String
|
Hostname/IP for Primary SMTP Server (required)
|
primaryMailServerPassword
String
|
Password for Primary SMTP Server (optional, default value will be empty string)
|
primaryMailServerPort
Integer
|
Port for Primary SMTP Server (required)
|
primaryMailServerUserName
String
|
Username for Primary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerAddress
String
|
Hostname/IP for Secondary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerPassword
String
|
Password for Secondary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerPort
Integer
|
Port for Secondary SMTP Server (optional, default value will be 0)
|
secondaryMailServerUserName
String
|
Username for Secondary SMTP Server (optional, default value will be empty string)
|
toAddress
String
|
Comma separated list of mail notification recipients (required)
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.64.88.203/webacs/api/v2/op/settings/notification/mailServer
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
<mailServerSettingsDTO>
<applyToAlarms>true</applyToAlarms>
<fromAddress>String value</fromAddress>
<globalSubject>String value</globalSubject>
<primaryMailServerAddress>String value</primaryMailServerAddress>
<primaryMailServerPassword>String value</primaryMailServerPassword>
<primaryMailServerPort>15</primaryMailServerPort>
<primaryMailServerUserName>String value</primaryMailServerUserName>
<secondaryMailServerAddress>String value</secondaryMailServerAddress>
<secondaryMailServerPassword>String value</secondaryMailServerPassword>
<secondaryMailServerPort>15</secondaryMailServerPort>
<secondaryMailServerUserName>String value</secondaryMailServerUserName>
<toAddress>String value</toAddress>
</mailServerSettingsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v2/op/settings/notification/mailServer.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
"mailServerSettingsDTO" : [ {
"applyToAlarms" : true,
"fromAddress" : "String value",
"globalSubject" : "String value",
"primaryMailServerAddress" : "String value",
"primaryMailServerPassword" : "String value",
"primaryMailServerPort" : 15,
"primaryMailServerUserName" : "String value",
"secondaryMailServerAddress" : "String value",
"secondaryMailServerPassword" : "String value",
"secondaryMailServerPort" : 15,
"secondaryMailServerUserName" : "String value",
"toAddress" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/settings/notification/mailServer
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
applyToAlarms
Boolean
|
Indicates if this mail server settings should be applied to alarm categories (optional, default value will be "false")
|
fromAddress
String
|
Mail address that will be used to send mail notifications (required)
|
globalSubject
String
|
Subject that will be used in mail notifications (optional, default value will be empty string)
|
primaryMailServerAddress
String
|
Hostname/IP for Primary SMTP Server (required)
|
primaryMailServerPassword
String
|
Password for Primary SMTP Server (optional, default value will be empty string)
|
primaryMailServerPort
Integer
|
Port for Primary SMTP Server (required)
|
primaryMailServerUserName
String
|
Username for Primary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerAddress
String
|
Hostname/IP for Secondary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerPassword
String
|
Password for Secondary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerPort
Integer
|
Port for Secondary SMTP Server (optional, default value will be 0)
|
secondaryMailServerUserName
String
|
Username for Secondary SMTP Server (optional, default value will be empty string)
|
toAddress
String
|
Comma separated list of mail notification recipients (required)
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.64.88.203/webacs/api/v3/op/settings/notification/mailServer
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
<mailServerSettingsDTO>
<applyToAlarms>true</applyToAlarms>
<fromAddress>String value</fromAddress>
<globalSubject>String value</globalSubject>
<primaryMailServerAddress>String value</primaryMailServerAddress>
<primaryMailServerPassword>String value</primaryMailServerPassword>
<primaryMailServerPort>15</primaryMailServerPort>
<primaryMailServerUserName>String value</primaryMailServerUserName>
<secondaryMailServerAddress>String value</secondaryMailServerAddress>
<secondaryMailServerPassword>String value</secondaryMailServerPassword>
<secondaryMailServerPort>15</secondaryMailServerPort>
<secondaryMailServerUserName>String value</secondaryMailServerUserName>
<toAddress>String value</toAddress>
</mailServerSettingsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v3/op/settings/notification/mailServer.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
"mailServerSettingsDTO" : [ {
"applyToAlarms" : true,
"fromAddress" : "String value",
"globalSubject" : "String value",
"primaryMailServerAddress" : "String value",
"primaryMailServerPassword" : "String value",
"primaryMailServerPort" : 15,
"primaryMailServerUserName" : "String value",
"secondaryMailServerAddress" : "String value",
"secondaryMailServerPassword" : "String value",
"secondaryMailServerPort" : 15,
"secondaryMailServerUserName" : "String value",
"toAddress" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/settings/notification/mailServer
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
applyToAlarms
Boolean
|
Indicates if this mail server settings should be applied to alarm categories (optional, default value will be "false")
|
fromAddress
String
|
Mail address that will be used to send mail notifications (required)
|
globalSubject
String
|
Subject that will be used in mail notifications (optional, default value will be empty string)
|
primaryMailServerAddress
String
|
Hostname/IP for Primary SMTP Server (required)
|
primaryMailServerPassword
String
|
Password for Primary SMTP Server (optional, default value will be empty string)
|
primaryMailServerPort
Integer
|
Port for Primary SMTP Server (required)
|
primaryMailServerUserName
String
|
Username for Primary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerAddress
String
|
Hostname/IP for Secondary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerPassword
String
|
Password for Secondary SMTP Server (optional, default value will be empty string)
|
secondaryMailServerPort
Integer
|
Port for Secondary SMTP Server (optional, default value will be 0)
|
secondaryMailServerUserName
String
|
Username for Secondary SMTP Server (optional, default value will be empty string)
|
toAddress
String
|
Comma separated list of mail notification recipients (required)
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.64.88.203/webacs/api/v4/op/settings/notification/mailServer
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
<mailServerSettingsDTO>
<applyToAlarms>true</applyToAlarms>
<fromAddress>String value</fromAddress>
<globalSubject>String value</globalSubject>
<primaryMailServerAddress>String value</primaryMailServerAddress>
<primaryMailServerPassword>String value</primaryMailServerPassword>
<primaryMailServerPort>15</primaryMailServerPort>
<primaryMailServerUserName>String value</primaryMailServerUserName>
<secondaryMailServerAddress>String value</secondaryMailServerAddress>
<secondaryMailServerPassword>String value</secondaryMailServerPassword>
<secondaryMailServerPort>15</secondaryMailServerPort>
<secondaryMailServerUserName>String value</secondaryMailServerUserName>
<toAddress>String value</toAddress>
</mailServerSettingsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v4/op/settings/notification/mailServer.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
"mailServerSettingsDTO" : [ {
"applyToAlarms" : true,
"fromAddress" : "String value",
"globalSubject" : "String value",
"primaryMailServerAddress" : "String value",
"primaryMailServerPassword" : "String value",
"primaryMailServerPort" : 15,
"primaryMailServerUserName" : "String value",
"secondaryMailServerAddress" : "String value",
"secondaryMailServerPassword" : "String value",
"secondaryMailServerPort" : 15,
"secondaryMailServerUserName" : "String value",
"toAddress" : "String value"
} ]
}
}