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

# GET BulkUnsanitizedConfigArchives

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

Since Product Version: 3.1

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
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/BulkUnsanitizedConfigArchives

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

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
deviceId long | Unique identifier of device entity
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 Allowed values OUT_OF_SYNC IN_SYNC NOT_APPLICABLE
files BulkConfigArchiveFile[] | Configuration files
Attribute | Description
--- | ---
data String | Content of the configuration file
fileState ConfigFileStateEnum | Configuration file state Allowed values RUNNINGCONFIG STARTUPCONFIG VLAN MODULECONFIG DATABASE ADMINCONFIG
fileType ConfigFileTypeEnum | The content type of the configuration file Allowed values BINARY TEXT XML
instanceId long | Unique identifier for file entity
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://10.64.88.203/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15

    <?xml version="1.0" ?>
    <queryResponse type="BulkUnsanitizedConfigArchives" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="bulkUnsanitizedConfigArchivesDTO" type="BulkUnsanitizedConfigArchives" url="https://10.64.88.203/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15">
        <bulkUnsanitizedConfigArchivesDTO displayName="String value" id="15" uuid="String value">
          <comments>String value</comments>
          <createdAt>1986-07-24T00:00:00+05:30</createdAt>
          <createdBy>String value</createdBy>
          <deviceId>2</deviceId>
          <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>
            <file>
              <data>Another string value</data>
              <fileState>STARTUPCONFIG</fileState>
              <fileType>TEXT</fileType>
              <instanceId>12</instanceId>
            </file>
          </files>
          <isFirst>true</isFirst>
          <isLast>true</isLast>
          <outOfBand>true</outOfBand>
          <deviceIpAddress>String value</deviceIpAddress>
          <tags>
            <tag>String value</tag>
            <tag>Another string value</tag>
          </tags>
        </bulkUnsanitizedConfigArchivesDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15.json

    {
      "queryResponse" : {
        "@type" : "BulkUnsanitizedConfigArchives",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "bulkUnsanitizedConfigArchivesDTO",
          "@type" : "BulkUnsanitizedConfigArchives",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15",
          "bulkUnsanitizedConfigArchivesDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "comments" : "String value",
            "createdAt" : "1986-07-24T00 : 00 : 00+05 : 30",
            "createdBy" : "String value",
            "deviceId" : 2,
            "deviceName" : "String value",
            "diffType" : "OUT_OF_SYNC",
            "files" : {
              "file" : [{
                "data" : "String value",
                "fileState" : "RUNNINGCONFIG",
                "fileType" : "BINARY",
                "instanceId" : 2
              },
              {
                "data" : "Another string value",
                "fileState" : "STARTUPCONFIG",
                "fileType" : "TEXT",
                "instanceId" : 12
              }]
            },
            "isFirst" : true,
            "isLast" : true,
            "outOfBand" : true,
            "deviceIpAddress" : "String value",
            "tags" : {
              "tag" : ["String value",
              "Another string value"]
            }
          }
        }
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/BulkUnsanitizedConfigArchives

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Unmodified

This resource has not been modified since the previous API version.

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
deviceId long | Unique identifier of device entity
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 Allowed values OUT_OF_SYNC IN_SYNC NOT_APPLICABLE
files BulkConfigArchiveFile[] | Configuration files
Attribute | Description
--- | ---
data String | Content of the configuration file
fileState ConfigFileStateEnum | Configuration file state Allowed values RUNNINGCONFIG STARTUPCONFIG VLAN MODULECONFIG DATABASE ADMINCONFIG
fileType ConfigFileTypeEnum | The content type of the configuration file Allowed values BINARY TEXT XML
instanceId long | Unique identifier for file entity
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://10.64.88.203/webacs/api/v2/data/BulkUnsanitizedConfigArchives/15

    <?xml version="1.0" ?>
    <queryResponse type="BulkUnsanitizedConfigArchives" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/BulkUnsanitizedConfigArchives/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="bulkUnsanitizedConfigArchivesDTO" type="BulkUnsanitizedConfigArchives" url="https://10.64.88.203/webacs/api/v2/data/BulkUnsanitizedConfigArchives/15">
        <bulkUnsanitizedConfigArchivesDTO displayName="String value" id="15" uuid="String value">
          <comments>String value</comments>
          <createdAt>1986-07-24T00:00:00+05:30</createdAt>
          <createdBy>String value</createdBy>
          <deviceId>2</deviceId>
          <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>
            <file>
              <data>Another string value</data>
              <fileState>STARTUPCONFIG</fileState>
              <fileType>TEXT</fileType>
              <instanceId>12</instanceId>
            </file>
          </files>
          <isFirst>true</isFirst>
          <isLast>true</isLast>
          <outOfBand>true</outOfBand>
          <deviceIpAddress>String value</deviceIpAddress>
          <tags>
            <tag>String value</tag>
            <tag>Another string value</tag>
          </tags>
        </bulkUnsanitizedConfigArchivesDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/BulkUnsanitizedConfigArchives/15.json

    {
      "queryResponse" : {
        "@type" : "BulkUnsanitizedConfigArchives",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/BulkUnsanitizedConfigArchives/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "bulkUnsanitizedConfigArchivesDTO",
          "@type" : "BulkUnsanitizedConfigArchives",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/BulkUnsanitizedConfigArchives/15",
          "bulkUnsanitizedConfigArchivesDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "comments" : "String value",
            "createdAt" : 522527400000,
            "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
              }, {
                "data" : "Another string value",
                "fileState" : "STARTUPCONFIG",
                "fileType" : "TEXT",
                "instanceId" : 12
              } ]
            },
            "isFirst" : true,
            "isLast" : true,
            "outOfBand" : true,
            "tags" : {
              "tag" : [ "String value", "Another string value" ]
            }
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/BulkUnsanitizedConfigArchives

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Unmodified

