Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET ConfigArchives

Configuration archive for device

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

Deprecated

This version has been deprecated. Please use v4.

Response Parameters

Attribute Description

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

instanceOrigin InstanceOriginEnum

Allowed values:

  • UNCONCERNED
  • APPLICATION
  • NETWORK

instanceTenantId Integer

This is a tenant id for this instance.

lastMessage String

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

lastSuccessful boolean

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

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

Sample JSON Payload

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

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