Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_Syslogs

GET Syslogs

Resource Information

Rate Limiting?

 Yes

Sorting?

 Yes

Paging?

 Yes

Filtering?

 Yes

Response Formats

xml

json

HTTP Methods

GET

Represents the syslog view. Syslogs are standard method for logging messages such as system events in an IP network.

Resource URL

/webacs/api/v1/data/Syslogs

Since : 1.2

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

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

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, 3- Error, 4 - Warning, 5 - Notice, 6 - Informational, 7 - Debug

Date

timestamp

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://192.168.116.207/webacs/api/v1/data/Syslogs/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/Syslogs/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="syslogsDTO_$$_javassist_5216">
        <syslogsDTO id="15" displayName="String value">
            <description>String value</description>
            <deviceIpAddress>String value</deviceIpAddress>
            <deviceName>String value</deviceName>
            <facility>String value</facility>
            <mnemonics>String value</mnemonics>
            <severity>15</severity>
            <timestamp>2013-07-02T18:07:44.903-07:00</timestamp>
        </syslogsDTO>
    </entity>
</queryResponse>

Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/Syslogs/42.json

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/Syslogs\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "syslogsDTO_$$_javassist_5216",
      "syslogsDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "description" : "String value",
        "deviceIpAddress" : "String value",
        "deviceName" : "String value",
        "facility" : "String value",
        "mnemonics" : "String value",
        "severity" : 15,
        "timestamp" : "2013-07-02T18 : 07 : 44.904-07 : 00"
      }
    }
  }
}