{"type":"model","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":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"siteName":{"type":"string","description":"Name of the site"},"siteId":{"type":"string","description":"Site UUID"},"parentSiteId":{"type":"string","description":"The parent site's UUID of this site"},"parentSiteName":{"type":"string","description":"The parent site's name of this site"},"siteType":{"type":"string","description":"Site type of this site"},"latitude":{"type":"number","description":"Site (building) location's latitude"},"longitude":{"type":"number","description":"Site (building) location's longitude"},"healthyNetworkDevicePercentage":{"type":"integer","description":"Network health of devices on the site"},"healthyClientsPercentage":{"type":"integer","description":"Client health of all clients in the site"},"clientHealthWired":{"type":"integer","description":"Health of all wired clients in the site"},"clientHealthWireless":{"type":"integer","description":"Health of all wireless clients in the site"},"numberOfClients":{"type":"integer","description":"Total number of clients in the site"},"numberOfNetworkDevice":{"type":"integer","description":"Total number of network devices in the site"},"networkHealthAverage":{"type":"integer","description":"Average network health in the site"},"networkHealthAccess":{"type":"integer","description":"Network health for access devices in the site"},"networkHealthCore":{"type":"integer","description":"Network health for core devices in the site"},"networkHealthDistribution":{"type":"integer","description":"Network health for distribution devices in the site"},"networkHealthRouter":{"type":"integer","description":"Network health for router devices in the site"},"networkHealthWireless":{"type":"integer","description":"Network health for wireless devices in the site"},"networkHealthAP":{"type":"integer","description":"Network health for AP devices in the site"},"networkHealthWLC":{"type":"integer","description":"Network health for WLC devices in the site"},"networkHealthSwitch":{"type":"integer","description":"Network health for switch devices in the site"},"networkHealthOthers":{"type":"integer","description":"Network health for other devices in the site"},"numberOfWiredClients":{"type":"integer","description":"Number of wired clients in the site"},"numberOfWirelessClients":{"type":"integer","description":"Number of wireless clients in the site"},"totalNumberOfConnectedWiredClients":{"type":"integer","description":"Number of connected wired clients in the site"},"totalNumberOfActiveWirelessClients":{"type":"integer","description":"Number of active wireless clients in the site"},"wiredGoodClients":{"type":"integer","description":"Number of GOOD health wired clients in the site"},"wirelessGoodClients":{"type":"integer","description":"Number of GOOD health wireless clients in the site"},"overallGoodDevices":{"type":"integer","description":"Number of GOOD health devices in the site"},"accessGoodCount":{"type":"integer","description":"Number of GOOD health access devices in the site"},"accessTotalCount":{"type":"integer","description":"Number of access devices in the site"},"coreGoodCount":{"type":"integer","description":"Number of GOOD health core devices in the site"},"coreTotalCount":{"type":"integer","description":"Number of core devices in the site"},"distributionGoodCount":{"type":"integer","description":"Number of GOOD health distribution devices in the site"},"distributionTotalCount":{"type":"integer","description":"Number of distribution devices in the site"},"routerGoodCount":{"type":"integer","description":"Number of GOOD health router in the site"},"routerTotalCount":{"type":"integer","description":"Number of router devices in the site"},"wirelessDeviceGoodCount":{"type":"integer","description":"Number of GOOD health wireless devices in the site"},"wirelessDeviceTotalCount":{"type":"integer","description":"Number of wireless devices in the site"},"apDeviceGoodCount":{"type":"integer","description":"Number of GOOD health AP devices in the site"},"apDeviceTotalCount":{"type":"integer","description":"Number of AP devices in the site"},"wlcDeviceGoodCount":{"type":"integer","description":"Number of GOOD health wireless controller devices in the site"},"wlcDeviceTotalCount":{"type":"integer","description":"Number of wireless controller devices in the site"},"switchDeviceGoodCount":{"type":"integer","description":"Number of GOOD health switch devices in the site"},"switchDeviceTotalCount":{"type":"integer","description":"Number of switch devices in the site"},"applicationHealth":{"type":"integer","description":"Average application health in the site"},"applicationHealthInfo":{"type":"array","items":{"type":"object","properties":{"trafficClass":{"type":"string","description":"Traffic class of the application"},"bytesCount":{"type":"number","description":"Byte count of the application"},"healthScore":{"type":"integer","description":"Health score of the application"}}},"description":"Application health in the site"},"applicationGoodCount":{"type":"integer","description":"Number of GOOD health applications int the site"},"applicationTotalCount":{"type":"integer","description":"Number of applications int the site"},"applicationBytesTotalCount":{"type":"number","description":"Total application bytes"},"dnacInfo":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID of the DNAC"},"ip":{"type":"string","description":"IP address of the DNAC"},"status":{"type":"string","description":"Status of the DNAC"}},"description":"DNAC information"},"usage":{"type":"number","description":"Total bits used by all clients in a site"},"applicationHealthStats":{"type":"object","properties":{"appTotalCount":{"type":"number","description":"Total application count"},"businessRelevantAppCount":{"type":"object","properties":{"poor":{"type":"number","description":"Poor business relevant application count"},"fair":{"type":"number","description":"Fair business relevant application count"},"good":{"type":"number","description":"Good business relevant application count"}},"description":""},"businessIrrelevantAppCount":{"type":"object","properties":{"poor":{"type":"number","description":"Poor business irrelevant application count"},"fair":{"type":"number","description":"Fair business irrelevant application count"},"good":{"type":"number","description":"Good business irrelevant application count"}},"description":""},"defaultHealthAppCount":{"type":"object","properties":{"poor":{"type":"number","description":"Poor default application count"},"fair":{"type":"number","description":"Fair default application count"},"good":{"type":"number","description":"Good default application count"}},"description":""}},"description":"Application health statistics"}}},"description":"Site health response data"}},"description":"Site health response","$$ref":"#/components/schemas/GetSiteHealthResponse","title":"GetSiteHealthResponse"}}