12-2020

Meraki Tools Google Sheets Add-on -- Verified Release

This popular little tool enables you to instantly generate Google Sheets using the Meraki API. No coding required. Simply update your API key and start running Meraki reports.

Download here.

Dashboard API Version 1.4.0 Released

Changelog

Highlights

[ wireless ]

  • New properties for MR SSIDs in a network, LDAP/AD/SplashGuest
  • New properties for MR Splash settings

[ networks ]

  • New operation for network Application Usage
  • New operation for network Application Usage History

[ organization ]

  • New operation to list webhook alertType examples

11-2020

Dashboard API Version 1.3.0 Released

Changelog

Highlights

[ networks ]

  • Meraki Authentication Users, additional ID property

  • Added Webhooks HTTP payloadTemplate property to support future integrations

[ appliance ]

  • BGP Configuration

10-2020

ServiceNow SG Connector for Meraki

We are excited to release a certified application with ServiceNow using the Meraki API. The app will import Organizations, Networks and Devices into the ServiceNow CMDB. It will also capture Meraki alerts via webhooks and link the incident to an imported device.

Get all of the details here.

Dashboard API Version 1.2.0 Released

Changelog

Highlights

[ organization ]

  • Login Security settings for an organization.

[ sm ]

  • List the devices enrolled in an SM network with various specified fields and filters
  • Force check-in a set of devices
  • Lock a set of devices
  • Add, delete, or update the tags of a set of devices
  • Move a set of devices to a new network
  • List the owners in an SM network with various specified fields and filters

[ switch ]

  • Access policies for a switch network.
  • Clone port-level and some switch-level configuration settings

[ wireless ]

  • Splash page settings --> several additional properties added

09-2020

Dashboard API Version 1.1.0 Released

Changelog

Enhancements

[ appliance ]

  • Update the traffic shaping settings rules for an MX network
  • Display the traffic shaping settings rules for an MX network
  • Display the traffic shaping settings for an MX network
  • Update the traffic shaping settings for an MX network

[ networks ]

  • Create a user configured with Meraki Authentication for a network (currently supports 802.1X and Splash Guest users, and currently, organizations have a 50,000 user cap)

[ organizations ]

  • Return the device inventory for an organization
  • Return a single device from the inventory of an organization

[ switch ]

  • Update a switch port
  • Update a switch profile port

[ wireless ]

  • Update the radio settings of a device
  • Update the attributes of an MR SSID
  • Return the radio settings of a device

08-2020

Dashboard API v1 Released!

Changelog

  • 150+ new operations
  • 100+ path changes
  • New API URL path and documentation structure
  • Built upon the OpenAPI v2 spec

05-2020

Dashboard API Version 0.11 Released

Changelog

Enhancements

[Security events]

List the security events 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.

- Response property ruleId value added


[SSIDs]

List the SSIDs in a network. Supports networks with access points or wireless-enabled security appliances and teleworker gateways.

- Response property visible value added - Response property availableOnAllAps value added - Response property availabilityTags value added


[Config templates]

List the configuration templates for this organization

- Response property timeZone value added


[Cameras]

- New operation

Returns video settings for the given camera

GET/PUT /devices/{serial}/camera/video/settings

{
    "externalRtspEnabled": true,
    "rtspUrl": "rtsp://10.0.0.1:9000/live"
}

04-2020

Dashboard API Version 0.10 Released

Enhancements

Wireless health

- Optional param band added to all operations


Alert settings

Update the alert configuration for this network

PUT /networks/{networkId}/alertSettings - Optional property httpServerIds Added


VPN

Return the third party VPN peers for an organization

GET /organizations/{organizationId}/thirdPartyVPNPeers

- Response property networkTags value added


Cameras

Update quality and retention settings for the given camera

PATH /devices/{serial}/camera/qualityAndRetentionSettings

- Optional property motionDetectorVersion Added


Clients

List the clients that have used this network in the timespan

GET /networks/{networkId}/clients

- Response property notes value added - Response property ip6Local value added - Response property smInstalled value added - Response property groupPolicy8021x value added


Switch ports

Return the status for all the ports of a switch

GET /devices/{serial}/switchPortStatuses

- Response property trafficInKbps value added


VLANs

Update a VLAN

PUT /networks/{networkId}/vlans/{vlanId}

- Optional property groupPolicyId Added


03-2020

Dashboard API Version 0.9 Released

New operations

PATH /devices/{serial}/switch/ports/cycle

Cycle a set of switch ports

POST /devices/{serial}/switch/ports/cycle

