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

GET ConfigArchives

Configuration archive for device

Since Product Version: 3.0

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/data/ConfigArchives

Updated

Since version 4 the deviceIpAddress attribute contains device IP address instead of device management address.

Response Parameters

Attribute Description

deviceIpAddress String

Device IP address

deviceName String

Device host name

lastMessage String

Contains error message, If last collection of configuration files was failed

lastSuccessful boolean

Result of the last collection of configuration files

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.80.159/webacs/api/v4/data/ConfigArchives/15

<?xml version="1.0" ?>
<queryResponse type="ConfigArchives" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v4/data/ConfigArchives/15" rootUrl="https://10.64.80.159/webacs/api/v4/data">
  <entity dtoType="configArchivesDTO" type="ConfigArchives" url="https://10.64.80.159/webacs/api/v4/data/ConfigArchives/15">
    <configArchivesDTO displayName="String value" id="15" uuid="String value">
      <deviceName>String value</deviceName>
      <lastMessage>String value</lastMessage>
      <lastSuccessful>true</lastSuccessful>
      <deviceIpAddress>String value</deviceIpAddress>
    </configArchivesDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://10.64.80.159/webacs/api/v4/data/ConfigArchives/15.json

{
  "queryResponse" : {
    "@type" : "ConfigArchives",
    "@requestUrl" : "https://10.64.80.159/webacs/api/v4/data/ConfigArchives/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://10.64.80.159/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "configArchivesDTO",
      "@type" : "ConfigArchives",
      "@url" : "https://10.64.80.159/webacs/api/v4/data/ConfigArchives/15",
      "configArchivesDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "deviceIpAddress" : "String value",
        "deviceName" : "String value",
        "lastMessage" : "String value",
        "lastSuccessful" : true
      }
    } ]
  }
}