Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET Syslogs

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 Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Aggregation?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v1/data/Syslogs

Deprecated

This version has been deprecated due to using not permanent IDs. Please use v3.

Response Parameters

Attribute Description

description String

Free form description of syslog.

deviceIpAddress String

IP address that is the source of the syslog.

deviceName String

Name of the device that is the source of the syslog.

deviceTimestamp Date

Specifies the device clock time when this syslog was created.

facility String

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.

mnemonics String

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

severity Integer

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

timestamp Date

Timestamp when the syslog was received.

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://localhost/webacs/api/v1/data/Syslogs/15

<?xml version="1.0" ?>
<queryResponse type="Syslogs" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/Syslogs/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="syslogsDTO" type="Syslogs" url="https://localhost/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>2017-11-22T16:16:12.983Z</deviceTimestamp>
      <facility>String value</facility>
      <mnemonics>String value</mnemonics>
      <severity>15</severity>
      <timestamp>2017-11-22T16:16:12.983Z</timestamp>
    </syslogsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@type" : "Syslogs",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Syslogs\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "syslogsDTO",
      "@type" : "Syslogs",
      "@url" : "https : \/\/localhost\/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" : "2017-11-22T16 : 16 : 12.983Z",
        "facility" : "String value",
        "mnemonics" : "String value",
        "severity" : 15,
        "timestamp" : "2017-11-22T16 : 16 : 12.983Z"
      }
    }
  }
}