Meraki APIs

Home

1 Meraki API

1.1 Merkai v0 api (obsolete as of March 2020)

Open a REST call to https://api.meraki.com/api/v0 that then does a redirect to https://n149.meraki.com/api/v0 You can go directly to the cluster that your orgainization resides in, once you get the redirect back the first time. The redirect will show a response code of 302 for a GET request and a 307 or 308 for a POST, PUT, and DELETE requests.

You will need to supply the header X-Cisco-Meraki-API-Key that you retrieved earlier from logging into dashboard.meraki.com. Once you have that the best practice is to set an environment variable to this key. curl used -H

-H 'X-Cisco-Meraki-API-key: 15da0c6ffff295f16267f88f98694cf29a86ed87'

1.1.1 v0 base URL

That is called the base URL i.e. https://api.meraki.com/api/v0 Also referred to the cluster version i.e. https://n149.meraki.com/api/v0

For all the other requests you specify how you want the data back. Meraki supports json, so the header to use is:

  • -H 'Accept: application/json'

1.1.2 /organizations

Next you get the organization ID related to your API key by appending

/organizations

to the base. i.e. https://n149.meraki.Com/api/v0/organizations For brevity assume you get back an orgainization id of 271828

1.1.3 networks

Next, you can get a list of the networks under this organization with

/organizations/271828/networks

to the base. i.e. https://n149.meraki.Com/api/v0/organizations/271828/networks

You'll get back a list of network ids such as N_646829496481152899 (among other data that is returned)

1.1.4 devices

Now that you have a network ID, you can use that to get a list of all devices on that network with /networks/{networkId}/devices

https://n149.meraki.Com/api/v0/networks/N_646829496481152899/devices

https://api.meraki.com/api/v1/organizations.

1.2 Meraki API v1

Very similar to the above v0 but with some key differences.

You will still need to supply the header X-Cisco-Meraki-API-Key

  • curl: -H 'X-Cisco-Meraki-API-key: 15da0c6ffff295f16267f88f98694cf29a86ed87'
  • json
    {
        "X-Cisco-Meraki-API-Key": <Meraki_API_Key>
    }
    
  • Python
    import meraki
    dashboard = meraki.DashboardAPI(API_KEY)
    

1.2.1 v1 base URL

The base URL is https://api.meraki.com/api/v1 Also referred to the cluster version i.e. https://n149.meraki.com/api/v1

For all the other requests you specify how you want the data back. Meraki supports json, so the header to use is:

  • -H 'Accept: application/json'

1.2.2 v1 /organizations

Next you get the organization ID related to your API key by appending

/organizations

to the base. i.e. https://api.meraki.com/api/v1/organizations For brevity assume you get back an orgainization id of 271828

curl https://api.meraki.com/api/v1/organizations \
  -L -H 'X-Cisco-Meraki-API-Key: {MERAKI-API-KEY}'

1.2.3 networks

Next, you can get a list of the networks under this organization with

/organizations/271828/networks

to the base. i.e. https://api.meraki.com/api/v1/organizations/271828/networks

You'll get back a list of network ids such as N_646829496481152899 (among other data that is returned)

curl https://api.meraki.com/api/v1/organizations/271828/networks \
  -L -H 'X-Cisco-Meraki-API-Key: {MERAKI-API-KEY}'

1.2.4 devices

Now that you have a network ID, you can use that to get a list of all devices on that network with /networks/{networkId}/devices

https://api.meraki.com/api/v1/networks/N_646829496481152899/devices

https://api.meraki.com/api/v1/organizations.

1.2.5 wireless SSIDs

I'm just going to give you the URL: https://api.meraki.com/api/v1/networks/N_646829496481152899/wireless/ssids

1.3 Meraki API v0 vs v1

So you can see that the URLs are in fact very similar, except v1 does auto re-direct so you always use the api.meraki.com site, not n77.meraki.com

The second main difference is in the python libraries. The v0 had an SDK where the v1 replaces that with a python library.

2 Python SDK (v0) and Library (v1)

As mentioned above, the v0 SDK did this:

2.1 v0 Python SDK

First you had to pip install meraki-sdk in your virtual environment (venv)

Then you could import and use the MerakiSdkClient class from the meraki_sdk module like so:

from meraki_sdk.meraki_sdk_client import MerakiSdkClient
# set the key
X_CISCO_MERAKI_API_KEY = "blah blah blah"  # get from environment variable

MY_MERAKI_INSTANCE = MerakiSdkClient(X_CISCO_MERAKI_API_KEY)

ORGS = MY_MERAKI_INSTANCE.organizations.get_organizations()

for ORG in ORGS:
    print(f'Org ID: {ORG["id"]}, has name {ORG["name"]}')

