Notification

Retrieve system notification settings

get

Retrieve details of system notification settings.

Authorizations
Responses
200

OK

application/json
get
/admin/notification
GET /api/admin/notification HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "SMTP",
  "server": "text",
  "port": 80,
  "reply_to": "text",
  "username": "text",
  "auth": "AUTO",
  "enable_tls_ssl": true,
  "enable_starttls_auto": true,
  "recipients": "text",
  "enable_tenant_access": true,
  "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

post

Update system notification settings.

Authorizations
Body
typestring · enumRequired

The email server type.
Can be either:

  • SMTP: Use generic SMTP server.
  • MS365 Use Microsoft 365 email service.
  • GMAIL Use Google Gmail service.
Possible values:
serverstringOptional

SMTP server used for sending mails.

portinteger · int32 · max: 65535Optional

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_tostringOptional

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 · max: 128Required

Username or email address.

passwordstringOptional

Password for email account.

authstring · enumOptional

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.
Default: AUTOPossible values:
enable_tls_sslbooleanOptional

Whether to enable TLS/SSL.

Default: true
enable_starttls_autobooleanOptional

Whether StartTLS is automatically enabled.

Default: true
recipientsstringOptional

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

enable_tenant_accessbooleanOptional

Apply the email server settings to all tenants.

Default: true
hard_disk_thresholdnumber · doubleOptional

The hard disk threshold for email warning.

Example: 0.9
notify_hard_disk_exceeded_thresholdbooleanOptional

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

Default: false
cpu_thresholdnumber · doubleOptional

The CPU threshold for email warning.

Example: 0.9
notify_cpu_exceeded_thresholdbooleanOptional

Send a notification email when specified CPU threshold is exceeded.

Default: false
memory_thresholdnumber · doubleOptional

The memory threshold for email warning.

Example: 0.9
notify_memory_exceeded_thresholdbooleanOptional

Send an email notification when specified memory threshold is exceeded.

Default: false
notify_ip_blockedbooleanOptional

Send a notification email when ip blocked.

Default: false
notify_license_limitedbooleanOptional

Send a notification email when license limit reached.

Default: false
notify_service_disconnectedbooleanOptional

Send a notification email when some service disconnected.

Default: false
notify_push_certs_update_failedbooleanOptional

Send a notification email when push notification certificates update failed.

Default: false
Responses
200

OK

No content
post
/admin/notification
POST /api/admin/notification HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "type": "SMTP",
  "server": "text",
  "port": 80,
  "reply_to": "text",
  "username": "text",
  "password": "text",
  "auth": "AUTO",
  "enable_tls_ssl": true,
  "enable_starttls_auto": true,
  "recipients": "text",
  "enable_tenant_access": true,
  "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
}
No content
PreviousSettingsNextTest email