{"type":"api","title":"Get all interfaces","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":"getAllInterfaces","tags":["Devices"],"summary":"Get all interfaces","deprecated":false,"description":"Returns all available interfaces. This endpoint can return a maximum of 500 interfaces. The API returns a paginated response based on 'limit' and 'offset' parameters, allowing up to 500 records per page. 'limit' specifies the number of records, and 'offset' sets the starting point using 1-based indexing. Use '/dna/intent/api/v1/interface/count' to get the total record count. For data sets over 500 records, make multiple calls, adjusting 'limit' and 'offset' to retrieve all records incrementally.","parameters":[{"name":"offset","description":"Offset","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"limit","description":"The number of records to show for this page. Min: 1, Max: 500","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"lastInputTime","description":"Last Input Time","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"lastOutputTime","description":"Last Output Time","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":{"response":{"type":"array","items":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address":{"type":"object","properties":{"ipAddress":{"type":"object","properties":{"address":{"type":"string","description":"IP address of the interface"}},"description":""},"ipMask":{"type":"object","properties":{"address":{"type":"string","description":"IP Mask of the interface"}},"description":""},"isInverseMask":{"type":"boolean","description":"Inverse Mask of the IP address is enabled or not"}},"description":""},"type":{"type":"string","description":"Type of the interface. For e.g. IPv4, IPv6 (with unicast, multicast, anycast, etc.)"}}},"description":"This field holds IPAddress details."},"adminStatus":{"type":"string","description":"Admin status as ('UP'/'DOWN')"},"className":{"type":"string","description":"Classifies the port as switch port ,loopback interface etc."},"description":{"type":"string","description":"Description for the Interface"},"name":{"type":"string","description":"Name for the interface"},"deviceId":{"type":"string","description":"Device Id of the device"},"duplex":{"type":"string","description":"Interface duplex as AutoNegotiate or FullDuplex"},"id":{"type":"string","description":"ID of the Interface"},"ifIndex":{"type":"string","description":"Interface index"},"instanceTenantId":{"type":"string","description":"Instance Tenant Id of the Interface"},"instanceUuid":{"type":"string","description":"Instance Uuid of the Interface"},"interfaceType":{"type":"string","description":"Interface type as Physical or Virtual"},"ipv4Address":{"type":"string","description":"IPV4 Address of the device"},"ipv4Mask":{"type":"string","description":"IPV4 Mask of the device"},"isisSupport":{"type":"string","description":"Flag for ISIS enabled / disabled"},"lastOutgoingPacketTime":{"type":"number","description":"Time, in milliseconds since UNIX epoch, when the last packet was sent from this interface"},"lastIncomingPacketTime":{"type":"number","description":"Time, in milliseconds since UNIX epoch, when the last packet was received on this interface"},"lastUpdated":{"type":"string","description":"Time when the device interface info last got updated"},"macAddress":{"type":"string","description":"MAC address of interface"},"mappedPhysicalInterfaceId":{"type":"string","description":"ID of physical interface mapped with the virtual interface of WLC"},"mappedPhysicalInterfaceName":{"type":"string","description":"Physical interface name mapped with the virtual interface of WLC"},"mediaType":{"type":"string","description":"Media Type of the interface"},"mtu":{"type":"string","description":"MTU Information of Interface"},"nativeVlanId":{"type":"string","description":"Vlan to receive untagged frames on trunk port"},"ospfSupport":{"type":"string","description":"Flag for OSPF enabled / disabled"},"pid":{"type":"string","description":"Platform ID of the device"},"portMode":{"type":"string","description":"Port mode as access, trunk, routed"},"portName":{"type":"string","description":"Interface name"},"portType":{"type":"string","description":"Port type as Ethernet Port / Ethernet SVI / Ethernet Sub Interface"},"serialNo":{"type":"string","description":"Serial number of the device"},"series":{"type":"string","description":"Series of the device"},"speed":{"type":"string","description":"Speed of the interface"},"status":{"type":"string","description":"Interface status as Down / Up"},"vlanId":{"type":"string","description":"Vlan ID of interface"},"voiceVlan":{"type":"string","description":"Vlan information of the interface"}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetAllInterfacesResponse"}}}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","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":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"f594-7a4c-439a-8bf0","x-rapi-overview":"Returns all available interfaces. This endpoint can return a maximum of 500 interfaces. The API returns a paginated response based on 'limit' and 'offset' parameters, allowing up to 500 records per page. 'limit' specifies the number of records, and 'offset' sets the starting point using 1-based indexing. Use '/dna/intent/api/v1/interface/count' to get the total record count. For data sets over 500 records, make multiple calls, adjusting 'limit' and 'offset' to retrieve all records incrementally.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/interface/details","x-rapi-publicPath":"/dna/intent/api/v1/interface","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getAllInterfaces","method":"get","path":"/dna/intent/api/v1/interface"}}