
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager 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

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/data/Syslogs

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Deprecated

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

## 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. Note: The date has an incorrect UTC offset. Please see the FAQ for details.

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

    <?xml version="1.0" ?>
    <queryResponse type="Syslogs" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/Syslogs/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="syslogsDTO" type="Syslogs" url="https://10.64.88.203/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>1986-07-24T00:00:00+05:30</deviceTimestamp>
          <facility>String value</facility>
          <mnemonics>String value</mnemonics>
          <timestamp>1986-07-24T00:00:00+05:30</timestamp>
          <severity>15</severity>
        </syslogsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "Syslogs",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/Syslogs/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "syslogsDTO",
          "@type" : "Syslogs",
          "@url" : "https : //10.64.88.203/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" : "1986-07-24T00 : 00 : 00+05 : 30",
            "facility" : "String value",
            "mnemonics" : "String value",
            "timestamp" : "1986-07-24T00 : 00 : 00+05 : 30",
            "severity" : 15
          }
        }
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/Syslogs

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Unmodified

This resource has not been modified since the previous API version.

Deprecated

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

## 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. Note: The date has an incorrect UTC offset. Please see the FAQ for details.

## 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://10.64.88.203/webacs/api/v2/data/Syslogs/15

    <?xml version="1.0" ?>
    <queryResponse type="Syslogs" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/Syslogs/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="syslogsDTO" type="Syslogs" url="https://10.64.88.203/webacs/api/v2/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>1986-07-24T00:00:00+05:30</deviceTimestamp>
          <facility>String value</facility>
          <mnemonics>String value</mnemonics>
          <timestamp>1986-07-24T00:00:00+05:30</timestamp>
          <severity>15</severity>
        </syslogsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/Syslogs/15.json

    {
      "queryResponse" : {
        "@type" : "Syslogs",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/Syslogs/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "syslogsDTO",
          "@type" : "Syslogs",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/Syslogs/15",
          "syslogsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "description" : "String value",
            "deviceIpAddress" : "String value",
            "deviceName" : "String value",
            "deviceTimestamp" : 522527400000,
            "facility" : "String value",
            "mnemonics" : "String value",
            "severity" : 15,
            "timestamp" : 522527400000
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/Syslogs

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Updated

This resource has been updated since the previous API version. It may have changes that are not compatible with API clients written for previous API versions.

## 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. Note: The date has an incorrect UTC offset. Please see the FAQ for details.

## 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://10.64.88.203/webacs/api/v3/data/Syslogs/15

    <?xml version="1.0" ?>
    <queryResponse type="Syslogs" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/Syslogs/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="syslogsDTO" type="Syslogs" url="https://10.64.88.203/webacs/api/v3/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>1986-07-24T00:00:00+05:30</deviceTimestamp>
          <facility>String value</facility>
          <mnemonics>String value</mnemonics>
          <timestamp>1986-07-24T00:00:00+05:30</timestamp>
          <severity>15</severity>
        </syslogsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/Syslogs/15.json

    {
      "queryResponse" : {
        "@type" : "Syslogs",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/Syslogs/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "syslogsDTO",
          "@type" : "Syslogs",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/Syslogs/15",
          "syslogsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "description" : "String value",
            "deviceIpAddress" : "String value",
            "deviceName" : "String value",
            "deviceTimestamp" : "1986-07-23T18:30:00.000Z",
            "facility" : "String value",
            "mnemonics" : "String value",
            "severity" : 15,
            "timestamp" : "1986-07-23T18:30:00.000Z"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/Syslogs

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Updated

Since version 4 type of the severity attribute is SyslogSeverityEnum.

## 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 SyslogSeverityEnum | Defines the severity of the syslog. This API only supports Syslogs with severities EMERGENCY, ALERT and CRITICAL Allowed values EMERGENCY ALERT CRITICAL ERROR WARNING NOTICE INFORMATION DEBUG NONE
timestamp Date | Timestamp when the syslog was received. Note: The date has an incorrect UTC offset. Please see the FAQ for details.

## 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://10.64.88.203/webacs/api/v4/data/Syslogs/15

    <?xml version="1.0" ?>
    <queryResponse type="Syslogs" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/Syslogs/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="syslogsDTO" type="Syslogs" url="https://10.64.88.203/webacs/api/v4/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>1986-07-24T00:00:00+05:30</deviceTimestamp>
          <facility>String value</facility>
          <mnemonics>String value</mnemonics>
          <timestamp>1986-07-24T00:00:00+05:30</timestamp>
          <severity>EMERGENCY</severity>
        </syslogsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/Syslogs/15.json

    {
      "queryResponse" : {
        "@type" : "Syslogs",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/Syslogs/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "syslogsDTO",
          "@type" : "Syslogs",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/Syslogs/15",
          "syslogsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "description" : "String value",
            "deviceIpAddress" : "String value",
            "deviceName" : "String value",
            "deviceTimestamp" : "1986-07-23T18:30:00.000Z",
            "facility" : "String value",
            "mnemonics" : "String value",
            "severity" : "EMERGENCY",
            "timestamp" : "1986-07-23T18:30:00.000Z"
          }
        } ]
      }
    }