{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Orgs Devices API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Orgs Devices", "type": "folder" }, "items": [ { "info": { "name": "listOrgDevices", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices", "params": [ { "name": "org_id", "value": "", "type": "path" } ] }, "docs": "Get List of Org Devices" }, { "info": { "name": "countOrgDevices", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices/count", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "hostname", "value": "", "type": "query", "description": "Partial / full hostname" }, { "name": "site_id", "value": "", "type": "query", "description": "Site id" }, { "name": "model", "value": "", "type": "query", "description": "Device model" }, { "name": "managed", "value": "", "type": "query", "description": "for switches and gateways, to filter on managed/unmanaged devices. Deprecated in favour of mist_configured. enum: `true`, `false`" }, { "name": "mac", "value": "", "type": "query", "description": "AP mac" }, { "name": "version", "value": "", "type": "query", "description": "Version" }, { "name": "ip", "value": "", "type": "query" }, { "name": "mxtunnel_status", "value": "", "type": "query", "description": "MxTunnel status, enum: `up`, `down`" }, { "name": "mxedge_id", "value": "", "type": "query", "description": "Mist Edge id, if AP is connecting to a Mist Edge" }, { "name": "lldp_system_name", "value": "", "type": "query", "description": "LLDP system name" }, { "name": "lldp_system_desc", "value": "", "type": "query", "description": "LLDP system description" }, { "name": "lldp_port_id", "value": "", "type": "query", "description": "LLDP port id" }, { "name": "lldp_mgmt_addr", "value": "", "type": "query", "description": "LLDP management ip address" }, { "name": "type", "value": "", "type": "query" }, { "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 Org Devices" }, { "info": { "name": "countOrgDeviceEvents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices/events/count", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "site_id", "value": "", "type": "query", "description": "Site id" }, { "name": "ap", "value": "", "type": "query", "description": "AP mac" }, { "name": "apfw", "value": "", "type": "query", "description": "AP Firmware" }, { "name": "model", "value": "", "type": "query", "description": "Device model" }, { "name": "text", "value": "", "type": "query", "description": "Event message" }, { "name": "timestamp", "value": "", "type": "query", "description": "Event time" }, { "name": "type", "value": "", "type": "query", "description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)" }, { "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 Org Devices Events" }, { "info": { "name": "searchOrgDeviceEvents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices/events/search", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "mac", "value": "", "type": "query", "description": "Device mac" }, { "name": "model", "value": "", "type": "query", "description": "Device model" }, { "name": "device_type", "value": "", "type": "query" }, { "name": "text", "value": "", "type": "query", "description": "Event message" }, { "name": "timestamp", "value": "", "type": "query", "description": "Event time" }, { "name": "type", "value": "", "type": "query", "description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)" }, { "name": "last_by", "value": "", "type": "query", "description": "Return last/recent event for passed in field" }, { "name": "includes", "value": "", "type": "query", "description": "Keyword to include events from additional indices (e.g. ext_tunnel for prisma events)" }, { "name": "limit", "value": "", "type": "query" }, { "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": "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 Org Devices Events" }, { "info": { "name": "countOrgDeviceLastConfigs", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices/last_config/count", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" }, { "name": "distinct", "value": "", "type": "query" }, { "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": "Counts the number of entries in device config history for distinct field with given filters" }, { "info": { "name": "searchOrgDeviceLastConfigs", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices/last_config/search", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "device_type", "value": "", "type": "query" }, { "name": "mac", "value": "", "type": "query", "description": "Device MAC address" }, { "name": "name", "value": "", "type": "query", "description": "Devices Name" }, { "name": "version", "value": "", "type": "query", "description": "Device Version" }, { "name": "cert_expiry_duration", "value": "", "type": "query", "description": "Duration for expiring cert queries (format: 2d/3h/172800 seconds)" }, { "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": "limit", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "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 Device Last Configs" }, { "info": { "name": "listOrgApsMacs", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices/radio_macs", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "For some scenarios like E911 or security systems, the BSSIDs are required to identify which AP the client is connecting to. Then the location of the AP can be used as the approximate location of the client.\n\nEach radio MAC can have up to 16 BSSIDs. These are derived by incrementing the least significant hexadecimal digit (last nibble) of the MAC address from 0 to F, while keeping the remaining bits unchanged." }, { "info": { "name": "searchOrgDevices", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices/search", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "band_24_channel", "value": "", "type": "query", "description": "When `type`==`ap`, Channel of band_24" }, { "name": "band_5_channel", "value": "", "type": "query", "description": "When `type`==`ap`, Channel of band_5" }, { "name": "band_6_channel", "value": "", "type": "query", "description": "When `type`==`ap`, Channel of band_6" }, { "name": "band_24_bandwidth", "value": "", "type": "query", "description": "When `type`==`ap`, Bandwidth of band_24" }, { "name": "band_5_bandwidth", "value": "", "type": "query", "description": "When `type`==`ap`, Bandwidth of band_5" }, { "name": "band_6_bandwidth", "value": "", "type": "query", "description": "When `type`==`ap`, Bandwidth of band_6" }, { "name": "band_24_power", "value": "", "type": "query", "description": "When `type`==`ap`, Power of band_24" }, { "name": "band_5_power", "value": "", "type": "query", "description": "When `type`==`ap`, Power of band_5" }, { "name": "band_6_power", "value": "", "type": "query", "description": "When `type`==`ap`, Power of band_6" }, { "name": "clustered", "value": "", "type": "query", "description": "When `type`==`gateway`, true / false" }, { "name": "eth0_port_speed", "value": "", "type": "query", "description": "When `type`==`ap`, Port speed of eth0" }, { "name": "evpntopo_id", "value": "", "type": "query", "description": "When `type`==`switch`, EVPN topology id" }, { "name": "ext_ip", "value": "", "type": "query", "description": "Partial / full Device external ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `1.2.3.*` and `*.2.3.*` match `1.2.3.4`). Suffix-only wildcards (e.g. `*.2.3.4`) are not supported" }, { "name": "hostname", "value": "", "type": "query", "description": "Partial / full Device hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-london*` and `*london*` match `my-london-1`). Suffix-only wildcards (e.g. `*london-1`) are not supported" }, { "name": "ip", "value": "", "type": "query", "description": "Partial / full Device IP Address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported" }, { "name": "last_config_status", "value": "", "type": "query", "description": "When `type`==`switch` or `type`==`gateway`, last configuration status" }, { "name": "last_hostname", "value": "", "type": "query", "description": "Last hostname of the device." }, { "name": "lldp_mgmt_addr", "value": "", "type": "query", "description": "When `type`==`ap`, LLDP management ip address" }, { "name": "lldp_port_id", "value": "", "type": "query", "description": "When `type`==`ap`, LLDP port id. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `ge-0/0/*` and `*-0/0/*` match `ge-0/0/30`). Suffix-only wildcards (e.g. `*switch-01`) are not supported" }, { "name": "lldp_system_desc", "value": "", "type": "query", "description": "When `type`==`ap`, LLDP system description. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Juniper Networks*` and `*Networks*` match `Juniper Networks, Inc.`). Suffix-only wildcards (e.g. `*switch-01`) are not supported" }, { "name": "lldp_system_name", "value": "", "type": "query", "description": "When `type`==`ap`, LLDP system name. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-switch*` and `*switch*` match `my-switch-01`). Suffix-only wildcards (e.g. `*switch-01`) are not supported" }, { "name": "mac", "value": "", "type": "query", "description": "Partial / full Device MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `001122*` and `*1122*` match `001122334455`). Suffix-only wildcards (e.g. `*4455`) are not supported" }, { "name": "model", "value": "", "type": "query", "description": "Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported" }, { "name": "mxedge_id", "value": "", "type": "query", "description": "When `type`==`ap`, Mist Edge id, if AP is connecting to a Mist Edge" }, { "name": "mxedge_ids", "value": "", "type": "query", "description": "When `type`==`ap`, Comma separated list of Mist Edge id, if AP is connecting to a Mist Edge" }, { "name": "mxtunnel_status", "value": "", "type": "query", "description": "When `type`==`ap`, MxTunnel status, up / down." }, { "name": "node", "value": "", "type": "query", "description": "When `type`==`gateway`. enum: `node0`, `node1`" }, { "name": "node0_mac", "value": "", "type": "query", "description": "When `type`==`gateway`, node0 MAC Address" }, { "name": "node1_mac", "value": "", "type": "query", "description": "When `type`==`gateway`, node1 MAC Address" }, { "name": "power_constrained", "value": "", "type": "query", "description": "When `type`==`ap`, whether the AP is power constrained" }, { "name": "radius_stats", "value": "", "type": "query", "description": "When `type`==`switch` or `type`==`gateway`, Key-value pairs where the key\nis the RADIUS server address and the value contains authentication statistics:\n * (string): IP address of the RADIUS server as the key\n * `auth_accepts` (long): Number of accepted authentication requests\n * `auth_rejects` (long): Number of rejected authentication requests\n * `auth_timeouts` (long): Number of authentication timeouts\n * `auth_server_status` (string): Status of the server. Possible values: `up`, `down`, `unreachable`" }, { "name": "site_id", "value": "", "type": "query", "description": "Site id" }, { "name": "stats", "value": "", "type": "query", "description": "Whether to return device stats" }, { "name": "t128agent_version", "value": "", "type": "query", "description": "When `type`==`gateway` (SSR only), version of 128T agent" }, { "name": "type", "value": "", "type": "query", "description": "Type of device. enum: `ap`, `gateway`, `switch`" }, { "name": "version", "value": "", "type": "query", "description": "Version" }, { "name": "limit", "value": "", "type": "query" }, { "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": "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 Org Devices" }, { "info": { "name": "listOrgDevicesSummary", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/devices/summary", "params": [ { "name": "org_id", "value": "", "type": "path" } ] }, "docs": "Get Org Devices Summary" }, { "info": { "name": "getOrgJuniperDevicesCommand", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/ocdevices/outbound_ssh_cmd", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "site_id", "value": "", "type": "query", "description": "Site_id would be used for proxy config check of the site and automatic site assignment" } ] }, "docs": "Get Org Juniper Devices command\n\nJuniper devices can be managed/adopted by Mist. Currently outbound-ssh + netconf is used.\nA few lines of CLI commands are generated per-Org, allowing the Juniper devices to phone home to Mist." } ] } ], "bundled": true }