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

GET ConfigVersions

Represents information about the version of the configuration files

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

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/ConfigVersions

Deprecated

This version has been deprecated. Please use v4.

Response Parameters

Attribute Description

comments String

Comments from the system of configuration archive

createdAt Date

Date and time of creation

createdBy String

Initiator of creation

deviceIpAddress String

Device management address.

The management address is the address used to add the device to the managed inventory, either an IP address or hostname.

deviceName String

Device host name

diffType ConfigVersionDiffEnum

The result of comparison with the previous version of the configuration files

  • OUT_OF_SYNC
  • IN_SYNC
  • NOT_APPLICABLE

fileInfos Arrow image ConfigFileInfo[]

List of configuration file info

isFirst boolean

Indicates the first collected version of configuration files

isLast boolean

Indicates the last collected version of configuration files

outOfBand boolean

The out-of-band change flag

tags String[]

User's tags for the version

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.20.127.108/webacs/api/v1/data/ConfigVersions/15

<?xml version="1.0" ?>
<queryResponse type="ConfigVersions" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v1/data/ConfigVersions/15" rootUrl="https://172.20.127.108/webacs/api/v1/data">
  <entity dtoType="configVersionsDTO" type="ConfigVersions" url="https://172.20.127.108/webacs/api/v1/data/ConfigVersions/15">
    <configVersionsDTO displayName="String value" id="15" uuid="String value">
      <comments>String value</comments>
      <createdAt>1986-07-24T00:00:00Z</createdAt>
      <createdBy>String value</createdBy>
      <deviceName>String value</deviceName>
      <diffType>OUT_OF_SYNC</diffType>
      <fileInfos>
        <fileInfo>
          <fileId>2</fileId>
          <fileState>RUNNINGCONFIG</fileState>
          <fileType>BINARY</fileType>
        </fileInfo>
        <fileInfo>
          <fileId>12</fileId>
          <fileState>STARTUPCONFIG</fileState>
          <fileType>TEXT</fileType>
        </fileInfo>
      </fileInfos>
      <isFirst>true</isFirst>
      <isLast>true</isLast>
      <outOfBand>true</outOfBand>
      <deviceIpAddress>String value</deviceIpAddress>
      <tags>
        <tag>String value</tag>
        <tag>Another string value</tag>
      </tags>
    </configVersionsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.20.127.108/webacs/api/v1/data/ConfigVersions/15.json

{
  "queryResponse" : {
    "@type" : "ConfigVersions",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/ConfigVersions\/15",
    "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "configVersionsDTO",
      "@type" : "ConfigVersions",
      "@url" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/ConfigVersions\/15",
      "configVersionsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "comments" : "String value",
        "createdAt" : "1986-07-24T00 : 00 : 00Z",
        "createdBy" : "String value",
        "deviceName" : "String value",
        "diffType" : "OUT_OF_SYNC",
        "fileInfos" : {
          "fileInfo" : [{
            "fileId" : 2,
            "fileState" : "RUNNINGCONFIG",
            "fileType" : "BINARY"
          },
          {
            "fileId" : 12,
            "fileState" : "STARTUPCONFIG",
            "fileType" : "TEXT"
          }]
        },
        "isFirst" : true,
        "isLast" : true,
        "outOfBand" : true,
        "deviceIpAddress" : "String value",
        "tags" : {
          "tag" : ["String value",
          "Another string value"]
        }
      }
    }
  }
}