Devices - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Devices","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/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":"devices","tags":["Devices"],"summary":"Devices","deprecated":false,"description":"Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services.","parameters":[{"name":"deviceRole","description":"CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, or AP (case insensitive)","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteId","description":"DNAC site UUID","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"health","description":"DNAC health catagory: POOR, FAIR, or GOOD (case insensitive)","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"startTime","description":"UTC epoch time in milliseconds","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"UTC epoch time in milliseconds","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Max number of device entries in the response (default to 50. Max at 500)","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"offset","description":"The offset of the first device in the returned data (Mutiple of 'limit' + 1)","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":"object","properties":{"version":{"type":"string","description":"Response data's version string"},"totalCount":{"type":"integer","description":"Total number of devices"},"response":{"type":"array","items":{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type"},"cpuUtilization":{"type":"number","description":"Device's CPU utilization"},"overallHealth":{"type":"integer","description":"Overall health score"},"utilizationHealth":{"type":"object","properties":{"radio0":{"type":"integer","description":""},"radio1":{"type":"integer","description":""},"radio2":{"type":"integer","description":""},"radio3":{"type":"integer","description":""},"Ghz24":{"type":"integer","description":""},"Ghz50":{"type":"integer","description":""}},"description":"Utilization (AP) per radio. (Property name format radio\u003cslotNumber\u003e)"},"airQualityHealth":{"type":"object","properties":{"radio0":{"type":"integer","description":""},"radio1":{"type":"integer","description":""},"radio2":{"type":"integer","description":""},"radio3":{"type":"integer","description":""},"Ghz24":{"type":"integer","description":""},"Ghz50":{"type":"integer","description":""}},"description":"WIFI air quaulify per radio. (Property name format radio\u003cslotNumber\u003e)"},"ipAddress":{"type":"string","description":"Management IP address of the device"},"cpuHealth":{"type":"integer","description":"Device CPU health score"},"deviceFamily":{"type":"string","description":"Device family"},"issueCount":{"type":"integer","description":"Number of issues"},"macAddress":{"type":"string","description":"MAC address of the device"},"noiseHealth":{"type":"object","properties":{"radio0":{"type":"integer","description":""},"radio1":{"type":"integer","description":""},"radio2":{"type":"integer","description":""},"radio3":{"type":"integer","description":""},"Ghz24":{"type":"integer","description":""},"Ghz50":{"type":"integer","description":""}},"description":"WIFI noise per radio. (Property name format radio\u003cslotNumber\u003e)"},"osVersion":{"type":"string","description":"Device OS version string"},"name":{"type":"string","description":"Device name"},"interfaceLinkErrHealth":{"type":"integer","description":"Device (AP) error health score"},"memoryUtilization":{"type":"number","description":"Device memory utilization"},"interDeviceLinkAvailHealth":{"type":"integer","description":"Device connectivity status"},"interferenceHealth":{"type":"object","properties":{"radio0":{"type":"integer","description":""},"radio1":{"type":"integer","description":""},"radio2":{"type":"integer","description":""},"radio3":{"type":"integer","description":""},"Ghz24":{"type":"integer","description":""},"Ghz50":{"type":"integer","description":""}},"description":"WIFI Interference per radio. (Property name format radio\u003cslotNumber\u003e)"},"model":{"type":"string","description":"Device model string"},"location":{"type":"string","description":"Site location in which this device is assigned to"},"reachabilityHealth":{"type":"string","description":"Device reachability in the network"},"band":{"type":"object","properties":{"radio0":{"type":"string","description":""},"radio1":{"type":"string","description":""},"radio2":{"type":"string","description":""},"radio3":{"type":"integer","description":""}},"description":"WIFI band per radio. (Property name format radio\u003cslotNumber\u003e)"},"memoryUtilizationHealth":{"type":"integer","description":"Device memory utilization health score"},"clientCount":{"type":"object","properties":{"radio0":{"type":"integer","description":""},"radio1":{"type":"integer","description":""},"radio2":{"type":"integer","description":""},"radio3":{"type":"integer","description":""},"Ghz24":{"type":"integer","description":""},"Ghz50":{"type":"integer","description":""}},"description":"Client count per radio. (Property name format radio\u003cslotNumber\u003e)"},"avgTemperature":{"type":"number","description":"Average device (switch) temperature"},"maxTemperature":{"type":"number","description":"Max device (switch) temperature"},"interDeviceLinkAvailFabric":{"type":"integer","description":"Device uplink health"},"apCount":{"type":"integer","description":"Number of AP count"},"freeTimerScore":{"type":"integer","description":"Device free timer health score"},"freeTimer":{"type":"string","description":"Device free timer"},"packetPoolHealth":{"type":"integer","description":"Device packet pool"},"packetPool":{"type":"integer","description":"Device packet pool"},"freeMemoryBufferHealth":{"type":"integer","description":"Device free memory buffer health"},"freeMemoryBuffer":{"type":"number","description":"Device free memory"},"wqePoolsHealth":{"type":"integer","description":"Device WQE pool health"},"wqePools":{"type":"number","description":"Device WQE pool"},"wanLinkUtilization":{"type":"number","description":"WLAN link utilization"},"cpuUlitilization":{"type":"number","description":"Device's CPU utilization"},"uuid":{"type":"string","description":"Device UUID"}}},"description":"List of device health data"}},"description":"Overall device health response","$$ref":"#/components/schemas/DevicesResponse"}}}},"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":"This user is forbidden to access this resource.","content":{}},"404":{"description":" The client made a request for a resource that does not exist.","content":{}},"500":{"description":" The server could not fulfill the request.","content":{}}},"x-rapi-id":"3ab2-bb64-4cca-81ee","x-rapi-overview":"Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/assurance/v1/intent/deviceHealth","x-rapi-publicPath":"/dna/intent/api/v1/device-health","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"20~MINUTE","__originalOperationId":"devices","method":"get","path":"/dna/intent/api/v1/device-health"}}