{ "opencollection": "1.0.0", "info": { "name": "Cisco Meraki Dashboard API — wireless", "version": "1.72.0" }, "request": { "auth": { "type": "apikey", "key": "X-Cisco-Meraki-API-Key", "value": "{{X-Cisco-Meraki-API-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "wireless", "type": "folder" }, "items": [ { "info": { "name": "Update alternate management interface IPv6 address", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/alternateManagementInterface/ipv6", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update alternate management interface IPv6 address" }, { "info": { "name": "Return the bluetooth settings for a wireless device", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/bluetooth/settings", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ] }, "docs": "Return the bluetooth settings for a wireless device" }, { "info": { "name": "Update the bluetooth settings for a wireless device", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/bluetooth/settings", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the bluetooth settings for a wireless device" }, { "info": { "name": "Aggregated connectivity info for a given AP on this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/connectionStats", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" } ] }, "docs": "Aggregated connectivity info for a given AP on this network" }, { "info": { "name": "Return the ESL settings of a device", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/electronicShelfLabel", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ] }, "docs": "Return the ESL settings of a device" }, { "info": { "name": "Update the ESL settings of a device", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/electronicShelfLabel", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the ESL settings of a device" }, { "info": { "name": "Aggregated latency info for a given AP on this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/latencyStats", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" }, { "name": "vlan", "value": "", "type": "query", "description": "Filter results by VLAN" }, { "name": "fields", "value": "", "type": "query", "description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string." } ] }, "docs": "Aggregated latency info for a given AP on this network" }, { "info": { "name": "Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/radio/settings", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ] }, "docs": "Return the manually configured radio settings overrides of a device, which take precedence over RF profiles." }, { "info": { "name": "Update 2.4 GHz and 5 GHz radio settings (channel, channel width, power) that override RF profiles", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/radio/settings", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update 2.4 GHz and 5 GHz radio settings (channel, channel width, power) that override RF profiles. For 6 GHz support or radio enable/disable, use updateDeviceWirelessRadioOverrides instead." }, { "info": { "name": "Return the SSID statuses of an access point", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/status", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ] }, "docs": "Return the SSID statuses of an access point" }, { "info": { "name": "Enqueue a job to start enrolling door locks on zigbee configured wireless devices", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/zigbee/enrollments", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" } ] }, "docs": "Enqueue a job to start enrolling door locks on zigbee configured wireless devices" }, { "info": { "name": "Return an enrollment", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/devices/:serial/wireless/zigbee/enrollments/:enrollmentId", "params": [ { "name": "serial", "value": "", "type": "path", "description": "Serial" }, { "name": "enrollmentId", "value": "", "type": "path", "description": "Enrollment ID" } ] }, "docs": "Return an enrollment" }, { "info": { "name": "List Air Marshal scan results from a network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/airMarshal", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." } ] }, "docs": "List Air Marshal scan results from a network" }, { "info": { "name": "Creates a new rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/airMarshal/rules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new rule" }, { "info": { "name": "Update a rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/airMarshal/rules/:ruleId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "ruleId", "value": "", "type": "path", "description": "Rule ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a rule" }, { "info": { "name": "Delete an Air Marshal rule.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/airMarshal/rules/:ruleId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "ruleId", "value": "", "type": "path", "description": "Rule ID" } ] }, "docs": "Delete an Air Marshal rule." }, { "info": { "name": "Updates Air Marshal settings.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/airMarshal/settings", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Air Marshal settings." }, { "info": { "name": "Return alternate management interface and devices with IP assigned", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/alternateManagementInterface", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ] }, "docs": "Return alternate management interface and devices with IP assigned" }, { "info": { "name": "Update alternate management interface and device static IP", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/alternateManagementInterface", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update alternate management interface and device static IP" }, { "info": { "name": "Return the billing settings of this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/billing", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ] }, "docs": "Return the billing settings of this network" }, { "info": { "name": "Update the billing settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/billing", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the billing settings" }, { "info": { "name": "Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/bluetooth/settings", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ] }, "docs": "Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network." }, { "info": { "name": "Update the Bluetooth settings for a network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/bluetooth/settings", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Bluetooth settings for a network. See the docs page for Bluetooth settings." }, { "info": { "name": "Return AP channel utilization over time for a device or network client", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/channelUtilizationHistory", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." }, { "name": "resolution", "value": "", "type": "query", "description": "The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400." }, { "name": "autoResolution", "value": "", "type": "query", "description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false." }, { "name": "clientId", "value": "", "type": "query", "description": "Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history." }, { "name": "deviceSerial", "value": "", "type": "query", "description": "Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified." }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6')." } ] }, "docs": "Return AP channel utilization over time for a device or network client" }, { "info": { "name": "Return wireless client counts over time for a network, device, or network client", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/clientCountHistory", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." }, { "name": "resolution", "value": "", "type": "query", "description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400." }, { "name": "autoResolution", "value": "", "type": "query", "description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false." }, { "name": "clientId", "value": "", "type": "query", "description": "Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history." }, { "name": "deviceSerial", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP tag." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6')." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID number." } ] }, "docs": "Return wireless client counts over time for a network, device, or network client" }, { "info": { "name": "Aggregated connectivity info for this network, grouped by clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/clients/connectionStats", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" } ] }, "docs": "Aggregated connectivity info for this network, grouped by clients" }, { "info": { "name": "Aggregated latency info for this network, grouped by clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/clients/latencyStats", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" }, { "name": "vlan", "value": "", "type": "query", "description": "Filter results by VLAN" }, { "name": "fields", "value": "", "type": "query", "description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string." } ] }, "docs": "Aggregated latency info for this network, grouped by clients" }, { "info": { "name": "Aggregated connectivity info for a given client on this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/clients/:clientId/connectionStats", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "clientId", "value": "", "type": "path", "description": "Client ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" } ] }, "docs": "Aggregated connectivity info for a given client on this network. Clients are identified by their MAC." }, { "info": { "name": "List the wireless connectivity events for a client within a network in the timespan.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/clients/:clientId/connectivityEvents", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "clientId", "value": "", "type": "path", "description": "Client ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day." }, { "name": "types", "value": "", "type": "query", "description": "A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band. Valid bands are '2.4', '5' or '6'." }, { "name": "ssidNumber", "value": "", "type": "query", "description": "Filter results by SSID. If not specified, events for all SSIDs will be returned." }, { "name": "includedSeverities", "value": "", "type": "query", "description": "A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'." }, { "name": "deviceSerial", "value": "", "type": "query", "description": "Filter results by an AP's serial number." } ] }, "docs": "List the wireless connectivity events for a client within a network in the timespan." }, { "info": { "name": "Return the latency history for a client", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/clients/:clientId/latencyHistory", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "clientId", "value": "", "type": "path", "description": "Client ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 791 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 791 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day." }, { "name": "resolution", "value": "", "type": "query", "description": "The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400." } ] }, "docs": "Return the latency history for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. The latency data is from a sample of 2% of packets and is grouped into 4 traffic categories: background, best effort, video, voice. Within these categories the sampled packet counters are bucketed by latency in milliseconds." }, { "info": { "name": "Aggregated latency info for a given client on this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/clients/:clientId/latencyStats", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "clientId", "value": "", "type": "path", "description": "Client ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" }, { "name": "vlan", "value": "", "type": "query", "description": "Filter results by VLAN" }, { "name": "fields", "value": "", "type": "query", "description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string." } ] }, "docs": "Aggregated latency info for a given client on this network. Clients are identified by their MAC." }, { "info": { "name": "Aggregated connectivity info for this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/connectionStats", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" } ] }, "docs": "Aggregated connectivity info for this network" }, { "info": { "name": "Return PHY data rates over time for a network, device, or network client", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/dataRateHistory", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." }, { "name": "resolution", "value": "", "type": "query", "description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400." }, { "name": "autoResolution", "value": "", "type": "query", "description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false." }, { "name": "clientId", "value": "", "type": "query", "description": "Filter results by network client." }, { "name": "deviceSerial", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP tag." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6')." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID number." } ] }, "docs": "Return PHY data rates over time for a network, device, or network client" }, { "info": { "name": "Aggregated connectivity info for this network, grouped by node", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/devices/connectionStats", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" } ] }, "docs": "Aggregated connectivity info for this network, grouped by node" }, { "info": { "name": "Aggregated latency info for this network, grouped by node", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/devices/latencyStats", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" }, { "name": "vlan", "value": "", "type": "query", "description": "Filter results by VLAN" }, { "name": "fields", "value": "", "type": "query", "description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string." } ] }, "docs": "Aggregated latency info for this network, grouped by node" }, { "info": { "name": "Return the ESL settings of a wireless network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/electronicShelfLabel", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ] }, "docs": "Return the ESL settings of a wireless network" }, { "info": { "name": "Update the ESL settings of a wireless network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/electronicShelfLabel", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the ESL settings of a wireless network" }, { "info": { "name": "Get a list of all ESL eligible devices of a network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/electronicShelfLabel/configuredDevices", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ] }, "docs": "Get a list of all ESL eligible devices of a network" }, { "info": { "name": "List the AP port profiles for this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ethernet/ports/profiles", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ] }, "docs": "List the AP port profiles for this network" }, { "info": { "name": "Create an AP port profile", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ethernet/ports/profiles", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an AP port profile" }, { "info": { "name": "Assign AP port profile to list of APs", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ethernet/ports/profiles/assign", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign AP port profile to list of APs" }, { "info": { "name": "Set the AP port profile to be default for this network", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ethernet/ports/profiles/setDefault", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the AP port profile to be default for this network" }, { "info": { "name": "Show the AP port profile by ID for this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ethernet/ports/profiles/:profileId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "profileId", "value": "", "type": "path", "description": "Profile ID" } ] }, "docs": "Show the AP port profile by ID for this network" }, { "info": { "name": "Update the AP port profile by ID for this network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ethernet/ports/profiles/:profileId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "profileId", "value": "", "type": "path", "description": "Profile ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the AP port profile by ID for this network" }, { "info": { "name": "Delete an AP port profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ethernet/ports/profiles/:profileId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "profileId", "value": "", "type": "path", "description": "Profile ID" } ] }, "docs": "Delete an AP port profile" }, { "info": { "name": "List of all failed client connection events on this network in a given time range", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/failedConnections", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" }, { "name": "serial", "value": "", "type": "query", "description": "Filter by AP" }, { "name": "clientId", "value": "", "type": "query", "description": "Filter by client MAC" } ] }, "docs": "List of all failed client connection events on this network in a given time range" }, { "info": { "name": "Return average wireless latency over time for a network, device, or network client", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/latencyHistory", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." }, { "name": "resolution", "value": "", "type": "query", "description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400." }, { "name": "autoResolution", "value": "", "type": "query", "description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false." }, { "name": "clientId", "value": "", "type": "query", "description": "Filter results by network client." }, { "name": "deviceSerial", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP tag." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6')." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID number." }, { "name": "accessCategory", "value": "", "type": "query", "description": "Filter by access category." } ] }, "docs": "Return average wireless latency over time for a network, device, or network client" }, { "info": { "name": "Aggregated latency info for this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/latencyStats", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP Tag" }, { "name": "vlan", "value": "", "type": "query", "description": "Filter results by VLAN" }, { "name": "fields", "value": "", "type": "query", "description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string." } ] }, "docs": "Aggregated latency info for this network" }, { "info": { "name": "Change scanning API settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/location/scanning", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change scanning API settings" }, { "info": { "name": "List wireless mesh statuses for repeaters", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/meshStatuses", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 500. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." } ] }, "docs": "List wireless mesh statuses for repeaters" }, { "info": { "name": "Update the AutoRF settings for a wireless network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/radio/rrm", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the AutoRF settings for a wireless network" }, { "info": { "name": "List RF profiles for this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/rfProfiles", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "includeTemplateProfiles", "value": "", "type": "query", "description": "If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false." } ] }, "docs": "List RF profiles for this network" }, { "info": { "name": "Creates new RF profile for this network", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/rfProfiles", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates new RF profile for this network" }, { "info": { "name": "Return a RF profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/rfProfiles/:rfProfileId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "rfProfileId", "value": "", "type": "path", "description": "Rf profile ID" } ] }, "docs": "Return a RF profile" }, { "info": { "name": "Updates specified RF profile for this network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/rfProfiles/:rfProfileId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "rfProfileId", "value": "", "type": "path", "description": "Rf profile ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates specified RF profile for this network. Note: built-in RF profiles can only be assigned as a default, and its attributes are immutable" }, { "info": { "name": "Delete a RF Profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/rfProfiles/:rfProfileId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "rfProfileId", "value": "", "type": "path", "description": "Rf profile ID" } ] }, "docs": "Delete a RF Profile" }, { "info": { "name": "Return the wireless settings for a network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/settings", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ] }, "docs": "Return the wireless settings for a network" }, { "info": { "name": "Update the wireless settings for a network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/settings", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the wireless settings for a network" }, { "info": { "name": "Return signal quality (SNR/RSSI) over time for a device or network client", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/signalQualityHistory", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." }, { "name": "resolution", "value": "", "type": "query", "description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400." }, { "name": "autoResolution", "value": "", "type": "query", "description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false." }, { "name": "clientId", "value": "", "type": "query", "description": "Filter results by network client." }, { "name": "deviceSerial", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6')." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID number." } ] }, "docs": "Return signal quality (SNR/RSSI) over time for a device or network client" }, { "info": { "name": "List the MR SSIDs in a network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ] }, "docs": "List the MR SSIDs in a network" }, { "info": { "name": "Return a single MR SSID", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "Return a single MR SSID" }, { "info": { "name": "Update the attributes of an MR SSID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the attributes of an MR SSID" }, { "info": { "name": "List the Bonjour forwarding setting and rules for the SSID", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/bonjourForwarding", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "List the Bonjour forwarding setting and rules for the SSID" }, { "info": { "name": "Update the bonjour forwarding setting and rules for the SSID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/bonjourForwarding", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the bonjour forwarding setting and rules for the SSID" }, { "info": { "name": "List the device type group policies for the SSID", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/deviceTypeGroupPolicies", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "List the device type group policies for the SSID" }, { "info": { "name": "Update the device type group policies for the SSID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/deviceTypeGroupPolicies", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the device type group policies for the SSID" }, { "info": { "name": "Return the EAP overridden parameters for an SSID", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/eapOverride", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "Return the EAP overridden parameters for an SSID" }, { "info": { "name": "Update the EAP overridden parameters for an SSID.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/eapOverride", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the EAP overridden parameters for an SSID." }, { "info": { "name": "Return the L3 firewall rules for an SSID on an MR network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/firewall/l3FirewallRules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "Return the L3 firewall rules for an SSID on an MR network" }, { "info": { "name": "Update the L3 firewall rules of an SSID on an MR network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/firewall/l3FirewallRules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the L3 firewall rules of an SSID on an MR network" }, { "info": { "name": "Return the L7 firewall rules for an SSID on an MR network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/firewall/l7FirewallRules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "Return the L7 firewall rules for an SSID on an MR network" }, { "info": { "name": "Update the L7 firewall rules of an SSID on an MR network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/firewall/l7FirewallRules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the L7 firewall rules of an SSID on an MR network" }, { "info": { "name": "Return the Hotspot 2.0 settings for an SSID", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/hotspot20", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "Return the Hotspot 2.0 settings for an SSID" }, { "info": { "name": "Update the Hotspot 2.0 settings of an SSID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/hotspot20", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Hotspot 2.0 settings of an SSID" }, { "info": { "name": "List all Identity PSKs in a wireless network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/identityPsks", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "List all Identity PSKs in a wireless network" }, { "info": { "name": "Create an Identity PSK", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/identityPsks", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Identity PSK" }, { "info": { "name": "Return an Identity PSK", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/identityPsks/:identityPskId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" }, { "name": "identityPskId", "value": "", "type": "path", "description": "Identity psk ID" } ] }, "docs": "Return an Identity PSK" }, { "info": { "name": "Update an Identity PSK", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/identityPsks/:identityPskId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" }, { "name": "identityPskId", "value": "", "type": "path", "description": "Identity psk ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Identity PSK" }, { "info": { "name": "Delete an Identity PSK", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/identityPsks/:identityPskId", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" }, { "name": "identityPskId", "value": "", "type": "path", "description": "Identity psk ID" } ] }, "docs": "Delete an Identity PSK" }, { "info": { "name": "Update the OpenRoaming setting for the SSID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/openRoaming", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the OpenRoaming setting for the SSID" }, { "info": { "name": "List the outage schedule for the SSID", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/schedules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "List the outage schedule for the SSID" }, { "info": { "name": "Update the outage schedule for the SSID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/schedules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the outage schedule for the SSID" }, { "info": { "name": "Display the splash page settings for the given SSID", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/splash/settings", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "Display the splash page settings for the given SSID" }, { "info": { "name": "Modify the splash page settings for the given SSID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/splash/settings", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the splash page settings for the given SSID" }, { "info": { "name": "Display the traffic shaping settings for a SSID on an MR network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/trafficShaping/rules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "Display the traffic shaping settings for a SSID on an MR network" }, { "info": { "name": "Update the traffic shaping rules for an SSID on an MR network.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/trafficShaping/rules", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the traffic shaping rules for an SSID on an MR network." }, { "info": { "name": "List the VPN settings for the SSID.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/vpn", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ] }, "docs": "List the VPN settings for the SSID." }, { "info": { "name": "Update the VPN settings for the SSID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/ssids/:number/vpn", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "number", "value": "", "type": "path", "description": "Number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the VPN settings for the SSID" }, { "info": { "name": "Return AP usage over time for a device or network client", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/usageHistory", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." }, { "name": "resolution", "value": "", "type": "query", "description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400." }, { "name": "autoResolution", "value": "", "type": "query", "description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false." }, { "name": "clientId", "value": "", "type": "query", "description": "Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history." }, { "name": "deviceSerial", "value": "", "type": "query", "description": "Filter results by device. Requires :band." }, { "name": "apTag", "value": "", "type": "query", "description": "Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified." }, { "name": "band", "value": "", "type": "query", "description": "Filter results by band (either '2.4', '5' or '6')." }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID number." } ] }, "docs": "Return AP usage over time for a device or network client" }, { "info": { "name": "Update Zigbee Configs for specified network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/networks/:networkId/wireless/zigbee", "params": [ { "name": "networkId", "value": "", "type": "path", "description": "Network ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Zigbee Configs for specified network" }, { "info": { "name": "Returns the current Air Marshal rules for this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/airMarshal/rules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "(optional) The set of network IDs to include." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." } ] }, "docs": "Returns the current Air Marshal rules for this organization" }, { "info": { "name": "Returns the current Air Marshal settings for this network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/airMarshal/settings/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "The network IDs to include in the result set." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." } ] }, "docs": "Returns the current Air Marshal settings for this network" }, { "info": { "name": "List access point client count at the moment in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/clients/overview/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter access points client counts by network ID. This filter uses multiple exact matches." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter access points client counts by its serial numbers. This filter uses multiple exact matches." }, { "name": "campusGatewayClusterIds", "value": "", "type": "query", "description": "Optional parameter to filter access points client counts by MCG cluster IDs. This filter uses multiple exact matches." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." } ] }, "docs": "List access point client count at the moment in an organization" }, { "info": { "name": "Get average channel utilization for all bands in a network, split by AP", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/channelUtilization/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter results by network." }, { "name": "serials", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 90 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 90 days. The default is 7 days." }, { "name": "interval", "value": "", "type": "query", "description": "The time interval in seconds for returned data. The valid intervals are: 300, 600, 3600, 7200, 14400, 21600. The default is 3600." } ] }, "docs": "Get average channel utilization for all bands in a network, split by AP" }, { "info": { "name": "Get average channel utilization across all bands for all networks in the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/channelUtilization/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter results by network." }, { "name": "serials", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 90 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 90 days. The default is 7 days." }, { "name": "interval", "value": "", "type": "query", "description": "The time interval in seconds for returned data. The valid intervals are: 300, 600, 3600, 7200, 14400, 21600. The default is 3600." } ] }, "docs": "Get average channel utilization across all bands for all networks in the organization" }, { "info": { "name": "Get a time-series of average channel utilization for all bands, segmented by device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/channelUtilization/history/byDevice/byInterval", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter results by network." }, { "name": "serials", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." }, { "name": "interval", "value": "", "type": "query", "description": "The time interval in seconds for returned data. The valid intervals are: 300, 600, 3600, 7200, 14400, 21600. The default is 3600." } ] }, "docs": "Get a time-series of average channel utilization for all bands, segmented by device." }, { "info": { "name": "Get a time-series of average channel utilization for all bands", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/channelUtilization/history/byNetwork/byInterval", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter results by network." }, { "name": "serials", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days." }, { "name": "interval", "value": "", "type": "query", "description": "The time interval in seconds for returned data. The valid intervals are: 300, 600, 3600, 7200, 14400, 21600. The default is 3600." } ] }, "docs": "Get a time-series of average channel utilization for all bands" }, { "info": { "name": "List the most recent Ethernet link speed, duplex, aggregation and power mode and status information for wireless devices.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/ethernet/statuses", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456" } ] }, "docs": "List the most recent Ethernet link speed, duplex, aggregation and power mode and status information for wireless devices." }, { "info": { "name": "Get average packet loss for the given timespan for all clients in the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/packetLoss/byClient", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter results by network." }, { "name": "ssids", "value": "", "type": "query", "description": "Filter results by SSID number." }, { "name": "bands", "value": "", "type": "query", "description": "Filter results by band. Valid bands are: 2.4, 5, and 6." }, { "name": "macs", "value": "", "type": "query", "description": "Filter results by client mac address(es)." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 90 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 5 minutes and be less than or equal to 90 days. The default is 7 days." } ] }, "docs": "Get average packet loss for the given timespan for all clients in the organization." }, { "info": { "name": "Get average packet loss for the given timespan for all devices in the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/packetLoss/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter results by network." }, { "name": "serials", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "ssids", "value": "", "type": "query", "description": "Filter results by SSID number." }, { "name": "bands", "value": "", "type": "query", "description": "Filter results by band. Valid bands are: 2.4, 5, and 6." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 90 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 5 minutes and be less than or equal to 90 days. The default is 7 days." } ] }, "docs": "Get average packet loss for the given timespan for all devices in the organization. Does not include device's own traffic." }, { "info": { "name": "Get average packet loss for the given timespan for all networks in the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/packetLoss/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter results by network." }, { "name": "serials", "value": "", "type": "query", "description": "Filter results by device." }, { "name": "ssids", "value": "", "type": "query", "description": "Filter results by SSID number." }, { "name": "bands", "value": "", "type": "query", "description": "Filter results by band. Valid bands are: 2.4, 5, and 6." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 90 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 5 minutes and be less than or equal to 90 days. The default is 7 days." } ] }, "docs": "Get average packet loss for the given timespan for all networks in the organization." }, { "info": { "name": "Return a record of power mode changes for wireless devices in the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/power/mode/history", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 1 day from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 1 day after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 1 day. The default is 1 day." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 20. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter the result set by the included set of network IDs" }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities history by device serial numbers" } ] }, "docs": "Return a record of power mode changes for wireless devices in the organization. For each device, it provides a series of events with timestamps indicating when a power mode change occurred and the new mode. The events are ordered by timestamp." }, { "info": { "name": "List the zero touch deployments for wireless access points in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/provisioning/deployments", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 20." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "search", "value": "", "type": "query", "description": "Filter by MAC address, serial number, new device name, old device name, or model." }, { "name": "sortBy", "value": "", "type": "query", "description": "Field used to sort results. Default is 'status'." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order. Default is 'asc'." }, { "name": "deploymentType", "value": "", "type": "query", "description": "Filter deployments by type." } ] }, "docs": "List the zero touch deployments for wireless access points in an organization" }, { "info": { "name": "Create a zero touch deployment for a wireless access point", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/provisioning/deployments", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a zero touch deployment for a wireless access point" }, { "info": { "name": "Update a zero touch deployment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/provisioning/deployments", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a zero touch deployment" }, { "info": { "name": "Delete a zero touch deployment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/provisioning/deployments/:deploymentId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "deploymentId", "value": "", "type": "path", "description": "Deployment ID" } ] }, "docs": "Delete a zero touch deployment" }, { "info": { "name": "Query for details on the organization's RadSec device Certificate Authority certificates (CAs)", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/radsec/certificates/authorities", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "certificateAuthorityIds", "value": "", "type": "query", "description": "Optional parameter to filter CAs by one or more CA IDs. All returned CAs will have an ID that is an exact match." } ] }, "docs": "Query for details on the organization's RadSec device Certificate Authority certificates (CAs). The primary CA signs all the certificates that devices present when establishing a secure connection to RADIUS servers via RadSec protocol. This API returns an array of the status of all of the CAs as well as their contents, if they've been generated. An organization will have at most one CA unless the CA is being rotated." }, { "info": { "name": "Create an organization's RadSec device Certificate Authority (CA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/radsec/certificates/authorities", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Create an organization's RadSec device Certificate Authority (CA). Call this endpoint when turning on RadSec in the firmware for the first time. Calling this endpoint starts an asynchronous process to generate the CA; call GET afterwards to retrieve the contents of the CA. Note this CA is generated and controlled by Meraki. Subsequent calls will not generate a new CA." }, { "info": { "name": "Update an organization's RadSec device Certificate Authority (CA) state", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/radsec/certificates/authorities", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an organization's RadSec device Certificate Authority (CA) state. Note this CA is generated and controlled by Meraki. Call this endpoint to update the state to \"trusted\", at which point Meraki will generate device certificates. \"trusted\" means the CA is placed on your RadSec server(s) and devices establishing a secure connection using certs signed by this CA will pass verification." }, { "info": { "name": "Query for certificate revocation list (CRL) for the organization's RadSec device Certificate Authorities (CAs).", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/radsec/certificates/authorities/crls", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "certificateAuthorityIds", "value": "", "type": "query", "description": "Optional parameter to filter CAs by one or more CA IDs. All returned CAs will have an ID that is an exact match." } ] }, "docs": "Query for certificate revocation list (CRL) for the organization's RadSec device Certificate Authorities (CAs)." }, { "info": { "name": "Query for all delta certificate revocation list (CRL) for the organization's RadSec device Certificate Authority (CA) with the given id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/radsec/certificates/authorities/crls/deltas", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "certificateAuthorityIds", "value": "", "type": "query", "description": "Parameter to filter CAs by one or more CA IDs. All returned CAs will have an ID that is an exact match." } ] }, "docs": "Query for all delta certificate revocation list (CRL) for the organization's RadSec device Certificate Authority (CA) with the given id." }, { "info": { "name": "Return the CPU Load history for a list of wireless devices in the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/system/cpu/load/history", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 1 day from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 1 day after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 1 day. The default is 1 day." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 20. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter the result set by the included set of network IDs" }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities history by device serial numbers" } ] }, "docs": "Return the CPU Load history for a list of wireless devices in the organization." }, { "info": { "name": "List of Catalyst access points information", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/devices/wirelessControllers/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter access points by network ID. This filter uses multiple exact matches." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter access points by its cloud ID. This filter uses multiple exact matches." }, { "name": "controllerSerials", "value": "", "type": "query", "description": "Optional parameter to filter access points by its wireless LAN controller cloud ID. This filter uses multiple exact matches." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." } ] }, "docs": "List of Catalyst access points information" }, { "info": { "name": "Return scanning API settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/location/scanning/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 250. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter scanning settings by network ID." } ] }, "docs": "Return scanning API settings" }, { "info": { "name": "Return scanning API receivers", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/location/scanning/receivers", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 250. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter scanning API receivers by network ID." } ] }, "docs": "Return scanning API receivers" }, { "info": { "name": "Add new receiver for scanning API", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/location/scanning/receivers", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add new receiver for scanning API" }, { "info": { "name": "Change scanning API receiver settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/location/scanning/receivers/:receiverId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "receiverId", "value": "", "type": "path", "description": "Receiver ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change scanning API receiver settings" }, { "info": { "name": "Delete a scanning API receiver", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/location/scanning/receivers/:receiverId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "receiverId", "value": "", "type": "path", "description": "Receiver ID" } ] }, "docs": "Delete a scanning API receiver" }, { "info": { "name": "Return MQTT Settings for networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/mqtt/settings", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 250. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter mqtt settings by network ID." } ] }, "docs": "Return MQTT Settings for networks" }, { "info": { "name": "Add new broker config for wireless MQTT", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/mqtt/settings", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add new broker config for wireless MQTT" }, { "info": { "name": "Recalculates automatically assigned channels for every AP within specified the specified network(s)", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/radio/autoRf/channels/recalculate", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Recalculates automatically assigned channels for every AP within specified the specified network(s). Note: This could cause a brief loss in connectivity for wireless clients." }, { "info": { "name": "List the AutoRF settings of an organization by network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/radio/rrm/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter results by network." }, { "name": "startingAfter", "value": "", "type": "query", "description": "Retrieving items after this network ID" }, { "name": "endingBefore", "value": "", "type": "query", "description": "Retrieving items before this network ID" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order of items" } ] }, "docs": "List the AutoRF settings of an organization by network" }, { "info": { "name": "List the RF profiles of an organization by device", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/rfProfiles/assignments/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter devices by network." }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway, and secureConnect." }, { "name": "name", "value": "", "type": "query", "description": "Optional parameter to filter RF profiles by device name. All returned devices will have a name that contains the search term or is an exact match." }, { "name": "mac", "value": "", "type": "query", "description": "Optional parameter to filter RF profiles by device MAC address. All returned devices will have a MAC address that contains the search term or is an exact match." }, { "name": "serial", "value": "", "type": "query", "description": "Optional parameter to filter RF profiles by device serial number. All returned devices will have a serial number that contains the search term or is an exact match." }, { "name": "model", "value": "", "type": "query", "description": "Optional parameter to filter RF profiles by device model. All returned devices will have a model that contains the search term or is an exact match." }, { "name": "macs", "value": "", "type": "query", "description": "Optional parameter to filter RF profiles by one or more device MAC addresses. All returned devices will have a MAC address that is an exact match." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter RF profiles by one or more device serial numbers. All returned devices will have a serial number that is an exact match." }, { "name": "models", "value": "", "type": "query", "description": "Optional parameter to filter RF profiles by one or more device models. All returned devices will have a model that is an exact match." } ] }, "docs": "List the RF profiles of an organization by device" }, { "info": { "name": "List the L2 isolation allow list MAC entry in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/ssids/firewall/isolation/allowlist/entries", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "networkIds array to filter out results" }, { "name": "ssids", "value": "", "type": "query", "description": "ssids number array to filter out results" } ] }, "docs": "List the L2 isolation allow list MAC entry in an organization" }, { "info": { "name": "Create isolation allow list MAC entry for this organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/ssids/firewall/isolation/allowlist/entries", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create isolation allow list MAC entry for this organization" }, { "info": { "name": "Update isolation allow list MAC entry info", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/ssids/firewall/isolation/allowlist/entries/:entryId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "entryId", "value": "", "type": "path", "description": "Entry ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update isolation allow list MAC entry info" }, { "info": { "name": "Destroy isolation allow list MAC entry for this organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/ssids/firewall/isolation/allowlist/entries/:entryId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "entryId", "value": "", "type": "path", "description": "Entry ID" } ] }, "docs": "Destroy isolation allow list MAC entry for this organization" }, { "info": { "name": "Returns an array of objects, each containing SSID OpenRoaming configs for the corresponding network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/ssids/openRoaming/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter OpenRoaming configuration by Network Id." }, { "name": "includeDisabledSsids", "value": "", "type": "query", "description": "Optional parameter to include OpenRoaming configuration for disabled ssids." } ] }, "docs": "Returns an array of objects, each containing SSID OpenRoaming configs for the corresponding network" }, { "info": { "name": "List status information of all BSSIDs in your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/ssids/statuses/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter the result set by the included set of network IDs" }, { "name": "serials", "value": "", "type": "query", "description": "A list of serial numbers. The returned devices will be filtered to only include these serials." }, { "name": "bssids", "value": "", "type": "query", "description": "A list of BSSIDs. The returned devices will be filtered to only include these BSSIDs." }, { "name": "hideDisabled", "value": "", "type": "query", "description": "If true, the returned devices will not include disabled SSIDs. (default: true)" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 500. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." } ] }, "docs": "List status information of all BSSIDs in your organization" }, { "info": { "name": "Return list of Zigbee configs", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/zigbee/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter by specified Network IDs" } ] }, "docs": "Return list of Zigbee configs" }, { "info": { "name": "List the Zigbee wireless devices for an organization or the supplied network(s)", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/zigbee/devices", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "networkIds", "value": "", "type": "query", "description": "Parameter of networks you want the zigbee devices for. E.g.: networkIds[]=N_12345678&networkIds[]=N_3456" }, { "name": "isEnrolled", "value": "", "type": "query", "description": "Filter devices based on if they are enrolled or not" }, { "name": "search", "value": "", "type": "query", "description": "Filter devices by their name, tag or serial" } ] }, "docs": "List the Zigbee wireless devices for an organization or the supplied network(s)" }, { "info": { "name": "Endpoint to update zigbee gateways", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/zigbee/devices/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Endpoint to update zigbee gateways" }, { "info": { "name": "Enqueue a job to start disenrolling door locks on zigbee configured wireless devices", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/zigbee/disenrollments", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enqueue a job to start disenrolling door locks on zigbee configured wireless devices" }, { "info": { "name": "Return a disenrollment", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/zigbee/disenrollments/:disenrollmentId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "disenrollmentId", "value": "", "type": "path", "description": "Disenrollment ID" } ] }, "docs": "Return a disenrollment" }, { "info": { "name": "Return the list of door locks for a network", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/zigbee/doorLocks", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter by specified Network IDs" }, { "name": "serial", "value": "", "type": "query", "description": "Filter by device serial" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 500. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { "name": "endingBefore", "value": "", "type": "query", "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." } ] }, "docs": "Return the list of door locks for a network" }, { "info": { "name": "Endpoint to batch update door locks params", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/wireless/zigbee/doorLocks/:doorLockId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "doorLockId", "value": "", "type": "path", "description": "Door lock ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Endpoint to batch update door locks params" } ] } ], "bundled": true }