Skip to content
plugboard.appRequest a demo

Connectors

Cisco Meraki

Read the Meraki estate (access points, switches and MX appliances) into the network pane over the Dashboard API v1. Read only.

CategoryNetwork
AuthenticationDashboard API key
Reachesapi.meraki.com
Needs an agentNo
Demo modeYes, off by default

network.listSites, network.listDevices, network.getDevice, network.listUplinks, network.listClients, network.listEvents, which feed the network page, gated by the module.network module.

Meraki is one of only two network connectors that reach a cloud API, so a managed deployment can run it with no agent at all.

Create a dedicated read-only dashboard administrator for this. A Meraki API key inherits the permissions of the administrator it belongs to and cannot be scoped down. A key made from a full-access account is a full-access key sitting in our vault, and there is no control we can apply from this side.

  1. In the Meraki dashboard, Organization, Administrators: add an administrator with read-only organisation access.
  2. Sign in as that administrator, then My Profile, API access: generate an API key. It is shown once.
  3. Organization, Settings, Dashboard API access: make sure API access is enabled for the organisation.
  4. Note the organisation ID. It is in the dashboard URL, or from GET /organizations.

Settings, Connectors, Cisco Meraki, Configure.

FieldDefaultValue
baseUrlhttps://api.meraki.comThe Dashboard API host. Leave it alone unless Meraki tells you otherwise
organizationIdemptyYour Meraki organisation ID
demoModefalseReturn a sample network, making no API calls

Configure the host here, not a versioned path. https://api.meraki.com/api/v1 produces a 404 that reads exactly like a bad API key.

FieldValue
apiKeyThe dashboard API key from the read-only administrator
NetworksEvery Meraki network in the organisation, ready to map to a campus
DevicesAccess points, switches and appliances with model, serial, MAC, LAN IP and firmware
StatusOnline, offline, alerting or dormant, with the time it was last reported
WAN uplinksPer interface, with status and public IP
ClientsOptional, and only when client tracking is on
EventsRecent network events

Alerting counts as up. A device that is alerting is reachable and reporting. It has a problem the Meraki dashboard should show, not a connectivity problem your desk should be paged for. Mapping it to down would fire your outage alerting for a whole comms cupboard every time one switch ran warm.

A status Meraki reports that we do not recognise comes back as unknown, never as down.

  • Write anything. Read only, by construction. There is no capability here that changes a Meraki configuration.
  • Report uplink loss and latency. Those live on a separate per-network time-series endpoint that is expensive against the rate limit. The pane says “not reported” rather than showing a zero somebody reads as a perfect link.
  • Cover two organisations in one instance. Each instance reads one organizationId. A Meraki organisation already contains many networks, so one instance usually covers every campus. A school with one organisation per campus, for example after a merger, adds an instance for each.
  • Report client counts per device on the inventory pass. Client counts come from the client capability, which is off unless you turn tracking on.

Meraki allows ten requests per second per organisation, bursting to thirty in two seconds, and that budget is shared across every application touching the organisation, including whatever else your school already runs against it.

The connector asks organisation-wide questions in preference to per-network ones wherever Meraki offers both, so one call covers every device on every campus instead of one call per campus per poll.

What you should not do is hold down Refresh from every connector on the network pane. That spends your allowance on your key, and Meraki’s rate limit lands on your school, not on us. The pane limits the button for that reason, and the background sweep polls without being asked.

SymptomCause
A sample network appearsdemoMode is still on
404 on everythingbaseUrl carries a path. Set the host only
401 or “invalid API key”The key was revoked, or belongs to an administrator who has been removed
Connection test passes, no devicesWrong organizationId, or the administrator has no access to that organisation
Some campuses missingTheir Meraki networks are not mapped to a Plugboard campus yet
429 from MerakiSomething else is using the same organisation’s allowance. Stop refreshing by hand
Devices appear with no campusMap each Meraki network to a campus on the network pane
No clients, everClient tracking is off until an administrator turns it on

UniFi and network hardware over SNMP fill the same pane. Every enabled network connector instance runs at once and the pane combines their results. A school with Meraki wireless and Cisco switches should configure both. Meraki, UniFi and SNMP network hardware count as one connector against your plan’s connector allowance, however many of them, or instances of them, you configure.