Get Syslog servers

Returns the list of Syslog servers that are registered with the library to receive Syslog notifications.

Request syntax

GET /v1/notification/syslog/servers
Returns the list of Syslog servers that are registered with the library to receive Syslog notifications and their current settings.

GET /v1/notification/syslog/servers/{ipAddress}
Returns the list of Syslog servers for a specified IP address or host name.

Path parameters

ipAddress (string)

The IPv4 address or host name of the Syslog server.

Example

> GET /v1/notification/syslog/servers
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992
[
  {
    "address": "192.168.0.13",
    "port": 514,
    "subscribed": ["information", "warning", "error"]
  }, {
       ...
     }
 ]

Attributes

ipAddress (string)

The IPv4 address or host name of the Syslog server.

port (number)

The port number of the syslog server. The standard Syslog port is 514.

subscribed (array of strings)

A list of event severities that specify which events will be sent to this Syslog server. This list includes the following possible strings: error, warning, or information.