{"type":"api","title":"Applications","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/167ffeffb0ddb8dfdcd104d49c529945120bad81/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":"applications","tags":["Applications"],"summary":"Applications","deprecated":false,"description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address. For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints.","parameters":[{"name":"siteId","description":"Assurance site UUID value (Cannot be submitted together with deviceId and clientMac)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"deviceId","description":"Assurance device UUID value (Cannot be submitted together with siteId and clientMac)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"macAddress","description":"Client device's MAC address (Cannot be submitted together with siteId and deviceId)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"startTime","description":"Starting epoch time in milliseconds of time window","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"Ending epoch time in milliseconds of time window","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"applicationHealth","description":"Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"The offset of the first application in the returned data (optionally used with siteId only)","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"The max number of application entries in returned data [1, 1000] (optionally used with siteId only)","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"applicationName","description":"The name of the application to get information on","required":false,"schema":{"type":"string","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":"API version"},"totalCount":{"type":"integer","description":"Count of items in response"},"response":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Application name"},"health":{"type":"integer","description":"Health score"},"businessRelevance":{"type":"string","enum":["business-irrelevant","business-relevant","default"],"description":"Application's business relevance"},"trafficClass":{"type":"string","description":"Application's traffic class"},"usageBytes":{"type":"integer","description":"Usage amount in bytes"},"averageThroughput":{"type":"number","description":"Average throughput of application"},"packetLossPercent":{"type":"object","properties":{},"description":"Packet loss percentage for application"},"networkLatency":{"type":"object","properties":{},"description":"Network latency for application"},"jitter":{"type":"object","properties":{},"description":"Jitter for application"},"applicationServerLatency":{"type":"object","properties":{},"description":"Latency of application server"},"clientNetworkLatency":{"type":"object","properties":{},"description":"Latency of client network"},"serverNetworkLatency":{"type":"object","properties":{},"description":"Latency of server network"},"exporterIpAddress":{"type":"string","description":"Ip address of exporter device"},"exporterName":{"type":"string","description":"Name of exporter device"},"exporterUUID":{"type":"string","description":"UUID of exporter device"},"exporterFamily":{"type":"string","description":"Devices family of exporter device"},"clientName":{"type":"string","description":"Endpoint client name"},"clientIp":{"type":"string","description":"Endpoint client ip"},"location":{"type":"string","description":"Site location"},"operatingSystem":{"type":"string","description":"Endpoint's operating system"},"deviceType":{"type":"string","enum":["Wired","Wireless"],"description":"Type of device"},"clientMacAddress":{"type":"string","description":"Endpoint mac address"},"issueId":{"type":"string","description":"Id number of issue"},"issueName":{"type":"string","description":"Name of issue"},"application":{"type":"string","description":"Issue reltaed application"},"severity":{"type":"string","description":"Issue severity"},"summary":{"type":"string","description":"Issue summary"},"rootCause":{"type":"string","description":"Issue's root cause"},"timestamp":{"type":"integer","description":"Issue's timestamp"},"occurrences":{"type":"integer","description":"Issue occurrences"},"priority":{"type":"string","description":"Issue priority"}}},"description":""}},"description":"","$$ref":"#/components/schemas/ApplicationsResponse"}}}},"202":{"description":"The request has been accepted for execution.","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":{}},"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":"2db5-8a1f-4fea-9242","x-rapi-overview":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address. For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Applications","x-rapi-version":"1.0.0","x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"20~1","__originalOperationId":"applications","method":"get","path":"/dna/intent/api/v1/application-health"}}