Cisco Meraki Dashboard API

API Documentation

For more information on Meraki's APIs, please visit our dedicated API documentation website: Meraki Developer Hub. 

The API reference documentation is provided in a Postman collection accessible at our Meraki Developer Hub > Resources > Postman Collections website. The Postman collection can be imported into the Postman application to test API calls.

Generate API Key

Cisco Meraki Dashboard API is enabled by default on all organizations.
To generate an API key, go to the My Profile page accessed via the avatar icon in the top right-hand corner of dashboard. This API key will be associated with the dashboard administrator account which generates it and will inherit the same permissions as that account. You can generate, revoke, and regenerate your API key on your profile.

API & Webhooks Dashboard page

API keys and Webhooks can also be configured via the dedicated API & Webhooks Dashboard UI page. Navigate to  Organization → Configure → API & Webhooks. 

Using the Dashboard API

API Requests

Every request must specify an API key via a request header. Furthermore, the API version must be specified in the URL. The API will return 404 (rather than a 403) in response to a request with a missing or incorrect API key in order to prevent leaking the existence of resources to unauthorized users.

X-Cisco-Meraki-API-Key: <secret key>

The API version must be specified in the URL:

https://api.meraki.com/api/v1/<resource>

Once an API version is released, we will make only backwards-compatible changes to it. Backwards-compatible changes include:

• Adding new API resources

• Adding new optional request parameters to existing API methods

• Adding new properties to existing API responses

• Changing the order of properties in existing API responses

Identifiers in the API are opaque strings. A <network_id>, for example, might be the string “126043”, whereas an <order_id> might contain characters, such as “4S1234567”. Client applications must not try to parse them as numbers. Even identifiers that look like numbers might be too long to encode without loss of precision in Javascript, where the only numeric type is IEEE 754 floating point.

 

Verbs in the API follow the usual REST conventions:

• GET returns the value of a resource or a list of resources, depending on whether an identifier is specified.
  • GET of /v1/organizations returns a list of organizations
  • GET of /v1/organizations/<org_id> returns a particular organization
• POST adds a new resource
  • POST to /v1/organizations/<org_id>/admins
  • POST performs other non-idempotent changes 
• PUT updates a resource
  • PUT is idempotent; it updates a resource, but does not create a resource if it does not already exist, which differs from RFC 9110
  • PUT should specify all the fields of a resource; omitted fields will have no changes made to their value
• DELETE removes a resource

Status and Error Codes

Responses from the API generally use standard RFC 9110 HTTP Status Codes. Some examples:

• 400: Bad Request - You did something wrong, for example, a malformed request or missing parameter
• 401: Unauthorized - Invalid API Key
• 403: Forbidden - You don't have permission to do that
• 404: Not found - No such URL or you don't have access to the API or organization at all
• 429: Too Many Requests - You submitted more than ten calls in one second to an organization, triggering rate limiting. This also applies for API calls made across multiple organizations that triggers rate limiting for one of the organizations.

If the response code is not specific enough to determine the cause of the issue, error messages will be included in the response in JSON format, for example:

{
    "errors": [
       "VLANs are not enabled for this network"
    ]
}

Organizations

Retrieve the list of organizations for the API key specified in X-Cisco-Meraki-API-Key:

GET https://api.meraki.com/api/v1/organizations
Response code: 200
Response body: [{"id":"<org_id>","name":"<org_name>" }]

Retrieve metadata about a specific organization:

GET https://api.meraki.com/api/v1/organizations/<org_id>
Response code: 200
Response body: { "id": <org_id>, "name": "Test Organization" }

Most HTTP libraries and clients will only follow a redirect with the HTTP verb GET. If using other HTTP verbs, they may still follow the redirect, but they will substitute the other HTTP verb with GET.  As a result, you may find a redirect on DELETE, POST, or PUT will look as though a GET was requested. To avoid this, follow the steps below:

