{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Orgs Stats - Ports API", "version": "2606.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Orgs Stats - Ports", "type": "folder" }, "items": [ { "info": { "name": "countOrgSwOrGwPorts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/stats/ports/count", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query", "description": "Field used to group this count response. enum: `full_duplex`, `mac`, `neighbor_mac`, `neighbor_port_desc`, `neighbor_system_name`, `poe_disabled`, `poe_mode`, `poe_on`, `port_id`, `port_mac`, `speed`, `up`" }, { "name": "full_duplex", "value": "", "type": "query", "description": "Indicates full or half duplex" }, { "name": "mac", "value": "", "type": "query", "description": "Filter results by MAC address. Accepts multiple comma-separated values." }, { "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": "Filter results by port identifier" }, { "name": "port_mac", "value": "", "type": "query", "description": "Filter results by port 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": "Filter results by transmitted packet count" }, { "name": "rx_pkts", "value": "", "type": "query", "description": "Filter results by received packet count" }, { "name": "rx_bytes", "value": "", "type": "query", "description": "Filter results by received byte count" }, { "name": "tx_bps", "value": "", "type": "query", "description": "Filter results by transmit rate" }, { "name": "rx_bps", "value": "", "type": "query", "description": "Filter results by receive rate" }, { "name": "tx_mcast_pkts", "value": "", "type": "query", "description": "Filter results by transmitted multicast packet count" }, { "name": "tx_bcast_pkts", "value": "", "type": "query", "description": "Filter results by transmitted broadcast packet count" }, { "name": "rx_mcast_pkts", "value": "", "type": "query", "description": "Filter results by received multicast packet count" }, { "name": "rx_bcast_pkts", "value": "", "type": "query", "description": "Filter results by received broadcast packet count" }, { "name": "speed", "value": "", "type": "query", "description": "Filter results by port speed" }, { "name": "stp_state", "value": "", "type": "query", "description": "STP state used to filter port results when `up`==`true`. enum: `\"\"`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`" }, { "name": "stp_role", "value": "", "type": "query", "description": "STP role used to filter port results when `up`==`true`. enum: `\"\"`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`" }, { "name": "auth_state", "value": "", "type": "query", "description": "Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `\"\"`, `authenticated`, `authenticating`, `held`, `init`" }, { "name": "up", "value": "", "type": "query", "description": "Indicates if interface is up" }, { "name": "site_id", "value": "", "type": "query", "description": "Filter results by site identifier" }, { "name": "start", "value": "", "type": "query", "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`" }, { "name": "end", "value": "", "type": "query", "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`" }, { "name": "duration", "value": "", "type": "query", "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return per page" } ] }, "docs": "Count by Distinct Attributes of Switch/Gateway Ports at the Org level" }, { "info": { "name": "searchOrgSwOrGwPorts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/stats/ports/search", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "device_type", "value": "gateway,switch", "type": "query", "description": "Type of device. enum: `switch`, `gateway`, `all`. Accepts multiple comma-separated values." }, { "name": "auth_state", "value": "", "type": "query", "description": "Authentication state used to filter port results when `up`==`true` and the port has an authenticator role. enum: `\"\"`, `authenticated`, `authenticating`, `held`, `init`" }, { "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": "Filter results by MAC address. Accepts multiple comma-separated values." }, { "name": "neighbor_mac", "value": "", "type": "query", "description": "Chassis identifier of the chassis type listed. Accepts multiple comma-separated values." }, { "name": "neighbor_port_desc", "value": "", "type": "query", "description": "Description supplied by the system on the interface E.g. \"GigabitEthernet2/0/39\". Accepts multiple comma-separated values." }, { "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\". Accepts multiple comma-separated values." }, { "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 used to filter switch port results. enum: `low`, `high`" }, { "name": "port_id", "value": "", "type": "query", "description": "Filter results by port identifier. Accepts multiple comma-separated values." }, { "name": "port_mac", "value": "", "type": "query", "description": "Filter results by port MAC address. Accepts multiple comma-separated values." }, { "name": "speed", "value": "", "type": "query", "description": "Filter results by port speed" }, { "name": "stp_state", "value": "", "type": "query", "description": "STP state used to filter port results when `up`==`true`. enum: `\"\"`, `blocking`, `disabled`, `forwarding`, `learning`, `listening`" }, { "name": "stp_role", "value": "", "type": "query", "description": "STP role used to filter port results when `up`==`true`. enum: `\"\"`, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`" }, { "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", "description": "Maximum number of results to return per page" }, { "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.\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 }