Download local configuration file
GET/local-config/download
Downloads a specific local configuration file for a device.
Purpose:
- Retrieve the actual XML configuration file pushed to a device
- Download configuration for backup or review purposes
- Access specific configuration versions from history
Process:
- Queries the database for the specified device and version
- Retrieves the base64-encoded configuration
- Decodes and returns it as an XML file download
- File is downloaded with name:
local-config-{device}-{version}.xml
Request
Responses
- 200
- 400
- 404
- 500
- default
Success - Configuration file downloaded successfully.
Response Type: Binary file download (XML)
Content-Type: application/octet-stream
Filename: local-config-{device}-{version}.xml
Response Headers
Content-Disposition
Attachment header specifying the downloaded filename
Content-Type
MIME type of the downloaded file
Bad Request - Missing required query parameters.
Common Causes:
- Missing
deviceparameter - Missing
versionparameter
Not Found - Configuration not found for the specified device and version.
Common Causes:
- Invalid version ID for the device
- Device configuration has been deleted
- Database record doesn't exist
Internal Server Error - Database query error, parsing error, or decoding error.
Common Causes:
- Database connectivity issues
- Invalid JSON response from database service
- Missing
local_cfgfield in database response - Invalid base64 encoding in stored configuration
- Failed to decode base64 content
General Errors