This resource has not been modified since the previous API version.

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
deviceId long | Unique identifier of device entity
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 Allowed values OUT_OF_SYNC IN_SYNC NOT_APPLICABLE
files BulkConfigArchiveFile[] | Configuration files
Attribute | Description
--- | ---
data String | Content of the configuration file
fileState ConfigFileStateEnum | Configuration file state Allowed values RUNNINGCONFIG STARTUPCONFIG VLAN MODULECONFIG DATABASE ADMINCONFIG
fileType ConfigFileTypeEnum | The content type of the configuration file Allowed values BINARY TEXT XML
instanceId long | Unique identifier for file entity
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://10.64.88.203/webacs/api/v3/data/BulkUnsanitizedConfigArchives/15

    <?xml version="1.0" ?>
    <queryResponse type="BulkUnsanitizedConfigArchives" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/BulkUnsanitizedConfigArchives/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="bulkUnsanitizedConfigArchivesDTO" type="BulkUnsanitizedConfigArchives" url="https://10.64.88.203/webacs/api/v3/data/BulkUnsanitizedConfigArchives/15">
        <bulkUnsanitizedConfigArchivesDTO displayName="String value" id="15" uuid="String value">
          <comments>String value</comments>
          <createdAt>1986-07-24T00:00:00+05:30</createdAt>
          <createdBy>String value</createdBy>
          <deviceId>2</deviceId>
          <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>
            <file>
              <data>Another string value</data>
              <fileState>STARTUPCONFIG</fileState>
              <fileType>TEXT</fileType>
              <instanceId>12</instanceId>
            </file>
          </files>
          <isFirst>true</isFirst>
          <isLast>true</isLast>
          <outOfBand>true</outOfBand>
          <deviceIpAddress>String value</deviceIpAddress>
          <tags>
            <tag>String value</tag>
            <tag>Another string value</tag>
          </tags>
        </bulkUnsanitizedConfigArchivesDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/BulkUnsanitizedConfigArchives/15.json

    {
      "queryResponse" : {
        "@type" : "BulkUnsanitizedConfigArchives",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/BulkUnsanitizedConfigArchives/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "bulkUnsanitizedConfigArchivesDTO",
          "@type" : "BulkUnsanitizedConfigArchives",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/BulkUnsanitizedConfigArchives/15",
          "bulkUnsanitizedConfigArchivesDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "comments" : "String value",
            "createdAt" : "1986-07-23T18:30:00.000Z",
            "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
              }, {
                "data" : "Another string value",
                "fileState" : "STARTUPCONFIG",
                "fileType" : "TEXT",
                "instanceId" : 12
              } ]
            },
            "isFirst" : true,
            "isLast" : true,
            "outOfBand" : true,
            "tags" : {
              "tag" : [ "String value", "Another string value" ]
            }
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/BulkUnsanitizedConfigArchives

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

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
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
files BulkConfigArchiveFile[] | Configuration files
Attribute | Description
--- | ---
data String | Content of the configuration file
fileState ConfigFileStateEnum | Configuration file state Allowed values RUNNINGCONFIG STARTUPCONFIG VLAN MODULECONFIG DATABASE ADMINCONFIG
fileType ConfigFileTypeEnum | The content type of the configuration file Allowed values BINARY TEXT XML
instanceId long | Unique identifier for file entity
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 ConfigurationTag[] | User's tags for the version
Attribute | Description
--- | ---
name String | Tag name

## 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.88.203/webacs/api/v4/data/BulkUnsanitizedConfigArchives/15

    <?xml version="1.0" ?>
    <queryResponse type="BulkUnsanitizedConfigArchives" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/BulkUnsanitizedConfigArchives/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="bulkUnsanitizedConfigArchivesDTO" type="BulkUnsanitizedConfigArchives" url="https://10.64.88.203/webacs/api/v4/data/BulkUnsanitizedConfigArchives/15">
        <bulkUnsanitizedConfigArchivesDTO displayName="String value" id="15" uuid="String value">
          <comments>String value</comments>
          <createdAt>1986-07-24T00:00:00+05:30</createdAt>
          <createdBy>String value</createdBy>
          <deviceId>2</deviceId>
          <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>
            <file>
              <data>Another string value</data>
              <fileState>STARTUPCONFIG</fileState>
              <fileType>TEXT</fileType>
              <instanceId>12</instanceId>
            </file>
          </files>
          <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>
        </bulkUnsanitizedConfigArchivesDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/BulkUnsanitizedConfigArchives/15.json

    {
      "queryResponse" : {
        "@type" : "BulkUnsanitizedConfigArchives",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/BulkUnsanitizedConfigArchives/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "bulkUnsanitizedConfigArchivesDTO",
          "@type" : "BulkUnsanitizedConfigArchives",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/BulkUnsanitizedConfigArchives/15",
          "bulkUnsanitizedConfigArchivesDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "comments" : "String value",
            "createdAt" : "1986-07-23T18:30:00.000Z",
            "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
              }, {
                "data" : "Another string value",
                "fileState" : "STARTUPCONFIG",
                "fileType" : "TEXT",
                "instanceId" : 12
              } ]
            },
            "isFirst" : true,
            "isLast" : true,
            "outOfBand" : true,
            "tags" : {
              "tag" : [ {
                "name" : "String value"
              }, {
                "name" : "Another string value"
              } ]
            }
          }
        } ]
      }
    }