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

GET ConfigArchives

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Configuration archive for device

Since Product Version: 3.0

Resource URL

/webacs/api/v1/data/ConfigArchives

Response Parameters

Type Attribute Name Description

String

deviceIpAddress

Device IP address

String

deviceName

Device host name

String

instanceUuid

This is a uuid for this instance.

String

lastMessage

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

boolean

lastSuccessful

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://172.25.123.114/webacs/api/v1/data/ConfigArchives/15

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

Sample JSON Payload

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

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