API Guide

24. SYSLOG
Syslog messages received by NFC from switches
24.1 GET /syslogs/messages
Get Syslog Messages between start and end timestamp
Get all syslog messages between start and end timestamp
REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION
oid string
Object ID, if exists, acts as a lter
start-time int64
Start timestamp in epoch ms. The default value for start timestamp is set as (end-time -
24 hours)
end-time int64
End timestamp in epoch ms. The default value for end timestamp is set as current time.
max-
messages
integer
Max Number of Messages to Retrieve. By default, all messages between start and end
timestamps will be returned.
filter string
Matching phrase, accepts wildcards (*)
RESPONSE
STATUS CODE - 200: Response to get Syslog Events
RESPONSE MODEL - application/json
{
Get Syslog Events
data [{
Array of object: Object Event Logs
oid string
values [{
Array of object: Event Log Entry
timestamp integer
Timestamp of message
message string
Message
}]
}]
}
STATUS CODE - 401: You are not authorized to perform this operation.
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
285 of 340