{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Sites Stats - Ports API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Sites Stats - Ports", "type": "folder" }, "items": [ { "info": { "name": "countSiteSwOrGwPorts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/stats/ports/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "full_duplex", "value": "", "type": "query", "description": "Indicates full or half duplex" }, { "name": "mac", "value": "", "type": "query", "description": "Device identifier" }, { "name": "neighbor_mac", "value": "", "type": "query", "description": "Chassis identifier of the chassis type listed" }, { "name": "neighbor_port_desc", "value": "", "type": "query", "description": "Description supplied by the system on the interface E.g. \"GigabitEthernet2/0/39\"" }, { "name": "neighbor_system_name", "value": "", "type": "query", "description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \"Kumar-Acc-SW.mist.local\"" }, { "name": "poe_disabled", "value": "", "type": "query", "description": "Is the POE configured not be disabled." }, { "name": "poe_mode", "value": "", "type": "query", "description": "POE mode depending on class E.g. \"802.3at\"" }, { "name": "poe_on", "value": "", "type": "query", "description": "Is the device attached to POE" }, { "name": "port_id", "value": "", "type": "query", "description": "Interface name" }, { "name": "port_mac", "value": "", "type": "query", "description": "Interface mac address" }, { "name": "power_draw", "value": "", "type": "query", "description": "Amount of power being used by the interface at the time the command is executed. Unit in watts." }, { "name": "tx_pkts", "value": "", "type": "query", "description": "Output packets" }, { "name": "rx_pkts", "value": "", "type": "query", "description": "Input packets" }, { "name": "rx_bytes", "value": "", "type": "query", "description": "Input bytes" }, { "name": "tx_bps", "value": "", "type": "query", "description": "Output rate" }, { "name": "rx_bps", "value": "", "type": "query", "description": "Input rate" }, { "name": "tx_mcast_pkts", "value": "", "type": "query", "description": "Multicast output packets" }, { "name": "tx_bcast_pkts", "value": "", "type": "query", "description": "Broadcast output packets" }, { "name": "rx_mcast_pkts", "value": "", "type": "query", "description": "Multicast input packets" }, { "name": "rx_bcast_pkts", "value": "", "type": "query", "description": "Broadcast input packets" }, { "name": "speed", "value": "", "type": "query", "description": "Port speed" }, { "name": "stp_state", "value": "", "type": "query", "description": "If `up`==`true`" }, { "name": "stp_role", "value": "", "type": "query", "description": "If `up`==`true`" }, { "name": "auth_state", "value": "", "type": "query", "description": "If `up`==`true` && has Authenticator role" }, { "name": "up", "value": "", "type": "query", "description": "Indicates if interface is up" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Count by Distinct Attributes of Switch/Gateway Ports" }, { "info": { "name": "searchSiteSwOrGwPorts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/stats/ports/search", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "device_type", "value": "", "type": "query", "description": "Type of device. enum: `switch`, `gateway`, `all`" }, { "name": "auth_state", "value": "", "type": "query", "description": "If `up`==`true` && has Authenticator role" }, { "name": "full_duplex", "value": "", "type": "query", "description": "Indicates full or half duplex" }, { "name": "lte_imsi", "value": "", "type": "query", "description": "LTE IMSI value, Check for null/empty" }, { "name": "lte_iccid", "value": "", "type": "query", "description": "LTE ICCID value, Check for null/empty" }, { "name": "lte_imei", "value": "", "type": "query", "description": "LTE IMEI value, Check for null/empty" }, { "name": "mac", "value": "", "type": "query", "description": "Device identifier" }, { "name": "neighbor_mac", "value": "", "type": "query", "description": "Chassis identifier of the chassis type listed" }, { "name": "neighbor_port_desc", "value": "", "type": "query", "description": "Description supplied by the system on the interface E.g. \"GigabitEthernet2/0/39\"" }, { "name": "neighbor_system_name", "value": "", "type": "query", "description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \"Kumar-Acc-SW.mist.local\"" }, { "name": "poe_disabled", "value": "", "type": "query", "description": "Is the POE configured not be disabled." }, { "name": "poe_mode", "value": "", "type": "query", "description": "POE mode depending on class E.g. \"802.3at\"" }, { "name": "poe_on", "value": "", "type": "query", "description": "Is the device attached to POE" }, { "name": "poe_priority", "value": "", "type": "query", "description": "PoE priority." }, { "name": "port_id", "value": "", "type": "query", "description": "Interface name" }, { "name": "port_mac", "value": "", "type": "query", "description": "Interface mac address" }, { "name": "speed", "value": "", "type": "query", "description": "Port speed" }, { "name": "stp_state", "value": "", "type": "query", "description": "If `up`==`true`" }, { "name": "stp_role", "value": "", "type": "query", "description": "If `up`==`true`" }, { "name": "up", "value": "", "type": "query", "description": "Indicates if interface is up" }, { "name": "xcvr_part_number", "value": "", "type": "query", "description": "Optic Slot Partnumber, Check for null/empty" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "On which field the list should be sorted, -prefix represents DESC order" }, { "name": "search_after", "value": "", "type": "query", "description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed." } ] }, "docs": "Search Switch / Gateway Ports Stats for a specific site.\nReturns a list of switch/gateway ports stats that match the search criteria.\n\nThe response provide current/last port status and statistics within the hour.\nTraffic information (Tx/Rx) are cumulative counters since the last device reboot." } ] } ], "bundled": true }