POportsip
Administration

Retrieve system notification settings

Retrieve details of system notification settings.

get/admin/notification

Request

Response

OK

type'SMTP' | 'MS365' | 'GMAIL'

The email server type.
Can be either:

  • SMTP: Use generic SMTP server.
  • MS365 Use Microsoft 365 email service.
  • GMAIL Use Google Gmail service.
serverstring

SMTP server used for sending mails.

portinteger

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

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.

auth'DISABLE' | 'AUTO' | 'LOGIN' | 'PLAIN'

The authentication protocols.
Can be either:

  • DISABLE: Skip authentication mechanism.
  • AUTO: Use auto-selected authentication algorithms by server (Currently only supports LOGIN and PLAIN).
  • LOGIN: Use LOGIN authentication mechanism.
  • PLAIN Use PLAIN authentication mechanism.
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.

enable_tenant_accessboolean

Apply the email server settings to all tenants.

hard_disk_thresholdnumber double

The hard disk threshold for email warning.

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.

notify_cpu_exceeded_thresholdboolean

Send a notification email when specified CPU threshold is exceeded.

memory_thresholdnumber double

The memory threshold for email warning.

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.

Example response

{
  "port": 80,
  "hard_disk_threshold": 0.9,
  "cpu_threshold": 0.9,
  "memory_threshold": 0.9
}

Changes

No recorded changes to this operation across all 1 revision of this API.