{"type":"model","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":{"type":"object","properties":{"response":{"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/GetInterfaceByIdResponse","title":"GetInterfaceByIdResponse"}}