Cisco Prime Infrastructure API
Prime Infrastructure 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

Resource URL

/webacs/api/v4/data/ConfigVersions

Updated

Since v4 version:
  • The deviceIpAddress attribute contains device IP address instead of device management address.
  • API uses a ConfigurationTag collection to represent tags.

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 IP address

deviceName String

Device host name

diffType ConfigVersionDiffEnum

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

Allowed values:

  • 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 Arrow image ConfigurationTag[]

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://localhost/webacs/api/v4/data/ConfigVersions/15

<?xml version="1.0" ?>
<queryResponse type="ConfigVersions" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/ConfigVersions/15" rootUrl="https://localhost/webacs/api/v4/data">
  <entity dtoType="configVersionsDTO" type="ConfigVersions" url="https://localhost/webacs/api/v4/data/ConfigVersions/15">
    <configVersionsDTO displayName="String value" id="15" uuid="String value">
      <comments>String value</comments>
      <createdAt>2019-04-26T17:18:41.452Z</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>
          <name>String value</name>
        </tag>
        <tag>
          <name>Another string value</name>
        </tag>
      </tags>
    </configVersionsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v4/data/ConfigVersions/15.json

{
  "queryResponse" : {
    "@type" : "ConfigVersions",
    "@requestUrl" : "https://localhost/webacs/api/v4/data/ConfigVersions/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "configVersionsDTO",
      "@type" : "ConfigVersions",
      "@url" : "https://localhost/webacs/api/v4/data/ConfigVersions/15",
      "configVersionsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "comments" : "String value",
        "createdAt" : "2019-04-26T17:18:41.452Z",
        "createdBy" : "String value",
        "deviceIpAddress" : "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,
        "tags" : {
          "tag" : [ {
            "name" : "String value"
          }, {
            "name" : "Another string value"
          } ]
        }
      }
    } ]
  }
}