- Release Notes
- API Changelog
- Overview
- Generally Available
- v1.57.0
- v1.56.0
- v1.55.0
- v1.54.0
- v1.53.0
- v1.52.0
- v1.51.1
- v1.50.0
- v1.49.0
- v1.48.0
- v1.47.0
- v1.46.0
- v1.45.0
- v1.44.0
- v1.43.0
- v1.42.0
- v1.41.0
- v1.40.0
- v1.39.0
- v1.38.0
- v1.37.0
- v1.36.0
- v1.35.0
- v1.34.0
- v1.33.0
- v1.32.0
- v1.31.0
- v1.30.0
- v1.29.0
- v1.28.0
- v1.27.0
- v1.26.0
- v1.25.0
- v1.24.0
- v1.23.0
- v1.22.0
- v1.21.0
- v1.20.0
- v1.19.0
- v1.18.0
- v1.17.0
- v1.16.0
- v1.15.0
- v1.14.0
- v1.13.0
- v1.12.0
- v1.11.0
- v1.10.0
- v1.8.0
- v1.7.0
- v1.6.0
- v1.5.0
- v1.4.0
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.0
- v0.11.0
- v0.10.0
- v0.9.0
- v0.8.0
- v0.7.0
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- v0.2.0
- Beta
- What's Updated
- What's New
Version 1.36.0 to 1.37.0
Summary of Changes
12 - New
19 - Updated
650 - Total operations
411 - Total Paths
What's Updated
[ camera ]
video
Returns video settings for the given camera
GET /devices/{serial}/camera/video/settings
- Response property
properties
value added
schedules
Returns a list of all camera recording schedules.
GET /networks/{networkId}/camera/schedules
- Response property
properties
value added
[ appliance ]
vpn
Return the firewall rules for an organization's site-to-site VPN
GET /organizations/{organizationId}/appliance/vpn/vpnFirewallRules
- Response property
properties
value added
staticRoutes
List the static routes for an MX or teleworker network
GET /networks/{networkId}/appliance/staticRoutes
- Response property
gatewayVlanId
value added
Return a static route for an MX or teleworker network
GET /networks/{networkId}/appliance/staticRoutes/{staticRouteId}
- Response property
gatewayVlanId
value added
[ switch ]
settings
Returns the switch network settings
GET /networks/{networkId}/switch/settings
- Optional property
macBlocklist
Added
- Response property
macBlocklist
value added
Update switch network settings
PUT /networks/{networkId}/switch/settings
- Optional property
macBlocklist
Added
- Optional property
macBlocklist
Added
[ wireless ]
ssids
List the MR SSIDs in a network
GET /networks/{networkId}/wireless/ssids
- Optional property
localAuth
Added
- Response property
localAuth
value added
Return a single MR SSID
GET /networks/{networkId}/wireless/ssids/{number}
- Optional property
localAuth
Added
- Response property
localAuth
value added
Update the attributes of an MR SSID
PUT /networks/{networkId}/wireless/ssids/{number}
- Optional property
localAuth
Added
[ organizations ]
devices
List the most recent status information for power modules in rackmount MX and MS devices that support them
GET /organizations/{organizationId}/devices/powerModules/statuses/byDevice
- Summary changed from
List the power status information for devices in an organization
toList the most recent status information for power modules in rackmount MX and MS devices that support them
inventory
Return the device inventory for an organization
GET /organizations/{organizationId}/inventory/devices
- Optional property
countryCode
Added
- Response property
countryCode
value added
Return a single device from the inventory of an organization
GET /organizations/{organizationId}/inventory/devices/{serial}
- Optional property
countryCode
Added
- Response property
countryCode
value added
What's New
[ camera ]
permissions
PATH /organizations/{organizationId}/camera/permissions
- Path added
- New operation
List the permissions scopes for this organization
GET
/organizations/{organizationId}/camera/permissions
Code SnippetCopy[ { "id": "1234", "name": "camera_video", "level": "live_video" } ]
PATH /organizations/{organizationId}/camera/permissions/{permissionScopeId}
- Path added
- New operation
Retrieve a single permission scope
GET
/organizations/{organizationId}/camera/permissions/{permissionScopeId}
Code SnippetCopy{ "id": "1234", "name": "camera_video", "level": "live_video" }
roles
PATH /organizations/{organizationId}/camera/roles
- Path added
- New operation
List all the roles in this organization
GET
/organizations/{organizationId}/camera/roles
Code SnippetCopy[ { "name": "Security_Guard", "appliedOnDevices": [ { "tag": "reception-desk", "id": "", "permissionScopeId": "1", "permissionScope": "camera-video", "permissionLevel": "view_and_export" } ], "appliedOnNetworks": [ { "tag": "", "id": "2568", "permissionScopeId": "2", "permissionScope": "camera-video", "permissionLevel": "view" } ], "appliedOrgWide": [ { "tag": "building-a", "permissionScopeId": "2", "permissionScope": "camera_video", "permissionLevel": "view_live" } ] } ]
- New operation
Creates new role for this organization.
POST
/organizations/{organizationId}/camera/roles
Code SnippetCopy{ "name": "Security_Guard", "appliedOnDevices": [ { "tag": "reception-desk", "id": "", "permissionScopeId": "1", "permissionScope": "camera-video", "permissionLevel": "view_and_export" } ], "appliedOnNetworks": [ { "tag": "", "id": "2568", "permissionScopeId": "2", "permissionScope": "camera-video", "permissionLevel": "view" } ], "appliedOrgWide": [ { "tag": "building-a", "permissionScopeId": "2", "permissionScope": "camera_video", "permissionLevel": "view_live" } ] }
PATH /organizations/{organizationId}/camera/roles/{roleId}
- Path added
- New operation
Retrieve a single role.
GET
/organizations/{organizationId}/camera/roles/{roleId}
Code SnippetCopy{ "name": "Security_Guard", "appliedOnDevices": [ { "tag": "reception-desk", "id": "", "permissionScopeId": "1", "permissionScope": "camera-video", "permissionLevel": "view_and_export" } ], "appliedOnNetworks": [ { "tag": "", "id": "2568", "permissionScopeId": "2", "permissionScope": "camera-video", "permissionLevel": "view" } ], "appliedOrgWide": [ { "tag": "building-a", "permissionScopeId": "2", "permissionScope": "camera_video", "permissionLevel": "view_live" } ] }
- New operation
Update an existing role in this organization.
PUT
/organizations/{organizationId}/camera/roles/{roleId}
Code SnippetCopy{ "name": "Security_Guard", "appliedOnDevices": [ { "tag": "reception-desk", "id": "", "permissionScopeId": "1", "permissionScope": "camera-video", "permissionLevel": "view_and_export" } ], "appliedOnNetworks": [ { "tag": "", "id": "2568", "permissionScopeId": "2", "permissionScope": "camera-video", "permissionLevel": "view" } ], "appliedOrgWide": [ { "tag": "building-a", "permissionScopeId": "2", "permissionScope": "camera_video", "permissionLevel": "view_live" } ] }
- New operation
Delete an existing role for this organization.
DELETE
/organizations/{organizationId}/camera/roles/{roleId}
[ appliance ]
trafficShaping
PATH /networks/{networkId}/appliance/trafficShaping/vpnExclusions
- Path added
- New operation
Update VPN exclusion rules for an MX network.
PUT
/networks/{networkId}/appliance/trafficShaping/vpnExclusions
Code SnippetCopy{ "networkId": "N_24329156", "networkName": "Main Office", "custom": [ { "protocol": "tcp", "destination": "192.168.3.0/24", "port": "8000" } ], "majorApplications": [ { "id": "meraki:vpnExclusion/application/2", "name": "Office 365 Sharepoint" } ] }
PATH /organizations/{organizationId}/appliance/trafficShaping/vpnExclusions/byNetwork
- Path added
- New operation
Display VPN exclusion rules for MX networks.
GET
/organizations/{organizationId}/appliance/trafficShaping/vpnExclusions/byNetwork
Code SnippetCopy[ { "networkId": "N_24329156", "networkName": "Main Office", "custom": [ { "protocol": "tcp", "destination": "192.168.3.0/24", "port": "8000" } ], "majorApplications": [ { "id": "meraki:vpnExclusion/application/2", "name": "Office 365 Sharepoint" } ] } ]
[ wireless ]
alternateManagementInterface
PATH /devices/{serial}/wireless/alternateManagementInterface/ipv6
- Path added
- New operation
Update alternate management interface IPv6 address
PUT
/devices/{serial}/wireless/alternateManagementInterface/ipv6
Code SnippetCopy{ "addresses": [ { "protocol": "ipv6", "assignmentMode": "static", "address": "2001:db8:3c4d:15::1", "gateway": "fe80:db8:c15:c0:d0c::10ca:1d02", "prefix": "2001:db8:3c4d:15::/64", "nameservers": { "addresses": [ "2001:db8:3c4d:15::1", "2001:db8:3c4d:15::1" ] } } ] }
ethernet
PATH /networks/{networkId}/wireless/ethernet/ports/profiles
- Path added
- New operation
List the AP port profiles for this network
GET
/networks/{networkId}/wireless/ethernet/ports/profiles
Code SnippetCopy[ { "profileId": "1001", "name": "Ap Port Profile Name", "isDefault": false, "ports": [ { "name": "port 1", "number": 1, "enabled": true, "ssid": 1, "pskGroupId": "100" } ], "usbPorts": [ { "name": "usb port", "enabled": true, "ssid": 5 } ] } ]
- New operation
Create an AP port profile
POST
/networks/{networkId}/wireless/ethernet/ports/profiles
Code SnippetCopy{ "profileId": "1001", "name": "Ap Port Profile Name", "isDefault": false, "ports": [ { "name": "port 1", "number": 1, "enabled": true, "ssid": 1, "pskGroupId": "100" } ], "usbPorts": [ { "name": "usb port", "enabled": true, "ssid": 5 } ] }
PATH /networks/{networkId}/wireless/ethernet/ports/profiles/assign
- Path added
- New operation
Assign AP port profile to list of APs
POST
/networks/{networkId}/wireless/ethernet/ports/profiles/assign
Code SnippetCopy{ "serials": [ "Q234-ABCD-0001", "Q234-ABCD-0002", "Q234-ABCD-0003" ], "profileId": "1001" }
PATH /networks/{networkId}/wireless/ethernet/ports/profiles/setDefault
- Path added
- New operation
Set the AP port profile to be default for this network
POST
/networks/{networkId}/wireless/ethernet/ports/profiles/setDefault
Code SnippetCopy{ "profileId": "1001" }
PATH /networks/{networkId}/wireless/ethernet/ports/profiles/{profileId}
- Path added
- New operation
Show the AP port profile by ID for this network
GET
/networks/{networkId}/wireless/ethernet/ports/profiles/{profileId}
Code SnippetCopy{ "profileId": "1001", "name": "Ap Port Profile Name", "isDefault": false, "ports": [ { "name": "port 1", "number": 1, "enabled": true, "ssid": 1, "pskGroupId": "100" } ], "usbPorts": [ { "name": "usb port", "enabled": true, "ssid": 5 } ] }
- New operation
Update the AP port profile by ID for this network
PUT
/networks/{networkId}/wireless/ethernet/ports/profiles/{profileId}
Code SnippetCopy{ "profileId": "1001", "name": "Ap Port Profile Name", "isDefault": false, "ports": [ { "name": "port 1", "number": 1, "enabled": true, "ssid": 1, "pskGroupId": "100" } ], "usbPorts": [ { "name": "usb port", "enabled": true, "ssid": 5 } ] }
- New operation
Delete an AP port profile
DELETE
/networks/{networkId}/wireless/ethernet/ports/profiles/{profileId}
[ organizations ]
uplinksLossAndLatency
PATH /organizations/{organizationId}/uplinksLossAndLatency
- Path added
- New operation
Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
GET
/organizations/{organizationId}/uplinksLossAndLatency
Code SnippetCopy[ { "networkId": "N_12345", "serial": "Q2AB-CDEF-GHIJ", "uplink": "wan1", "ip": "8.8.8.8", "timeSeries": [ { "ts": "2019-01-31T18:46:13Z", "lossPercent": 5.3, "latencyMs": 194.9 } ] } ]