{
    "ports": [
        "1",
        "2-5",
        "1_MA-MOD-8X10G_1",
        "1_MA-MOD-8X10G_2-1_MA-MOD-8X10G_8"
    ]
}

Bluetooth settings

PATH /devices/{serial}/wireless/bluetooth/settings

Return the bluetooth settings for a wireless device

GET /devices/{serial}/wireless/bluetooth/settings

{
    "uuid": "00000000-0000-0000-000-000000000000",
    "major": 13,
    "minor": 125
}

Update the bluetooth settings for a wireless device

PUT /devices/{serial}/wireless/bluetooth/settings

{
    "uuid": "00000000-0000-0000-000-000000000000",
    "major": 13,
    "minor": 125
}


API usage

PATH /organizations/{organizationId}/apiRequests/overview

Return an aggregated overview of API requests data

GET /organizations/{organizationId}/apiRequests/overview

{
    "responseCodeCounts": {
        "200": 50000,
        "201": 4000,
        "204": 1000,
        "400": 3500,
        "404": 1500,
        "429": 10000
    }
}


Change log

PATH /organizations/{organizationId}/configurationChanges

View the Change Log for your organization

GET /organizations/{organizationId}/configurationChanges

[
    {
        "ts": "2018-02-11T00:00:00.090210Z",
        "adminName": "Miles Meraki",
        "adminEmail": "miles@meraki.com",
        "adminId": "212406",
        "page": "via API",
        "label": "PUT /api/v1/organizations/2930418",
        "oldValue": "{\"id\":\"2930418\",\"name\":\"My organization\",\"url\":\"https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview\"}",
        "newValue": "{\"id\":\"2930418\",\"name\":\"My organization changed\",\"url\":\"https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview\"}"
    }
]


Enhancements

Clients

Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.

POST /networks/{networkId}/clients/provision

- Optional property policiesBySecurityAppliance Added

- Optional property policiesBySsid Added


Update a client's splash authorization. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

PUT /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus


Switch ports

Return the status for all the ports of a switch

GET /devices/{serial}/switchPortStatuses

- Response property powerUsageInWh value added


Camera quality retention profiles

Creates new quality retention profile for this network.

POST /networks/{networkId}/camera/qualityRetentionProfiles

- Optional property MV22X/MV72X Added

- Optional property motionDetectorVersion Added


Update an existing quality retention profile for this network.

PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- Optional property MV22X/MV72X Added

- Optional property motionDetectorVersion Added


List the quality retention profiles for this network

GET /networks/{networkId}/camera/qualityRetentionProfiles

- Response property motionDetectorVersion value added


Retrieve a single quality retention profile

GET /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- Response property motionDetectorVersion value added


Cameras

POST /networks/{networkId}/cameras/{serial}/snapshot

- Optional property fullframe Added


Config templates

List the configuration templates for this organization

GET /organizations/{organizationId}/configTemplates

- Response property productTypes value added


Devices

Claim devices into a network

POST /networks/{networkId}/devices/claim

- Optional property serials Added

- Summary changed from Claim a device into a network to Claim devices into a network


02-2020

Dashboard API Version 0.8 Released

New operations

Switch ports

Switch settings

Monitored media servers

01-2020

Python library/SDK revamped & updated

Meraki Dashboard API Python Library

This library's goal is to refresh and supplant the legacy module (this repository versions 0.34 and prior) as well as the now-deprecated SDK. Here are some of the features in this revamped library:

  • Support for all API operations, as it uses the OpenAPI specification to generate source code
  • Log all API requests made to a local file as well as on-screen console
  • Automatic retries upon 429 rate limit errors, using the Retry-After field within response headers
  • Get all (or a specified number of) pages of data with built-in pagination control
  • Tweak settings such as the default base URL (for example, to use with V1 and/or mega-proxy)
  • Simulate POST/PUT/DELETE calls to preview first, so that network configuration does not get changed
  • Includes the legacy module's functions for backward compatibility

Dashboard API Version 0.7 Released

Enhancements

MV Sense

Returns all configured analytic zones for this camera

Response property regionOfInterest value added

Wireless settings

Update the wireless settings for a network

Optional property ledLightsOn added

Devices

List the devices in an organization

Optional property configurationUpdatedAfter added

New operations

Camera quality and retention settings

MG LAN settings

MG port forwarding rules

Switch ports statuses

MX inbound firewall

Camera quality retention profiles

MG connectivity monitoring destinations

MG DHCP settings

MG subnet pool settings