Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET Syslogs

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Represents the syslog view. Syslogs are standard method for logging messages such as system events in an IP network. This API only supports Syslogs with severities 0, 1, 2 (Emergency, Alert, Critical)

Since Product Version: 1.2

Resource URL

/webacs/api/v1/data/Syslogs

Response Parameters

Type Attribute Name Description

String

description

Free form description of syslog.

String

deviceIpAddress

IP address that is the source of the syslog.

String

deviceName

Date

deviceTimestamp

Specifies the device clock time when this syslog was created.

String

facility

Facility is one information field associated with a syslog message. It is defined by the syslog protocol. It provides a information relating to which part of a system the message originated from.

String

instanceUuid

This is a uuid for this instance.

String

mnemonics

This is a device-specific code that uniquely identifies the message.

Integer

severity

Defines the severity of the syslog: 0 - Emergency, 1 - Alert, 2 - Critical

Date

timestamp

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Payload

https://172.25.123.114/webacs/api/v1/data/Syslogs/15

<?xml version="1.0" ?>
<queryResponse type="Syslogs" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/Syslogs/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="syslogsDTO" type="Syslogs" url="https://172.25.123.114/webacs/api/v1/data/Syslogs/15">
    <syslogsDTO displayName="String value" id="15" uuid="String value">
      <description>String value</description>
      <deviceIpAddress>String value</deviceIpAddress>
      <deviceName>String value</deviceName>
      <deviceTimestamp>2020-07-28T20:28:19.148Z</deviceTimestamp>
      <facility>String value</facility>
      <mnemonics>String value</mnemonics>
      <severity>15</severity>
      <timestamp>2020-07-28T20:28:19.148Z</timestamp>
    </syslogsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.25.123.114/webacs/api/v1/data/Syslogs/15.json

{
  "queryResponse" : {
    "@type" : "Syslogs",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Syslogs\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "syslogsDTO",
      "@type" : "Syslogs",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Syslogs\/15",
      "syslogsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "description" : "String value",
        "deviceIpAddress" : "String value",
        "deviceName" : "String value",
        "deviceTimestamp" : "2020-07-28T20 : 28 : 19.148Z",
        "facility" : "String value",
        "mnemonics" : "String value",
        "severity" : 15,
        "timestamp" : "2020-07-28T20 : 28 : 19.148Z"
      }
    }
  }
}