Configuration archive for device
Since Product Version: 3.0
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/v3/data/ConfigArchives UnmodifiedThis resource has not been modified since the previous API version.
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 |
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/v3/data/ConfigArchives/15
<?xml version="1.0" ?>
<queryResponse type="ConfigArchives" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/ConfigArchives/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="configArchivesDTO" type="ConfigArchives" url="https://localhost/webacs/api/v3/data/ConfigArchives/15">
<configArchivesDTO displayName="String value" id="15" uuid="String value">
<deviceIpAddress>String value</deviceIpAddress>
<deviceName>String value</deviceName>
<lastMessage>String value</lastMessage>
<lastSuccessful>true</lastSuccessful>
</configArchivesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/ConfigArchives/15.json
{
"queryResponse" : {
"@type" : "ConfigArchives",
"@requestUrl" : "https://localhost/webacs/api/v3/data/ConfigArchives/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "configArchivesDTO",
"@type" : "ConfigArchives",
"@url" : "https://localhost/webacs/api/v3/data/ConfigArchives/15",
"configArchivesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"deviceIpAddress" : "String value",
"deviceName" : "String value",
"lastMessage" : "String value",
"lastSuccessful" : true
}
} ]
}
}