{"type":"api","title":"Get configuration archive details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getConfigurationArchiveDetails","tags":["Configuration Archive"],"summary":"Get configuration archive details","deprecated":false,"description":"Returns the historical device configurations (running configuration , startup configuration , vlan if applicable) by specified criteria","parameters":[{"name":"deviceId","description":"comma separated device id for example cf35b0a1-407f-412f-b2f4-f0c3156695f9,aaa38191-0c22-4158-befd-779a09d7cec1 . if device id is not provided it will fetch for all devices","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"fileType","description":"Config File Type can be RUNNINGCONFIG or STARTUPCONFIG","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"createdTime","description":"Supported with logical filters GT,GTE,LT,LTE & BT : time in milliseconds (epoc format)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"createdBy","description":"Comma separated values for createdBy - SCHEDULED, USER, CONFIG_CHANGE_EVENT, SCHEDULED_FIRST_TIME, DR_CALL_BACK, PRE_DEPLOY","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"offset","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"The number of records to be retrieved defaults to 500 if not specified, with a maximum allowed limit of 500.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string","description":"IP address of the device."},"deviceId":{"type":"string","description":"UUID of the device."},"versions":{"type":"array","items":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"fileType":{"type":"string","description":"Type of configuration file (RUNNINGCONFIG, STARTUPCONFIG, or VLAN)."},"fileId":{"type":"string","description":"Unique file ID."},"downloadPath":{"type":"string","description":"File download path (deprecated)."}}},"description":"Individual file information in the archive."},"createdBy":{"type":"string","description":"Reason for archive collection (CONFIG_CHANGE_EVENT - Syslog event based colletion, SCHEDULED - Weekly scheduled collection, SCHEDULED_FIRST_TIME-First Time Managed collection,DR_CALL_BACK- Post Disaster Recovery collection, USER- On Demand Trigger, PRE_DEPLOY- Predeploy collection) "},"configChangeType":{"type":"string","description":"Source of configuration change (OUT_OF_BAND - Change was made outside Catalyst Center, IN_BAND - Change was made from Catalyst Center, NOT_APPLICABLE - System Triggered)"},"syslogConfigEventDto":{"type":"array","items":{"type":"object","properties":{"userName":{"type":"string","description":"Name of the user who made the configuration change (if available in Syslog)."},"deviceUuid":{"type":"string","description":"UUID of the device as recieved in syslog. "},"outOfBand":{"type":"boolean","description":"True if configuration changes were made from outside of the Catalist Center. False otherwise."},"configMethod":{"type":"string","description":"Connection mode used to do the changes pn the device (if available in Syslog)."},"terminalName":{"type":"string","description":"Name of the terminal used to make changes on the device (if available in Syslog)."},"loginIpAddress":{"type":"string","description":"IP address from which the configuration changes were made (if available in Syslog)."},"processName":{"type":"string","description":"Name of the process that made configuration change (only available when configuration got changed by a program such as YANG suite )"},"syslogTime":{"type":"number","description":"Time of configuration change as recorded in the syslog."}}},"description":"Latest syslog data when archive collected due to CONFIG_CHANGE_EVENT. Otherwise this will be null."},"createdTime":{"type":"number","description":"Source of configuration change (OUT_OF_BAND - Change was made outside Catalyst Center, IN_BAND - Change was made from Catalyst Center, NOT_APPLICABLE - System Triggered)"},"startupRunningStatus":{"type":"string","description":"Sync status of running and startup configurations (IN_SYNC - if both startup and running config are same excluding dynamic configurations, OUT_OF_SYNC - otherwise). "},"id":{"type":"string","description":"Unique version ID."},"tags":{"type":"array","items":{"type":"string"},"description":"Labels added to a configuration version."},"lastUpdatedTime":{"type":"number","description":"Latest time stamp when the collected configuration is verified to be running on the device. LastUpdatedTime and createdTime will differ when verified configs are the same."}}},"description":"List of configuration archives saved for the device."},"deviceName":{"type":"string","description":"Hostname of the device."}}},"description":"Archive data results. One entry per device.","$$ref":"#/components/schemas/GetConfigurationArchiveDetailsResponse"}}}},"204":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"3bba-48a9-422a-be1e","x-rapi-overview":"Returns the historical device configurations (running configuration , startup configuration , vlan if applicable) by specified criteria","x-rapi-domain":"Site Management","x-rapi-subdomain":"Configuration Archive","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/network-device-archive","x-rapi-publicPath":"/dna/intent/api/v1/network-device-config","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"__originalOperationId":"getConfigurationArchiveDetails","method":"get","path":"/dna/intent/api/v1/network-device-config"}}