Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET BulkSanitizedConfigArchives

Intended to bulk export of sanitized configuration files from archive. This API resource does not support filtering and sorting on configuration files content.

Since Product Version: 3.1

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v1/data/BulkSanitizedConfigArchives

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

deviceId long

Unique identifier of device entity

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

displayName String

This is the displayName for this instance.

files BulkConfigArchiveFile[]

Configuration files

instanceUuid String

This is a uuid for this instance.

isFirst boolean

Indicates that current version is the first collected version of configuration files

isLast boolean

Indicates that current version is the latest 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://localhost/webacs/api/v1/data/BulkSanitizedConfigArchives/15

<?xml version="1.0" ?>
<queryResponse type="BulkSanitizedConfigArchives" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/BulkSanitizedConfigArchives/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="bulkSanitizedConfigArchivesDTO" type="BulkSanitizedConfigArchives" url="https://localhost/webacs/api/v1/data/BulkSanitizedConfigArchives/15">
    <bulkSanitizedConfigArchivesDTO displayName="String value" id="15" uuid="String value">
      <comments>String value</comments>
      <createdAt>2017-07-13T13:21:08.434-07:00</createdAt>
      <createdBy>String value</createdBy>
      <deviceId>2</deviceId>
      <deviceIpAddress>String value</deviceIpAddress>
      <deviceName>String value</deviceName>
      <diffType>OUT_OF_SYNC</diffType>
      <files>
        <file>
          <data>String value</data>
          <fileState>RUNNINGCONFIG</fileState>
          <fileType>BINARY</fileType>
          <instanceId>2</instanceId>
        </file>
      </files>
      <isFirst>true</isFirst>
      <isLast>true</isLast>
      <outOfBand>true</outOfBand>
      <tags>
        <tag>String value</tag>
      </tags>
    </bulkSanitizedConfigArchivesDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v1/data/BulkSanitizedConfigArchives/15.json

{
  "queryResponse" : {
    "@type" : "BulkSanitizedConfigArchives",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/BulkSanitizedConfigArchives\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "bulkSanitizedConfigArchivesDTO",
      "@type" : "BulkSanitizedConfigArchives",
      "@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/BulkSanitizedConfigArchives\/15",
      "bulkSanitizedConfigArchivesDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "comments" : "String value",
        "createdAt" : "2017-07-13T13 : 21 : 08.434-07 : 00",
        "createdBy" : "String value",
        "deviceId" : 2,
        "deviceIpAddress" : "String value",
        "deviceName" : "String value",
        "diffType" : "OUT_OF_SYNC",
        "files" : {
          "file" : {
            "data" : "String value",
            "fileState" : "RUNNINGCONFIG",
            "fileType" : "BINARY",
            "instanceId" : 2
          }
        },
        "isFirst" : true,
        "isLast" : true,
        "outOfBand" : true,
        "tags" : {
          "tag" : "String value"
        }
      }
    }
  }
}