Loading...

View the Details of a Syslog Server (REST API: GET)

This operation returns the details of a syslog server.

Request

Syntax

GET <webservice>/logmonitoring/Syslog/Status
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path that routes the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token that you receive after successfully logging on. For information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

hostname

The hostname or the IP address of the syslog server.

LogMonitoring_SyslogStatus

port

The port on which the syslog server accepts the logs.

LogMonitoring_SyslogStatus

enabled

The status of the syslog server.

Values are:

  • 0, disabled
  • 1, enabled

LogMonitoring_SyslogStatus

name

The type of logs.

Values are:

  • Alerts
  • Audit
  • Events

syslogPolicy

enabled

The status of a log type.

Values are:

  • 0, disabled
  • 1, enabled

syslogPolicy

Examples

Sample Request

This request returns the details of a syslog server.

GET <webservice>/ logmonitoring/Syslog/Status
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<LogMonitoring_SyslogStatus hostname="syslogserver" port="514" enabled="1">
  <syslogPolicy name="Alerts" enabled="0" />
  <syslogPolicy name="Audit" enabled="1" />
  <syslogPolicy name="Events" enabled="1" />
</LogMonitoring_SyslogStatus>

Last modified: 3/27/2020 11:44:56 AM