Get Syslog Server Status

This endpoint returns the details of a syslog server.

Responses

• 200
• 503

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• hostname string

  The hostname or the IP address of the syslog server.

• port int32

  Possible values: >= 1 and <= 65535

  The port on which the syslog server accepts the logs.

• enabled boolean

  Specifies if the syslog server is enabled or disabled

• secureMessaging boolean

  When false UDP port will be used, when true TLS encryption will be used to connect to Syslog Server. To upload Certificate Authority file it should be enabled.

• certificateAuthorityName string

  File name of the uploaded certificate authority file

• forwardToSyslog object

  Select the log types that you want to forward to the syslog server.

  alerts boolean

  Forward the system log for alerts to the server.

  audit boolean

  Forward the system log for audit trails to the server.

  events boolean

  Forward the system log for events to the server.

{
  "hostname": "string",
  "port": 0,
  "enabled": true,
  "secureMessaging": true,
  "certificateAuthorityName": "string",
  "forwardToSyslog": {
    "alerts": true,
    "audit": true,
    "events": true
  }
}

Service Unavailable

Loading...