PARAMS = {}  # a dictionary that the python SDK uses
PARAMS["organization_id"] = "271828"

NETS = MY_MERAKI_INSTANCE.networks.get_organization_net-works(PARAMS)

for NET in NETS:
    print(f'Network ID: {NET["id"]} -> Name: {NET["name"]}, Tag: {str(NET["tags"])}')

DEVICES = MY_MERAKI_INSTANCE.devices.get_network_devices("N_646829496481152899")

for DEVICE in DEVICES:
    print(f"Device model: {DEVICE['model']} Serial number: {DEVICE['serial']}, Mac addr: {DEVICE['mac']}")

2.2 v1 Python Library

With v1 the MerakiSdkClient is deprecated (Dec 2020) So now we import the meraki library.

API_KEY = "blah blah blah"
import meraki

dashboard = meraki.DashboardAPI(API_KEY)
response = dashboard.orgainizations.getOrganizations()
print(response)

response = dashboard.orgainizations.getOrganizationNetworks('271828')
print(response)

response = dashboard.networks.getNetworkDevices(net_id)

The v1 python resposne will be a list, containing 1 entry which is a dictionary

[{'id': '549236',
  'name': 'DevNet Sandbox',
  'url': 'https://n149.meraki.com/o/-t35Mb/manage/organization/overview'}]

This is the output of help(dashboard) after running dashboard = meraki.DashboardAPI()

Help on DashboardAPI in module meraki object:

class DashboardAPI(builtins.object) DashboardAPI(apikey=None, baseurl='https://api.meraki.com/api/v1', singlerequesttimeout=60, certificatepath='', requestsproxy='', waitonratelimit=True, nginx429retrywaittime=60, actionbatchretrywaittime=60, retry4xxerror=False, retry4xxerrorwaittime=60, maximumretries=2, outputlog=True, logpath='', logfileprefix='merakiapi_', printconsole=True, suppresslogging=False, simulate=False, begeoid='', caller='')

Creates a persistent Meraki dashboard API session

  • apikey (string): API key generated in dashboard; can also be set as an environment variable MERAKIDASHBOARDAPIKEY
  • baseurl (string): preceding all endpoint resources
  • singlerequesttimeout (integer): maximum number of seconds for each API call
  • certificatepath (string): path for TLS/SSL certificate verification if behind local proxy
  • requestsproxy (string): proxy server and port, if needed, for HTTPS
  • waitonratelimit (boolean): retry if 429 rate limit error encountered?
  • nginx429retrywaittime (integer): Nginx 429 retry wait time
  • actionbatchretrywaittime (integer): action batch concurrency error retry wait time
  • retry4xxerror (boolean): retry if encountering other 4XX error (besides 429)?
  • retry4xxerrorwaittime (integer): other 4XX error retry wait time
  • maximumretries (integer): retry up to this many times when encountering 429s or other server-side errors
  • outputlog (boolean): create an output log file?
  • logpath (string): path to output log; by default, working directory of script if not specified
  • logfileprefix (string): log file name appended with date and timestamp
  • printconsole (boolean): print logging output to console?
  • suppresslogging (boolean): disable all logging? you're on your own then!
  • simulate (boolean): simulate POST/PUT/DELETE calls to prevent changes?
  • begeoid (string): optional partner identifier for API usage tracking; can also be set as an environment variable BEGEOID
  • caller (string): optional identifier for API usage tracking; can also be set as an environment variable MERAKIPYTHONSDKCALLER

Methods defined here:

_init__(self, apikey=None, baseurl='https://api.meraki.com/api/v1', singlerequesttimeout=60, certificatepath='', requestsproxy='', waitonratelimit=True, nginx429retrywaittime=60, actionbatchretrywaittime=60, retry4xxerror=False, retry4xxerrorwaittime=60, maximumretries=2, outputlog=True, logpath='', logfileprefix='merakiapi', printconsole=True, suppresslogging=False, simulate=False, begeoid='', caller='') Initialize self. See help(type(self)) for accurate signature.


Data descriptors defined here:

dict dictionary for instance variables (if defined)

weakref list of weak references to the object (if defined) (END)

and here is dashboard.__dict__

