{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Sites Devices API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Sites Devices", "type": "folder" }, "items": [ { "info": { "name": "listSiteDevices", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Get list of devices on the site." }, { "info": { "name": "countSiteDeviceConfigHistory", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/config_history/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "mac", "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": "searchSiteDeviceConfigHistory", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/config_history/search", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" }, { "name": "mac", "value": "", "type": "query", "description": "Device MAC Address" }, { "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 for entries in device config history" }, { "info": { "name": "countSiteDevices", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "hostname", "value": "", "type": "query" }, { "name": "model", "value": "", "type": "query" }, { "name": "mac", "value": "", "type": "query" }, { "name": "version", "value": "", "type": "query" }, { "name": "mxtunnel_status", "value": "", "type": "query" }, { "name": "mxedge_id", "value": "", "type": "query" }, { "name": "lldp_system_name", "value": "", "type": "query" }, { "name": "lldp_system_desc", "value": "", "type": "query" }, { "name": "lldp_port_id", "value": "", "type": "query" }, { "name": "lldp_mgmt_addr", "value": "", "type": "query" }, { "name": "map_id", "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 ap events history for distinct field with given filters" }, { "info": { "name": "countSiteDeviceEvents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/events/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "model", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query", "description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)" }, { "name": "type_code", "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 ap events history for distinct field with given filters" }, { "info": { "name": "searchSiteDeviceEvents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/events/search", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "mac", "value": "", "type": "query", "description": "Device mac" }, { "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": "last_by", "value": "port_id", "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 Devices Events" }, { "info": { "name": "exportSiteDevices", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/export", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "To download the exported device information" }, { "info": { "name": "setSiteDevicesGbpTag", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/gbp_tag", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set GBP Tag for multiple devices" }, { "info": { "name": "importSiteDevices", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/import", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import Information for Multiple Devices\n\nCSV format:\n```csv\nmac,name,map_id,x,y,height,orientation,labels,band_24.power,band_24.bandwidth,band_24.channel,band_24.disabled,band_5.power,band_5.bandwidth,band_5.channel,band_5.disabled,band_6.power,band_6.bandwidth,band_6.channel,band_6.disabled\n5c5b53010101,\"AP 1\",845a23bf-bed9-e43c-4c86-6fa474be7ae5,30,10,2.3,45,\"guest, campus, vip\",1,20,0,false,0,40,0,false,17,80,0,false\n```" }, { "info": { "name": "countSiteDeviceLastConfig", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/last_config/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "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": "searchSiteDeviceLastConfigs", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/last_config/search", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "cert_expiry_duration", "value": "", "type": "query", "description": "Duration for expiring cert queries (format: 2d/3h/172800 seconds)" }, { "name": "device_type", "value": "", "type": "query" }, { "name": "mac", "value": "", "type": "query" }, { "name": "version", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "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 Device Last Configs" }, { "info": { "name": "searchSiteDevices", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/search", "params": [ { "name": "site_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": "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": "Sort options" }, { "name": "desc_sort", "value": "", "type": "query", "description": "Sort options in reverse 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" }, { "info": { "name": "getSiteDevice", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" } ] }, "docs": "Get Device Configuration" }, { "info": { "name": "updateSiteDevice", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Device Configuration" }, { "info": { "name": "addSiteDeviceImage", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/image/:image_number", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" }, { "name": "image_number", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Attach up to 3 images to a device" }, { "info": { "name": "deleteSiteDeviceImage", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/image/:image_number", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" }, { "name": "image_number", "value": "", "type": "path" } ] }, "docs": "Delete image from a device" } ] } ], "bundled": true }