searchOrgSwOrGwPorts

GET https://{{host}}/api/v1/orgs/:org_id/stats/ports/search

Supported FiltersName

Name	Type	Description
`full_duplex`	`boolean`	indicates full or half duplex
`mac`	`string`	device identifier
`neighbor_mac`	`string`	Chassis identifier of the chassis type listed
`neighbor_port_desc`	`string`	Description supplied by the system on the interface E.g. “GigabitEthernet2/0/39”
`neighbor_system_name`	`string`	Name supplied by the system on the interface E.g. neighbor system name E.g. “Kumar-Acc-SW.mist.local”
`poe_disabled`	`boolean`	is the POE configured not be disabled.
`poe_mode`	`string`	poe mode depending on class E.g. “802.3at”
`poe_on`	`boolean`	is the device attached to POE
`port_id`	`string`	interface name
`port_mac`	`string`	interface mac address
`power_draw`	`float`	Amount of power being used by the interface at the time the command is executed. Unit in watts.
`tx_pkts`	`int`	Output packets
`rx_pkts`	`int`	Input packets
`tx_bytes`	`int`	Output bytes
`rx_bytes`	`int`	Input bytes
`tx_bps`	`int`	Output rate
`rx_bps`	`int`	Input rate
`tx_errors`	`int`	Output errors
`rx_errors`	`int`	Input errors
`tx_mcast_pkts`	int	Multicast output packets
`tx_bcast_pkts`	int	Broadcast output packets
`rx_mcast_pkts`	int	Multicast input packets
`rx_bcast_pkts`	int	Broadcast input packets
`speed`	`int`	port speed
`mac_limit`	`int`	Limit on number of dynamically learned macs
`mac_count`	`int`	Number of mac addresses in the forwarding table
`up`	`boolean`	indicates if interface is up
`stp_state`	`string`	if up == true, forwarding / blocking / learning / listening / disabled
`stp_role`	`string`	if up == true, designated / backup / alternate / root / root-prevented
`auth_state`	`string`	if up == true && has Authenticator role, init / authenticated / authenticating / held

E.g. /api/v1/sites/:siteid/stats/switchports/search?mac=001122334455

RESPONSES

status: OK

&quot;{\n    \&quot;start\&quot;: 1511967600,\n    \&quot;end\&quot;: 1513177200,\n    \&quot;limit\&quot;: 10,\n    \&quot;total\&quot;: 100,\n    \&quot;results\&quot;: [\n         {\n            \&quot;rx_bytes\&quot;: 4563443626,\n            \&quot;rx_pkts\&quot;: 30360265,\n            \&quot;site_id\&quot;: \&quot;c1698122-c14c-11e5-8e81-1258369c38a9\&quot;,\n            \&quot;neighbor_system_name\&quot;: \&quot;CORP-D-SW-2\&quot;,\n            \&quot;org_id\&quot;: \&quot;c168ddee-c14c-11e5-8e81-1258369c38a9\&quot;,\n            \&quot;up\&quot;: true,\n            \&quot;port_mac\&quot;: \&quot;5c4527a96580\&quot;,\n            \&quot;neighbor_port_desc\&quot;: \&quot;GigabitEthernet1/0/21\&quot;,\n            \&quot;tx_pkts\&quot;: 14610886,\n            \&quot;mac\&quot;: \&quot;5c4527a96580\&quot;,\n            \&quot;tx_bytes\&quot;: 11299516780,\n            \&quot;neighbor_mac\&quot;: \&quot;64d814353400\&quot;,\n            \&quot;poe_disabled\&quot;: true,\n            \&quot;speed\&quot;: 1000,\n            \&quot;port_id\&quot;: \&quot;me0\&quot;\n        },\n        {\n            \&quot;rx_bps\&quot;: 1176,\n            \&quot;rx_bytes\&quot;: 2628451,\n            \&quot;rx_pkts\&quot;: 11829,\n            \&quot;org_id\&quot;: \&quot;c168ddee-c14c-11e5-8e81-1258369c38a9\&quot;,\n            \&quot;full_duplex\&quot;: true,\n            \&quot;site_id\&quot;: \&quot;c1698122-c14c-11e5-8e81-1258369c38a9\&quot;,\n            \&quot;up\&quot;: true,\n            \&quot;poe_mode\&quot;: \&quot;802.3at\&quot;,\n            \&quot;port_mac\&quot;: \&quot;0c8126c6ff6f\&quot;,\n            \&quot;mac\&quot;: \&quot;0c8126c6ff6c\&quot;,\n            \&quot;tx_pkts\&quot;: 492176,\n            \&quot;neighbor_port_desc\&quot;: \&quot;ETH0\&quot;,\n            \&quot;tx_bps\&quot;: 14264,\n            \&quot;port_id\&quot;: \&quot;ge-0/0/0\&quot;,\n            \&quot;tx_bytes\&quot;: 96810192,\n            \&quot;neighbor_mac\&quot;: \&quot;5c5b350eb361\&quot;,\n            \&quot;neighbor_system_name\&quot;: \&quot;kevinsap\&quot;,\n            \&quot;speed\&quot;: 1000,\n            \&quot;poe_on\&quot;: true,\n            \&quot;power_draw\&quot;: 5.4\n        },\n        ...\n    ]\n}&quot;