Out[10]: 
{'_logger': <Logger meraki (DEBUG)>,
 '_log_file': 'meraki_api__log__2021-03-07_10-26-36.log',
 '_session': <meraki.rest_session.RestSession at 0x102bd58b0>,
 'organizations': <meraki.api.organizations.Organizations at 0x102bd5850>,
 'networks': <meraki.api.networks.Networks at 0x102c8fb20>,
 'devices': <meraki.api.devices.Devices at 0x10303e040>,
 'appliance': <meraki.api.appliance.Appliance at 0x102ba2d30>,
 'camera': <meraki.api.camera.Camera at 0x10303e4f0>,
 'cellularGateway': <meraki.api.cellularGateway.CellularGateway at 0x10303e160>,
 'insight': <meraki.api.insight.Insight at 0x10303e5b0>,
 'sm': <meraki.api.sm.Sm at 0x10303e1f0>,
 'switch': <meraki.api.switch.Switch at 0x10303ee80>,
 'wireless': <meraki.api.wireless.Wireless at 0x10303e9a0>}

In [11]:

And here is help(dashboard.wireless)

Help on Wireless in module meraki.api.wireless object:

class Wireless(builtins.object) Wireless(session)

Methods defined here:

_init_(self, session) Initialize self. See help(type(self)) for accurate signature.

createNetworkWirelessRfProfile(self, networkId: str, name: str, bandSelectionType: str, kwargs) **Creates new RF profile for this network https://developer.cisco.com/meraki/api-v1/#!create-network-wireless-rf-profile

  • networkId (string): (required)
  • name (string): The name of the new profile. Must be unique. This param is required on creation.
  • bandSelectionType (string): Band selection can be set to either 'ssid' or 'ap'. This param is required on creation.
  • clientBalancingEnabled (boolean): Steers client to best available access point. Can be either true or false. Defaults to true.
  • minBitrateType (string): Minimum bitrate can be set to either 'band' or 'ssid'. Defaults to band.
  • apBandSettings (object): Settings that will be enabled if selectionType is set to 'ap'.
  • twoFourGhzSettings (object): Settings related to 2.4Ghz band
  • fiveGhzSettings (object): Settings related to 5Ghz band

createNetworkWirelessSsidIdentityPsk(self, networkId: str, number: str, name: str, passphrase: str, groupPolicyId: str) Create an Identity PSK https://developer.cisco.com/meraki/api-v1/#!create-network-wireless-ssid-identity-psk

  • networkId (string): (required)
  • number (string): (required)
  • name (string): The name of the Identity PSK
  • passphrase (string): The passphrase for client authentication
  • groupPolicyId (string): The group policy to be applied to clients

deleteNetworkWirelessRfProfile(self, networkId: str, rfProfileId: str) Delete a RF Profile https://developer.cisco.com/meraki/api-v1/#!delete-network-wireless-rf-profile

  • networkId (string): (required)
  • rfProfileId (string): (required)

deleteNetworkWirelessSsidIdentityPsk(self, networkId: str, number: str, identityPskId: str) Delete an Identity PSK https://developer.cisco.com/meraki/api-v1/#!delete-network-wireless-ssid-identity-psk

  • networkId (string): (required)
  • number (string): (required)
  • identityPskId (string): (required)

getDeviceWirelessBluetoothSettings(self, serial: str) Return the bluetooth settings for a wireless device https://developer.cisco.com/meraki/api-v1/#!get-device-wireless-bluetooth-settings

  • serial (string): (required)

