{"type":"api","title":"Get Device Interface Stats Info","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":"getDeviceInterfaceStatsInfo","tags":["Devices"],"deprecated":false,"summary":"Get Device Interface Stats Info","description":"This API returns the Interface Stats for the given Device Id. Please refer to the Feature tab for the Request Body usage and the API filtering support.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"deviceId","description":"Network Device Id","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"type":"integer","description":"UTC epoch timestamp in milliseconds"},"endTime":{"type":"integer","description":"UTC epoch timestamp in milliseconds"},"query":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object"},"description":"Required field names, default ALL"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Name of the field that the filter should be applied to"},"operator":{"type":"string","description":"Supported operators are eq,in,like"},"value":{"type":"string","description":"Value of the field"}}},"description":"Helps to define the filter condition"},"page":{"type":"object","properties":{"limit":{"type":"integer","description":"Number of records, Max is 1000"},"offset":{"type":"number","description":"Record offset value, default 0"},"orderBy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the field used to sort"},"order":{"type":"string","description":"Possible values asc, des"}}},"description":""}},"description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/GetDeviceInterfaceStatsInfoRequest"}}},"required":true},"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":""},"totalCount":{"type":"number","description":"The total count"},"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Interface Instance Id"},"values":{"type":"object","properties":{"adminStatus":{"type":"string","description":"The desired state of the interface"},"deviceId":{"type":"string","description":"Device Id"},"duplexConfig":{"type":"string","description":"Interface duplex config status"},"duplexOper":{"type":"string","description":"Interface duplex operational status"},"interfaceId":{"type":"string","description":"Interface ifIndex"},"interfaceType":{"type":"string","description":"Physical or Virtual type"},"instanceId":{"type":"string","description":"Interface InstanceId"},"ipv4Address":{"type":"string","description":"Interface IPV4 Address"},"ipv6AddressList":{"type":"array","items":{"type":"string"},"description":"List of interface IPV6 Address"},"isL3Interface":{"type":"string","description":"Interface is L3 or not"},"isWan":{"type":"string","description":"nterface is WAN link or not"},"macAddr":{"type":"string","description":"Interface MAC Address"},"mediaType":{"type":"string","description":"Interface media type"},"name":{"type":"string","description":"Name of the interface"},"operStatus":{"type":"string","description":"Interface operational status"},"peerStackMember":{"type":"string","description":"Interface peer stack member Id"},"peerStackPort":{"type":"string","description":"Interface peer stack member port"},"portChannelId":{"type":"string","description":"Interface Port-Channel Id"},"portMode":{"type":"string","description":"Interface Port Mode"},"portType":{"type":"string","description":"Interface ifType"},"description":{"type":"string","description":"Interface description"},"rxDiscards":{"type":"string","description":"Rx Discards in %"},"rxError":{"type":"string","description":"Rx Errors in %"},"rxRate":{"type":"string","description":"Rx rate in bps"},"rxUtilization":{"type":"string","description":"Rx Utilization in %"},"speed":{"type":"string","description":"Speed of the Interface in kbps"},"stackPortType":{"type":"string","description":"Interface stack port type. SVL or DAD"},"timestamp":{"type":"string","description":"Interface stats collected timestamp"},"txDiscards":{"type":"string","description":"Tx Discards in %"},"txError":{"type":"string","description":"Tx Errors in %"},"txRate":{"type":"string","description":"Tx Rate in bps"},"txUtilization":{"type":"string","description":"Tx Utilization in %"},"vlanId":{"type":"string","description":"Interface VLAN Id"}},"description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"number","description":""},"count":{"type":"integer","description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/GetDeviceInterfaceStatsInfoResponse"}}}},"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":"76bb-5957-49ab-8a3b","x-rapi-overview":"This API returns the Interface Stats for the given Device Id. Please refer to the Feature tab for the Request Body usage and the API filtering support.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/assurance/v2/networkDevices/${deviceId}/interfaces/query","x-rapi-publicPath":"/dna/intent/api/v2/networkDevices/${deviceId}/interfaces/query","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"500~MINUTE","__originalOperationId":"getDeviceInterfaceStatsInfo","method":"post","path":"/dna/intent/api/v2/networkDevices/{deviceId}/interfaces/query"}}