1. Perform a GET on the organization you are working with
2. Store the URL you are working with
3. Use the URL for subsequent requests (particularly those that modify state).

Create a new organization:

POST https://api.meraki.com/api/v1/organizations
Request body: { “name”: “Second Test Organization” }
Response code: 201 
Response body: { "id": <new_org_id>, name: "Second Test Organization" }

The new organization will be unconfigured. However, the admin who created it will have full organization write access. Clients of the API can add additional admins and then remove the creating admin from the new organization if desired.

Networks

List the networks in an organization: 

GET https://api.meraki.com/api/v1/organizations/<new_org_id>/networks
Response code: 200
Response body: [ { "id": <network_id>, "name": "Test Network", "organization_id": <new_org_id>, "type": "wireless",
   "timeZone": "America/Los_Angeles", "tags": " test "}]

Create a new network:

POST https://api.meraki.com/api/v1/organizations/<org_id>/networks
Request body: { “name”: “Test Network 2”, “organizationId”: <org_id>, “type”: “appliance”}
Response code: 201
Response body: { “id”: <network_id>, “name”: “Test Network 2”, “organization_id”: <org_id>, “type”: “appliance”, “tags”: null }

Valid network types are appliance, switch, wireless, systemsManager or camera. Use a combination of these to create a combined network. For example, “type”: “appliance wireless”. 

Licenses and Devices

Claim a device, license key, or order into an organization. When claiming by order, all devices and licenses in the order will be claimed. Licenses will be added to the organization and devices will be placed in the organization's inventory. These three types of claims are mutually exclusive and cannot be performed in one request. The licenseMode parameter can be either renew or addDevices. addDevices will increase the license limit while renew will extend the amount of time until expiration. This parameter is required when claiming by licenseKey. Please see this article for more information.

POST https://api.meraki.com/api/v1/organizations/<org_id>/ claim
Request body: { "order": "4CXXXXXXX" }
Response code: 200
Response body: <empty>

Simple Network Management Protocol (SNMP) Settings

Set the SNMP settings for an organization. The community string for SNMPv2 is in the response. It can also be retrieved via a GET to this same URL.

GET https://api.meraki.com/api/v1/organizations/<org_id>/snmp
Request body: { "v2cEnabled": true, "v3Enabled": true, "v3AuthMode": "SHA", "v3AuthPass", <secret>, "v3PrivMode": "AES128", "v3PrivPass": <secret>, "allowedIPs": ["5.6.7.8"] }
Response code: 200
Response body: { "v2Enabled": true, “v2CommunityString”: <secret>, "v3Enabled": true, "authMode": "SHA", "authPass", <secret>, "privMode": "AES128", "privPass": <secret>, "allowedIPs": ["5.6.7.8"] }

Administrators 

List the administrators for an organization:

GET https://api.meraki.com/api/v1/organizations/<org_id>/admins
Response code: 200
Response body: [ { "name": "Jane Doe", "email": "jane@doe.com", "orgAccess": "full","id": <admin_id> } ]

Organization access can be full, read-only, or none.
 

Add a new administrator with rights to only one network:

POST https://api.meraki.com/api/v1/organizations/<org_id>/admins/
Request body: { "name": "John Doe", "email": "john@doe.com", "orgAccess": "none", "networks": [{ "id": <network_id>, "access": "full" }
Response code: 201
Response body: { “id”: <admin_id>, "name": "John Doe", "email": "john@doe.com", "orgAccess": "none", "networks": [{ "id": <network_id>, "access": "full" }]

Valid access levels for networks are full, read-only, monitor-only, and guest-ambassador. Clients can also give administrators access by tag by substituting the networks field for tags such as:

"tags": [{ "tag": "foo", "access": "read-only" }],

Valid access levels for tags are the same as for networks. Clients can update administrators using PUT and specifying an admin_id.

Delete an administrator:

DELETE https://api.meraki.com/api/v1/organizations/<org_id>/admins/<admin_id>
Response code: 204
Response body: <empty>