getDeviceWirelessConnectionStats(self, serial: str, kwargs) **Aggregated connectivity info for a given AP on this network https://developer.cisco.com/meraki/api-v1/#!get-device-wireless-connection-stats

  • serial (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag

getDeviceWirelessLatencyStats(self, serial: str, kwargs) **Aggregated latency info for a given AP on this network https://developer.cisco.com/meraki/api-v1/#!get-device-wireless-latency-stats

  • serial (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag
  • fields (string): 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.

getDeviceWirelessRadioSettings(self, serial: str) Return the radio settings of a device https://developer.cisco.com/meraki/api-v1/#!get-device-wireless-radio-settings

  • serial (string): (required)

getDeviceWirelessStatus(self, serial: str) Return the SSID statuses of an access point https://developer.cisco.com/meraki/api-v1/#!get-device-wireless-status

  • serial (string): (required)

getNetworkWirelessAirMarshal(self, networkId: str, kwargs) **List Air Marshal scan results from a network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-air-marshal

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
  • timespan (number): 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.

getNetworkWirelessAlternateManagementInterface(self, networkId: str) Return alternate management interface and devices with IP assigned https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-alternate-management-interface

  • networkId (string): (required)

getNetworkWirelessBilling(self, networkId: str) Return the billing settings of this network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-billing

  • networkId (string): (required)

getNetworkWirelessBluetoothSettings(self, networkId: str) Return the Bluetooth settings for a network. <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings</a> must be enabled on the network. https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-bluetooth-settings

  • networkId (string): (required)

getNetworkWirelessChannelUtilizationHistory(self, networkId: str, kwargs) **Return AP channel utilization over time for a device or network client https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-channel-utilization-history

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
  • timespan (number): 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.
  • resolution (integer): The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400.
  • autoResolution (boolean): Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
  • clientId (string): Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history.
  • deviceSerial (string): Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified.
  • apTag (string): 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.
  • band (string): Filter results by band (either '2.4' or '5').

getNetworkWirelessClientConnectionStats(self, networkId: str, clientId: str, kwargs) **Aggregated connectivity info for a given client on this network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-client-connection-stats

  • networkId (string): (required)
  • clientId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag

getNetworkWirelessClientConnectivityEvents(self, networkId: str, clientId: str, totalpages=1, direction='next', kwargs) **List the wireless connectivity events for a client within a network in the timespan. https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-client-connectivity-events

  • networkId (string): (required)
  • clientId (string): (required)
  • totalpages (integer or string): use with perPage to get total results up to totalpages*perPage; -1 or "all" for all pages
  • direction (string): direction to paginate, either "next" (default) or "prev" page
  • perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000.
  • startingAfter (string): 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.
  • endingBefore (string): 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.
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
  • timespan (number): 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.
  • types (array): 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'.
  • includedSeverities (array): 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'.
  • band (string): Filter results by band (either '2.4' or '5').
  • ssidNumber (integer): An SSID number to include. If not specified, events for all SSIDs will be returned.
  • deviceSerial (string): Filter results by an AP's serial number.

getNetworkWirelessClientCountHistory(self, networkId: str, kwargs) **Return wireless client counts over time for a network, device, or network client https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-client-count-history

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
  • timespan (number): 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.
  • resolution (integer): The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
  • autoResolution (boolean): Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
  • clientId (string): Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history.
  • deviceSerial (string): Filter results by device.
  • apTag (string): Filter results by AP tag.
  • band (string): Filter results by band (either '2.4' or '5').
  • ssid (integer): Filter results by SSID number.

getNetworkWirelessClientLatencyHistory(self, networkId: str, clientId: str, kwargs) **Return the latency history for a client https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-client-latency-history

  • networkId (string): (required)
  • clientId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 791 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 791 days after t0.
  • timespan (number): 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.
  • resolution (integer): The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400.

getNetworkWirelessClientLatencyStats(self, networkId: str, clientId: str, kwargs) **Aggregated latency info for a given client on this network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-client-latency-stats

  • networkId (string): (required)
  • clientId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag
  • fields (string): 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.

getNetworkWirelessClientsConnectionStats(self, networkId: str, kwargs) **Aggregated connectivity info for this network, grouped by clients https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-clients-connection-stats

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag

getNetworkWirelessDataRateHistory(self, networkId: str, kwargs) **Return PHY data rates over time for a network, device, or network client https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-data-rate-history

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
  • timespan (number): 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.
  • resolution (integer): The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
  • autoResolution (boolean): Automatically select a data resolution based on the given timespan; this overrides the value specified

the 'resolution' parameter. The default setting is false.

  • clientId (string): Filter results by network client.
  • deviceSerial (string): Filter results by device.
  • apTag (string): Filter results by AP tag.
  • band (string): Filter results by band (either '2.4' or '5').
  • ssid (integer): Filter results by SSID number.

getNetworkWirelessDevicesConnectionStats(self, networkId: str, kwargs) **Aggregated connectivity info for this network, grouped by node https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-devices-connection-stats

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag

getNetworkWirelessDevicesLatencyStats(self, networkId: str, kwargs) **Aggregated latency info for this network, grouped by node https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-devices-latency-stats

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag
  • fields (string): 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.

getNetworkWirelessFailedConnections(self, networkId: str, kwargs) **List of all failed client connection events on this network in a given time range https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-failed-connections

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag
  • serial (string): Filter by AP
  • clientId (string): Filter by client MAC

getNetworkWirelessLatencyHistory(self, networkId: str, kwargs) **Return average wireless latency over time for a network, device, or network client https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-latency-history

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
  • timespan (number): 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.
  • resolution (integer): The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
  • autoResolution (boolean): Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
  • clientId (string): Filter results by network client.
  • deviceSerial (string): Filter results by device.
  • apTag (string): Filter results by AP tag.
  • band (string): Filter results by band (either '2.4' or '5').
  • ssid (integer): Filter results by SSID number.
  • accessCategory (string): Filter by access category.

getNetworkWirelessLatencyStats(self, networkId: str, kwargs) **Aggregated latency info for this network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-latency-stats

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
  • timespan (number): 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.
  • band (string): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information:
  • ssid (integer): Filter results by SSID
  • vlan (integer): Filter results by VLAN
  • apTag (string): Filter results by AP Tag
  • fields (string): 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.

getNetworkWirelessMeshStatuses(self, networkId: str, totalpages=1, direction='next', kwargs) **List wireless mesh statuses for repeaters https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-mesh-statuses

  • networkId (string): (required)
  • totalpages (integer or string): use with perPage to get total results up to totalpages*perPage; -1 or "all" for all pages
  • direction (string): direction to paginate, either "next" (default) or "prev" page
  • perPage (integer): The number of entries per page returned. Acceptable range is 3 - 500. Default is 50.
  • startingAfter (string): 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.
  • endingBefore (string): 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.

getNetworkWirelessRfProfile(self, networkId: str, rfProfileId: str) Return a RF profile https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-rf-profile

  • networkId (string): (required)
  • rfProfileId (string): (required)

getNetworkWirelessRfProfiles(self, networkId: str, kwargs) **List the non-basic RF profiles for this network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-rf-profiles

  • networkId (string): (required)
  • includeTemplateProfiles (boolean): 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.

getNetworkWirelessSettings(self, networkId: str) Return the wireless settings for a network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-settings

  • networkId (string): (required)

getNetworkWirelessSignalQualityHistory(self, networkId: str, kwargs) **Return signal quality (SNR/RSSI) over time for a device or network client https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-signal-quality-history

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
  • timespan (number): 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.
  • resolution (integer): The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
  • autoResolution (boolean): Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
  • clientId (string): Filter results by network client.
  • deviceSerial (string): Filter results by device.
  • apTag (string): Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified.
  • band (string): Filter results by band (either '2.4' or '5').
  • ssid (integer): Filter results by SSID number.

getNetworkWirelessSsid(self, networkId: str, number: str) Return a single MR SSID https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssid

  • networkId (string): (required)
  • number (string): (required)

getNetworkWirelessSsidDeviceTypeGroupPolicies(self, networkId: str, number: str) List the device type group policies for the SSID https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssid-device-type-group-policies

  • networkId (string): (required)
  • number (string): (required)

getNetworkWirelessSsidFirewallL3FirewallRules(self, networkId: str, number: str) Return the L3 firewall rules for an SSID on an MR network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssid-firewall-l-3-firewall-rules

  • networkId (string): (required)
  • number (string): (required)

getNetworkWirelessSsidFirewallL7FirewallRules(self, networkId: str, number: str) Return the L7 firewall rules for an SSID on an MR network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssid-firewall-l-7-firewall-rules

  • networkId (string): (required)
  • number (string): (required)

getNetworkWirelessSsidIdentityPsk(self, networkId: str, number: str, identityPskId: str) Return an Identity PSK https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssid-identity-psk

  • networkId (string): (required)
  • number (string): (required)
  • identityPskId (string): (required)

getNetworkWirelessSsidIdentityPsks(self, networkId: str, number: str) List all Identity PSKs in a wireless network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssid-identity-psks

  • networkId (string): (required)
  • number (string): (required)

getNetworkWirelessSsidSplashSettings(self, networkId: str, number: str) Display the splash page settings for the given SSID https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssid-splash-settings

  • networkId (string): (required)
  • number (string): (required)

getNetworkWirelessSsidTrafficShapingRules(self, networkId: str, number: str) Display the traffic shaping settings for a SSID on an MR network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssid-traffic-shaping-rules

  • networkId (string): (required)
  • number (string): (required)

getNetworkWirelessSsids(self, networkId: str) List the MR SSIDs in a network https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-ssids

  • networkId (string): (required)

getNetworkWirelessUsageHistory(self, networkId: str, kwargs) **Return AP usage over time for a device or network client https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-usage-history

  • networkId (string): (required)
  • t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
  • t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
  • timespan (number): 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.
  • resolution (integer): The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
  • autoResolution (boolean): Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
  • clientId (string): Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history.
  • deviceSerial (string): Filter results by device. Requires :band.
  • apTag (string): Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified.
  • band (string): Filter results by band (either '2.4' or '5').
  • ssid (integer): Filter results by SSID number.

updateDeviceWirelessBluetoothSettings(self, serial: str, kwargs) **Update the bluetooth settings for a wireless device https://developer.cisco.com/meraki/api-v1/#!update-device-wireless-bluetooth-settings

  • serial (string): (required)
  • uuid (string): Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.
  • major (integer): Desired major value of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.
  • minor (integer): Desired minor value of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.

updateDeviceWirelessRadioSettings(self, serial: str, kwargs) **Update the radio settings of a device https://developer.cisco.com/meraki/api-v1/#!update-device-wireless-radio-settings

  • serial (string): (required)
  • rfProfileId (integer): The ID of an RF profile to assign to the device. If the value of this parameter is null, the appropriate basic RF profile (indoor or outdoor) will be assigned to the device. Assigning an RF profile will clear ALL manually configured overrides on the device (channel width, channel, power).
  • twoFourGhzSettings (object): Manual radio settings for 2.4 GHz.
  • fiveGhzSettings (object): Manual radio settings for 5 GHz.

updateNetworkWirelessAlternateManagementInterface(self, networkId: str, kwargs) **Update alternate management interface and device static IP https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-alternate-management-interface

  • networkId (string): (required)
  • enabled (boolean): Boolean value to enable or disable alternate management interface
  • vlanId (integer): Alternate management interface VLAN, must be between 1 and 4094
  • protocols (array): Can be one or more of the following values: 'radius', 'snmp', 'syslog' or 'ldap'
  • accessPoints (array): Array of access point serial number and IP assignment. Note: accessPoints IP assignment is not applicable for template networks, in other words, do not put 'accessPoints' in the body when updating template networks. Also, an empty 'accessPoints' array will remove all previous static IP assignments

updateNetworkWirelessBilling(self, networkId: str, kwargs) **Update the billing settings https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-billing

  • networkId (string): (required)
  • currency (string): The currency code of this node group's billing plans
  • plans (array): Array of billing plans in the node group. (Can configure a maximum of 5)

updateNetworkWirelessBluetoothSettings(self, networkId: str, kwargs) **Update the Bluetooth settings for a network https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-bluetooth-settings

  • networkId (string): (required)
  • scanningEnabled (boolean): Whether APs will scan for Bluetooth enabled clients. (true, false)
  • advertisingEnabled (boolean): Whether APs will advertise beacons. (true, false)
  • uuid (string): The UUID to be used in the beacon identifier.
  • majorMinorAssignmentMode (string): The way major and minor number should be assigned to nodes in the network. ('Unique', 'Non-unique')
  • major (integer): The major number to be used in the beacon identifier. Only valid in 'Non-unique' mode.
  • minor (integer): The minor number to be used in the beacon identifier. Only valid in 'Non-unique' mode.

updateNetworkWirelessRfProfile(self, networkId: str, rfProfileId: str, kwargs) **Updates specified RF profile for this network https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-rf-profile

  • networkId (string): (required)
  • rfProfileId (string): (required)
  • name (string): The name of the new profile. Must be unique.
  • clientBalancingEnabled (boolean): Steers client to best available access point. Can be either true or false.
  • minBitrateType (string): Minimum bitrate can be set to either 'band' or 'ssid'.
  • bandSelectionType (string): Band selection can be set to either 'ssid' or 'ap'.
  • apBandSettings (object): Settings that will be enabled if selectionType is set to 'ap'.
  • twoFourGhzSettings (object): Settings related to 2.4Ghz band
  • fiveGhzSettings (object): Settings related to 5Ghz band

updateNetworkWirelessSettings(self, networkId: str, kwargs) **Update the wireless settings for a network https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-settings

  • networkId (string): (required)
  • meshingEnabled (boolean): Toggle for enabling or disabling meshing in a network
  • ipv6BridgeEnabled (boolean): Toggle for enabling or disabling IPv6 bridging in a network (Note: if enabled, SSIDs must also be configured to use bridge mode)
  • locationAnalyticsEnabled (boolean): Toggle for enabling or disabling location analytics for your network
  • upgradeStrategy (string): The upgrade strategy to apply to the network. Must be one of 'minimizeUpgradeTime' or 'minimizeClientDowntime'. Requires firmware version MR 26.8 or higher'
  • ledLightsOn (boolean): Toggle for enabling or disabling LED lights on all APs in the network (making them run dark)

updateNetworkWirelessSsid(self, networkId: str, number: str, kwargs) **Update the attributes of an MR SSID https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid

  • networkId (string): (required)
  • number (string): (required)
  • name (string): The name of the SSID
  • enabled (boolean): Whether or not the SSID is enabled
  • authMode (string): The association control method for the SSID ('open', 'psk', 'open-with-radius', '8021x-meraki', '8021x-radius', '8021x-google', '8021x-localradius', 'ipsk-with-radius' or 'ipsk-without-radius')
  • enterpriseAdminAccess (string): Whether or not an SSID is accessible by 'enterprise' administrators ('access disabled' or 'access enabled')
  • encryptionMode (string): The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'
  • psk (string): The passkey for the SSID. This param is only valid if the authMode is 'psk'
  • wpaEncryptionMode (string): The types of WPA encryption. ('WPA1 only', 'WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode' or 'WPA3 only')
  • dot11w (object): The current setting for Protected Management Frames (802.11w).
  • dot11r (object): The current setting for 802.11r
  • splashPage (string): The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth', 'Sponsored guest' or 'Cisco ISE'). This attribute is not supported for template children.
  • splashGuestSponsorDomains (array): Array of valid sponsor email domains for sponsored guest splash type.
  • ldap (object): The current setting for LDAP. Only valid if splashPage is 'Password-protected with LDAP'.
  • activeDirectory (object): The current setting for Active Directory. Only valid if splashPage is 'Password-protected with Active Directory'
  • radiusServers (array): The RADIUS 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'
  • radiusProxyEnabled (boolean): If true, Meraki devices will proxy RADIUS messages through the Meraki cloud to the configured RADIUS auth and accounting servers.
  • radiusTestingEnabled (boolean): If true, Meraki devices will periodically send Access-Request messages to configured RADIUS servers using identity 'meraki8021xtest' to ensure that the RADIUS servers are reachable.
  • radiusCalledStationId (string): The template of the called station identifier to be used for RADIUS (ex. \(NODE_MAC\):\(VAP_NUM\)).
  • radiusAuthenticationNasId (string): The template of the NAS identifier to be used for RADIUS authentication (ex. \(NODE_MAC\):\(VAP_NUM\)).
  • radiusServerTimeout (integer): The amount of time for which a RADIUS client waits for a reply from the RADIUS server (must be between 1-10 seconds).
  • radiusServerAttemptsLimit (integer): The maximum number of transmit attempts after which a RADIUS server is failed over (must be between 1-5).
  • radiusFallbackEnabled (boolean): Whether or not higher priority RADIUS servers should be retried after 60 seconds.
  • radiusCoaEnabled (boolean): If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server.
  • radiusFailoverPolicy (string): This policy determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable ('Deny access' or 'Allow access')
  • radiusLoadBalancingPolicy (string): This policy determines which RADIUS server will be contacted first in an authentication attempt and the ordering of any necessary retry attempts ('Strict priority order' or 'Round robin')
  • radiusAccountingEnabled (boolean): Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'
  • radiusAccountingServers (array): The RADIUS accounting 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius' and radiusAccountingEnabled is 'true'
  • radiusAccountingInterimInterval (integer): The interval (in seconds) in which accounting information is updated and sent to the RADIUS accounting server.
  • radiusAttributeForGroupPolicies (string): Specify the RADIUS attribute used to look up group policies ('Filter-Id', 'Reply-Message', 'Airespace-ACL-Name' or 'Aruba-User-Role'). Access points must receive this attribute in the RADIUS Access-Accept message
  • ipAssignmentMode (string): The client IP assignment mode ('NAT mode', 'Bridge mode', 'Layer 3 roaming', 'Layer 3 roaming with a concentrator' or 'VPN')
  • useVlanTagging (boolean): Whether or not traffic should be directed to use specific VLANs. This param is only valid if the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'
  • concentratorNetworkId (string): The concentrator to use when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'.
  • vlanId (integer): The VLAN ID used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'
  • defaultVlanId (integer): The default VLAN ID used for 'all other APs'. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'
  • apTagsAndVlanIds (array): The list of tags and VLAN IDs used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'
  • walledGardenEnabled (boolean): Allow access to a configurable list of IP ranges, which users may access prior to sign-on.
  • walledGardenRanges (array): Specify your walled garden by entering an array of addresses, ranges using CIDR notation, domain names, and domain wildcards (e.g. '192.168.1.1/24', '192.168.37.10/32', 'www.yahoo.com', '*.google.com']). Meraki's splash page is automatically included in your walled garden.
  • radiusOverride (boolean): If true, the RADIUS response can override VLAN tag. This is not valid when ipAssignmentMode is 'NAT mode'.
  • radiusGuestVlanEnabled (boolean): Whether or not RADIUS Guest VLAN is enabled. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode
  • radiusGuestVlanId (integer): VLAN ID of the RADIUS Guest VLAN. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode
  • minBitrate (number): The minimum bitrate in Mbps. ('1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54')
  • bandSelection (string): The client-serving radio frequencies. ('Dual band operation', '5 GHz band only' or 'Dual band operation with Band Steering')
  • perClientBandwidthLimitUp (integer): The upload bandwidth limit in Kbps. (0 represents no limit.)
  • perClientBandwidthLimitDown (integer): The download bandwidth limit in Kbps. (0 represents no limit.)
  • perSsidBandwidthLimitUp (integer): The total upload bandwidth limit in Kbps. (0 represents no limit.)
  • perSsidBandwidthLimitDown (integer): The total download bandwidth limit in Kbps. (0 represents no limit.)
  • lanIsolationEnabled (boolean): Boolean indicating whether Layer 2 LAN isolation should be enabled or disabled. Only configurable when ipAssignmentMode is 'Bridge mode'.
  • visible (boolean): Boolean indicating whether APs should advertise or hide this SSID. APs will only broadcast this SSID if set to true
  • availableOnAllAps (boolean): Boolean indicating whether all APs should broadcast the SSID or if it should be restricted to APs matching any availability tags. Can only be false if the SSID has availability tags.
  • availabilityTags (array): Accepts a list of tags for this SSID. If availableOnAllAps is false, then the SSID will only be broadcast by APs with tags matching any of the tags in this list.
  • adaptivePolicyGroupId (string): Adaptive policy group ID this SSID is assigned to.
  • mandatoryDhcpEnabled (boolean): If true, Mandatory DHCP will enforce that clients connecting to this SSID must use the IP address assigned by the DHCP server. Clients who use a static IP address won’t be able to associate.

updateNetworkWirelessSsidDeviceTypeGroupPolicies(self, networkId: str, number: str, kwargs) **Update the device type group policies for the SSID https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-device-type-group-policies

  • networkId (string): (required)
  • number (string): (required)
  • enabled (boolean): If true, the SSID device type group policies are enabled.
  • deviceTypePolicies (array): List of device type policies.

updateNetworkWirelessSsidFirewallL3FirewallRules(self, networkId: str, number: str, kwargs) **Update the L3 firewall rules of an SSID on an MR network https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-firewall-l-3-firewall-rules

  • networkId (string): (required)
  • number (string): (required)
  • rules (array): An ordered array of the firewall rules for this SSID (not including the local LAN access rule or the default rule)
  • allowLanAccess (boolean): Allow wireless client access to local LAN (boolean value - true allows access and false denies access) (optional)

updateNetworkWirelessSsidFirewallL7FirewallRules(self, networkId: str, number: str, kwargs) **Update the L7 firewall rules of an SSID on an MR network https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-firewall-l-7-firewall-rules

  • networkId (string): (required)
  • number (string): (required)
  • rules (array): An array of L7 firewall rules for this SSID. Rules will get applied in the same order user has specified in request. Empty array will clear the L7 firewall rule configuration.

updateNetworkWirelessSsidIdentityPsk(self, networkId: str, number: str, identityPskId: str, kwargs) **Update an Identity PSK https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-identity-psk

  • networkId (string): (required)
  • number (string): (required)
  • identityPskId (string): (required)
  • name (string): The name of the Identity PSK
  • passphrase (string): The passphrase for client authentication
  • groupPolicyId (string): The group policy to be applied to clients

updateNetworkWirelessSsidSplashSettings(self, networkId: str, number: str, kwargs) **Modify the splash page settings for the given SSID https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-splash-settings

  • networkId (string): (required)
  • number (string): (required)
  • splashUrl (string): [optional] The custom splash URL of the click-through splash page. Note that the URL can be configured without necessarily being used. In order to enable the custom URL, see 'useSplashUrl'
  • useSplashUrl (boolean): [optional] Boolean indicating whether the users will be redirected to the custom splash url. A custom splash URL must be set if this is true. Note that depending on your SSID's access control settings, it may not be possible to use the custom splash URL.
  • splashTimeout (integer): Splash timeout in minutes. This will determine how often users will see the splash page.
  • redirectUrl (string): The custom redirect URL where the users will go after the splash page.
  • useRedirectUrl (boolean): The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. A custom redirect URL must be set if this is true.
  • welcomeMessage (string): The welcome message for the users on the splash page.
  • splashLogo (object): The logo used in the splash page.
  • splashImage (object): The image used in the splash page.
  • splashPrepaidFront (object): The prepaid front image used in the splash page.
  • blockAllTrafficBeforeSignOn (boolean): How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged.
  • controllerDisconnectionBehavior (string): How login attempts should be handled when the controller is unreachable. Can be either 'open', 'restricted', or 'default'.
  • allowSimultaneousLogins (boolean): Whether or not to allow simultaneous logins from different devices.
  • guestSponsorship (object): Details associated with guest sponsored splash.
  • billing (object): Details associated with billing splash.

updateNetworkWirelessSsidTrafficShapingRules(self, networkId: str, number: str, kwargs) **Update the traffic shaping settings for an SSID on an MR network https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-traffic-shaping-rules

  • networkId (string): (required)
  • number (string): (required)
  • trafficShapingEnabled (boolean): Whether traffic shaping rules are applied to clients on your SSID.
  • defaultRulesEnabled (boolean): Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
  • rules (array): An array of traffic shaping rules. Rules are applied in the order that

they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.


Data descriptors defined here:

dict dictionary for instance variables (if defined)

weakref list of weak references to the object (if defined) (END)

2.3 Home