my cheat sheet on Meraki API

The Dashboard API is a modern, RESTful API using HTTPS requests to a URL and JSON as a human-readable format. For config and monitor Meraki networks.

Enables Cisco Meraki users to detect and aggregate =real-time= data for custom applications. can be used to detect Wi-Fi and Bluetooth Low Energy (BLE) devices in real-time. The elements are exported via an HTTP POST of JSON data to a specified destination server, for analysis (i.e. Customer analytics back-end)

Using signal strength, the wireless client's location is estimated, trianulated.

Provides a collection of endpoints to interact with Meraki cameras, zone, and analytics.

Extends the power of the built-in Meraki splash page functionality by providing complete control of the content and authentication process offering to redirect login and authentication to client-provided servers, using your own authentication, authorization, and accounting (AAA) servers as well.

Allows you to retrieve wireless health information such as connection health, connection failures, and network latency.

{ "X-Cisco-Meraki-API-Key": <Meraki_APIKey> }

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

If you get a 302 Error code as a response to a GET,

• ("Response: redirect to https://n252.meraki.com/api/v0/organizations")

That is informational, and tells you that you will get better response times if you go to the meraki cloud cluster n252 directly next time.

If you get a 307 (for Postman) or 308 (some other client) Error code as a response to a DELETE, POST, PUT, it really says the same thing. Do it!

• ("Response: redirect to https://n252.meraki.com/api/v0/organizations")

That is informational, and tells you that you will need to change your URL to go to the meraki cloud cluster n252 directly next time.

Cisco developed Postman collections can be downloaded by starting at https://developer.cisco.com/. Login, then find it.

Meraki developed Postman collections can be downloaded by starting at https://developer.meraki.com/ which gets forwarded (after login) to: https://developer.cisco.com/meraki/

Click Resources followed by Postman Collection. That gives you good docs on postman with Meraki, but really you should click on Run in Postman in the top right corner. That will download the Meraki dashboard API to your postman collection. As of Jan 2021 it included 450 requests and was at version Meraki Dashboard API - v1.5.0

With collection, you will also get environments, that you can then edit and fill in with you own Meraki API key and Organization ID etc. See below for how to get the organization key.

Using the Meraki Dashboard API, find the "List the Organizations" request and run that. You can fill in the API key manually the first time you do it, but really you should save your API key in a variable that is stored in the Meraki Dashboard Environment, accessible in the top right, by 1st selecting the environment, then clicking the eyeball, then quick view, then edit.

For example the API key is X-Cisco-Meraki-API-Key which is referenced in a postman request using double curly braces: {{X-Cisco-Meraki-API-Key}}

The equivalent curl command:

  curl --location --request GET 'https://api.meraki.com/api/v1/organizations' \
--header 'X-Cisco-Meraki-API-Key: 18b62c93fe80f9918d73c5d2180f5e221527cb4e'

Once we have the organization ID, we should update the environment variables to include this field. The above image, shows this organization already included in the Meraki variables.

• pm.environment.set("Token", jsonData["access-token"]); # use [] if key has a hyphen
• pm.environment.set("Token", jsonData"token");
• postman.setEnvironmentVariable is the equivalent, but deprecated syntax

Details can be found in the postman-sandbox-api-reference

To set the variable with the specifie name and value in the active environment:

• pm.environment.set(variableName:String, variableValue:*):function
• pm.environment.set(myOrgID:String, variableValue:*):function

• pm.response.code:Number # for the response status code
• pm.response.headers:HeaderList # for a list of the response headers
• pm.response.json():Function -> Object # you can drill down into the

• pm.environment.set("orgID", pm.response.json().id)
• pm.environment.set("uzvards", pm.response.json().name)

They set the variable ok, but the value was "null".

• var jsonData = JSON.parse(responseBody);
• pm.environment.set("uzvards", jsonData.name);
• pm.environment.set("OrgID", jsonData.id);

Same thing happened

• var jsonData = pm.response.json();

Nope…

For the record, the above snippets may have worked had the response been different from what the Meraki response actually was.

For example here is a postman test script that would work with the corresponding response data.

cont myjsonData = pm.response.json();
pm.environment.set("mytick", myjsonData.response.serviceTicket);

If the response code was:

{
    "response": {
        "serviceTicket": "TQG=15lj6k6c-bkl--6a136326XQ-l8v526h-91lh",
	"idleTimeout": 1800,
	"sessionTimeout": 21600
    }
}

In a new request, you could reference the serviceTicket with {{mytick}}

const jsonData = pm.response.json();

• pm.environment.set("uzvards", jsonData[0].name)
• pm.environment.set("organizationId", jsonData[0].id)

This worked because the response I got from meraki was not just the json I expected, but rather a list [] with 1 element in it that had the json in it.

My response was this:

[
   {
	"id": "158264",
	"name": "Pērkons",
	"url": "https://n77.meraki.com/o/Oozq4a/manage/organization/overview"
    }
 ]

For which you can see I need to specify that I need the first element of the list, which is element [0], hence jsonData[0] was needed.

But I was expecting this:

{
     "id": "158264",
     "name": "Pērkons",
     "url": "https://n77.meraki.com/o/Oozq4a/manage/organization/overview"
 }
Notice the missing outer []

For which case my code would have worked.