Gets interfaces along with statistics and poe data from all network devices - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Gets interfaces along with statistics and poe data from all network devices","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":"getsInterfacesAlongWithStatisticsAndPoeDataFromAllNetworkDevices_","tags":["Devices"],"summary":"Gets interfaces along with statistics and poe data from all network devices.","deprecated":false,"description":" Retrieves the list of the interfaces from all network devices based on\n the provided query parameters. The latest interfaces data in the\n specified start and end time range will be returned. When there is no\n start and end time specified returns the latest available data.\n \n \n The elements are grouped and sorted by deviceUuid first, and are then\n sorted by the given sort field, or by the default value: name.\n \n\n \n The supported sorting options are: \n\n name, adminStatus, description, duplexConfig, duplexOper,\n interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus,\n portChannelId, portMode, portType,speed, vlanId\n \n \n\n \n This API can paginate up to 500,000 records, please narrow matching results with additional filters beyond that value.\nThe elements are grouped and sorted by deviceUuid first, and are then sorted by the given sort field, or by the default value: name.\n\n The supported sorting options are: name, adminStatus, description, duplexConfig, duplexOper,interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus,portChannelId, portMode, portType,speed, vlanId,pdPowerAdminMaxInWatt,pdPowerBudgetInWatt,pdPowerConsumedInWatt,pdPowerRemainingInWatt,pdMaxPowerDrawn. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-interfaces-2.0.0-resolved.yaml","parameters":[{"name":"startTime","description":"Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n\nIf `startTime` is not provided, API will default to current time.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to return","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"offset","description":"Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"A field within the response to sort by.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"The sort order of the field ascending or descending.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchy","description":"The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named \"Global\" (Ex. `Global/AreaName/BuildingName/FloorName`)\n\nThis field supports wildcard asterisk (`*`) character search support. E.g. `*/San*, */San, /San*`\n\nExamples:\n\n`?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested)\n\n`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchyId","description":"The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`)\n\nThis field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*`\n\nExamples:\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested)\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteId","description":"The UUID of the site. (Ex. `flooruuid`)\n\nExamples:\n\n`?siteId=id1` (single id requested)\n\n`?siteId=id1&siteId=id2&siteId=id3` (multiple ids requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"view","description":"Views which are supported by this API. Each view represents a specific data set. ### Response data provided by each view: 1. **configuration** [id,name,adminStatus,description,duplexConfig,duplexOper,interfaceIfIndex,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,operStatus, portChannelId,portMode, portType,speed,timestamp,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] 2. **statistics** [id,name,rxDiscards,rxError,rxRate,rxUtilization,txDiscards,txError,txRate,txUtilization,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] 3. **stackPort** [id,name,peerStackMember,peerStackPort,stackPortType,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] 4. **poE** [id, name,rxDiscards,rxError,rxRate,rxUtilization,txDiscards,txError,txRate,txUtilization,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] When this query parameter is not added by default all configuration attributes will be available in the response. **[configuration,statistics,stackPort]**","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"attribute","description":"The following list of attributes can be provided in the attribute field [id,adminStatus, description,duplexConfig,duplexOper,interfaceIfIndex,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,operStatus,peerStackMember,peerStackPort, portChannelId,portMode, portType,rxDiscards,rxError,rxRate,rxUtilization,speed,stackPortType,timestamp,txDiscards,txError,txRate,txUtilization,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId,poeAdminStatus,poeOperStatus,chassisId,moduleId,pdClassSignal,pdClassSpare,pdDeviceType,pdDeviceModel,pdPowerAdminMaxInWatt,pdPowerBudgetInWatt,pdPowerConsumedInWatt,pdPowerRemainingInWatt,pdMaxPowerDrawn,pdConnectedDeviceList,poeOperPriority,fastPoEEnabled,perpetualPoEEnabled,policingPoEEnabled,upoePlusEnabled,fourPairEnabled,poeDataTimestamp,pdLocation,pdDeviceName,pdConnectedSwitch,connectedSwitchUuid,ieeeCompliant,connectedSwitchType] If length of attribute list is too long, please use 'views' param instead. Examples: attributes=name (single attribute requested) attributes=name&description&duplexOper (multiple attributes with comma separator)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceId","description":"The list of Network Device Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`)\n\nExamples:\n\n`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c` (single networkDeviceId requested)\n\n`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0` (multiple networkDeviceIds with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceIpAddress","description":"The list of Network Device management IP Address. (Ex. `121.1.1.10`)\n\nThis field supports wildcard (`*`) character-based search. \nEx: `*1.1*` or `1.1*` or `*1.1`\n\nExamples:\n\n`networkDeviceIpAddress=121.1.1.10`\n\n`networkDeviceIpAddress=121.1.1.10&networkDeviceIpAddress=172.20.1.10&networkDeviceIpAddress=10.10.20.10` (multiple networkDevice IP Address with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceMacAddress","description":"The list of Network Device MAC Address. (Ex. `64:f6:9d:07:9a:00`)\n\nThis field supports wildcard (`*`) character-based search. \nEx: `*AB:AB:AB*` or `AB:AB:AB*` or `*AB:AB:AB`\n\nExamples:\n\n`networkDeviceMacAddress=64:f6:9d:07:9a:00`\n\n`networkDeviceMacAddress=64:f6:9d:07:9a:00&networkDeviceMacAddress=70:56:9d:07:ac:77` (multiple networkDevice MAC addresses with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"interfaceId","description":"The list of Interface Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`)\n\nExamples:\n\n`interfaceId=6bef213c-19ca-4170-8375-b694e251101c` (single interface uuid )\n\n`interfaceId=6bef213c-19ca-4170-8375-b694e251101c&32219612-819e-4b5e-a96b-cf22aca13dd9&2541e9a7-b80d-4955-8aa2-79b233318ba0` (multiple Interface uuid with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"interfaceName","description":"The list of Interface name (Ex. `GigabitEthernet1/0/1`)\nThis field supports wildcard (`*`) character-based search. \nEx: `*1/0/1*` or `1/0/1*` or `*1/0/1`\n\nExamples:\n\n`interfaceNames=GigabitEthernet1/0/1` (single interface name)\n\n`interfaceNames=GigabitEthernet1/0/1&GigabitEthernet2/0/1&GigabitEthernet3/0/1` (multiple interface names with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Interfaces Response model on success","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"adminStatus":{"type":"string","description":""},"description":{"type":"string","description":""},"duplexConfig":{"type":"string","description":""},"duplexOper":{"type":"string","description":""},"interfaceIfIndex":{"type":"integer","description":""},"interfaceType":{"type":"string","description":""},"ipv4Address":{"type":"string","description":""},"ipv6AddressList":{"type":"array","items":{"type":"string"},"description":""},"isL3Interface":{"type":"boolean","description":""},"isWan":{"type":"boolean","description":""},"macAddr":{"type":"string","description":""},"mediaType":{"type":"string","description":""},"name":{"type":"string","description":""},"operStatus":{"type":"string","description":""},"peerStackMember":{"type":"integer","description":""},"peerStackPort":{"type":"string","description":""},"portChannelId":{"type":"string","description":""},"portMode":{"type":"string","description":""},"portType":{"type":"string","description":""},"rxDiscards":{"type":"number","description":""},"rxError":{"type":"integer","description":""},"rxRate":{"type":"number","description":""},"rxUtilization":{"type":"number","description":""},"speed":{"type":"string","description":""},"stackPortType":{"type":"string","description":""},"timestamp":{"type":"integer","description":""},"txDiscards":{"type":"number","description":""},"txError":{"type":"integer","description":""},"txRate":{"type":"number","description":""},"txUtilization":{"type":"number","description":""},"vlanId":{"type":"string","description":""},"networkDeviceId":{"type":"string","description":""},"networkDeviceIpAddress":{"type":"string","description":""},"networkDeviceMacAddress":{"type":"string","description":""},"siteHierarchy":{"type":"string","description":""},"siteHierarchyId":{"type":"string","description":""},"poeAdminStatus":{"type":"string","description":""},"poeOperStatus":{"type":"string","description":""},"chassisId":{"type":"integer","description":""},"moduleId":{"type":"integer","description":""},"pdClassSignal":{"type":"string","description":""},"pdClassSpare":{"type":"string","description":""},"pdDeviceType":{"type":"string","description":""},"pdDeviceModel":{"type":"string","description":""},"pdPowerAdminMaxInWatt":{"type":"string","description":""},"pdPowerBudgetInWatt":{"type":"string","description":""},"pdPowerConsumedInWatt":{"type":"string","description":""},"pdPowerRemainingInWatt":{"type":"string","description":""},"pdMaxPowerDrawn":{"type":"string","description":""},"pdConnectedDeviceList":{"type":"array","items":{"type":"string"},"description":""},"poeOperPriority":{"type":"string","description":""},"fastPoEEnabled":{"type":"boolean","description":""},"perpetualPoEEnabled":{"type":"boolean","description":""},"policingPoEEnabled":{"type":"boolean","description":""},"upoePlusEnabled":{"type":"boolean","description":""},"fourPairEnabled":{"type":"boolean","description":""},"poeDataTimestamp":{"type":"integer","description":""},"pdLocation":{"type":"string","description":""},"pdDeviceName":{"type":"string","description":""},"pdConnectedSwitch":{"type":"string","description":""},"connectedSwitchUuid":{"type":"string","description":""},"ieeeCompliant":{"type":"boolean","description":""},"connectedSwitchType":{"type":"string","description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"integer","description":""},"count":{"type":"integer","description":""},"sortBy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"order":{"type":"string","description":""}}},"description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetsInterfacesAlongWithStatisticsAndPoeDataFromAllNetworkDevicesResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}},"default":{"description":"Unexpected Error","content":{}}},"x-rapi-id":"9898-9b5a-445b-884f","x-rapi-overview":" Retrieves the list of the interfaces from all network devices based on\n the provided query parameters. The latest interfaces data in the\n specified start and end time range will be returned. When there is no\n start and end time specified returns the latest available data.\n \n \n The elements are grouped and sorted by deviceUuid first, and are then\n sorted by the given sort field, or by the default value: name.\n \n\n \n The supported sorting options are: \n\n name, adminStatus, description, duplexConfig, duplexOper,\n interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus,\n portChannelId, portMode, portType,speed, vlanId\n \n \n\n \n This API can paginate up to 500,000 records, please narrow matching results with additional filters beyond that value.\nThe elements are grouped and sorted by deviceUuid first, and are then sorted by the given sort field, or by the default value: name.\n\n The supported sorting options are: name, adminStatus, description, duplexConfig, duplexOper,interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus,portChannelId, portMode, portType,speed, vlanId,pdPowerAdminMaxInWatt,pdPowerBudgetInWatt,pdPowerConsumedInWatt,pdPowerRemainingInWatt,pdMaxPowerDrawn. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-interfaces-2.0.0-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/interfaces","x-rapi-publicPath":"/dna/data/api/v1/interfaces","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getsInterfacesAlongWithStatisticsAndPoeDataFromAllNetworkDevices.","method":"get","path":"/dna/data/api/v1/interfaces"}}