Get Syslog servers

Request syntax

Path parameters

ipAddress (string)

The IPv4 address or DNS hostname of the Syslog server. This must match the address used when the server was registered with the library.

Examples

Example retrieving all Syslog servers:

> 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"]
  }, {
    "address": "syslog.example.com",
    "port": 514,
    "subscribed": ["error"]
  }
]

Example retrieving a specific Syslog server by DNS hostname:

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

Attributes

ipAddress (string)

The IPv4 address or DNS hostname of the Syslog server. DNS hostnames are returned exactly as they were configured, maintaining the original format (e.g., syslog.example.com).

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.