Notification

Retrieve system notification settings

Retrieve details of system notification settings.

GEThttp://127.0.0.1:8888/api/admin/notification

Response

Body

serverstring

SMTP server used for sending mails.

portinteger (int32)

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

reply_tostring

A Reply-To address is identified by inserting the Reply-To header in your email.
It is the email address that the reply message is sent when you want the reply to go to an email address that is different than the From: address.

usernamestring

Username or email address.

authenum

The authorization protocols.
Can be either:

LOGIN: Use LOGIN authorization protocol.
PLAIN Use PLAIN authorization protocol.

LOGINPLAIN

enable_tls_sslboolean

Whether to enable TLS/SSL.

enable_starttls_autoboolean

Whether StartTLS is automatically enabled.

recipientsstring

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

hard_disk_thresholdnumber (double)

The hard disk threshold for email warning.

Example: 0.9

notify_hard_disk_exceeded_thresholdboolean

Send a notification email when specified hard disk threshold is exceeded.

cpu_thresholdnumber (double)

The CPU threshold for email warning.

Example: 0.9

notify_cpu_exceeded_thresholdboolean

Send a notification email when specified CPU threshold is exceeded.

memory_thresholdnumber (double)

The memory threshold for email warning.

Example: 0.9

notify_memory_exceeded_thresholdboolean

Send an email notification when specified memory threshold is exceeded.

notify_ip_blockedboolean

Send a notification email when ip blocked.

notify_license_limitedboolean

Send a notification email when license limit reached.

notify_service_disconnectedboolean

Send a notification email when some service disconnected.

notify_push_certs_update_failedboolean

Send a notification email when push notification certificates update failed.

Request

const response = await fetch('http://127.0.0.1:8888/api/admin/notification', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "server": "text",
  "port": 80,
  "reply_to": "text",
  "username": "text",
  "auth": "LOGIN",
  "enable_tls_ssl": true,
  "enable_starttls_auto": true,
  "recipients": "text",
  "hard_disk_threshold": 0.9,
  "notify_hard_disk_exceeded_threshold": false,
  "cpu_threshold": 0.9,
  "notify_cpu_exceeded_threshold": false,
  "memory_threshold": 0.9,
  "notify_memory_exceeded_threshold": false,
  "notify_ip_blocked": false,
  "notify_license_limited": false,
  "notify_service_disconnected": false,
  "notify_push_certs_update_failed": false
}

Update system notification settings

Update system notification settings.

POSThttp://127.0.0.1:8888/api/admin/notification

Body

serverstring

SMTP server used for sending mails.

portinteger (int32)

Example: 80

reply_tostring

usernamestring

Username or email address.

passwordstring

Password for email account.

authenum

The authorization protocols.
Can be either:

LOGIN: Use LOGIN authorization protocol.
PLAIN Use PLAIN authorization protocol.

LOGINPLAIN

enable_tls_sslboolean

Whether to enable TLS/SSL.

enable_starttls_autoboolean

Whether StartTLS is automatically enabled.

recipientsstring

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

hard_disk_thresholdnumber (double)

The hard disk threshold for email warning.

Example: 0.9

notify_hard_disk_exceeded_thresholdboolean

Send a notification email when specified hard disk threshold is exceeded.

cpu_thresholdnumber (double)

The CPU threshold for email warning.

Example: 0.9

notify_cpu_exceeded_thresholdboolean

Send a notification email when specified CPU threshold is exceeded.

memory_thresholdnumber (double)

The memory threshold for email warning.

Example: 0.9

notify_memory_exceeded_thresholdboolean

Send an email notification when specified memory threshold is exceeded.

notify_ip_blockedboolean

Send a notification email when ip blocked.

notify_license_limitedboolean

Send a notification email when license limit reached.

notify_service_disconnectedboolean

Send a notification email when some service disconnected.

notify_push_certs_update_failedboolean

Send a notification email when push notification certificates update failed.

Response

Request

const response = await fetch('http://127.0.0.1:8888/api/admin/notification', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

PreviousSettings NextTemplates

{ "server": "text", "port": 80, "reply_to": "text", "username": "text", "auth": "LOGIN", "enable_tls_ssl": true, "enable_starttls_auto": true, "recipients": "text", "hard_disk_threshold": 0.9, "notify_hard_disk_exceeded_threshold": false, "cpu_threshold": 0.9, "notify_cpu_exceeded_threshold": false, "memory_threshold": 0.9, "notify_memory_exceeded_threshold": false, "notify_ip_blocked": false, "notify_license_limited": false, "notify_service_disconnected": false, "notify_push_certs_update_failed": false }

const response = await fetch('http://127.0.0.1:8888/api/admin/notification', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();