- 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
Version 0.3.0 to 0.4.0
Renamed
PATH
`/networks/{networkID}/switchStacks/{switchStackId}/remove`
Path
`/networks/{networkID}/switchStacks/{switchStackId}/remove`
renamed to/networks/{networkId}/switchStacks/{switchStackId}/remove
Updates
Networks
Update the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode.
PUT
/networks/{networkId}/siteToSiteVpn
Property
mode
became required
Param
updateNetworkSiteToSiteVpn
became required
SSIDs
Update the attributes of an SSID
PUT
/networks/{networkId}/ssids/{number}
Property
host
became required
Property
secret
became required
Radio settings
Updates specified RF profile for this network
PUT
/networks/{networkId}/wireless/rfProfiles/{rfProfileId}
Property
minBitrate
type turn fromstring
tonumber
Property
minBitrate
type turn fromstring
tointeger
Changes
Networks
Return a network
GET
/networks/{networkId}
Response property
productTypes
value added:Code SnippetCopy{ productTypes: ["appliance","switch","wireless"] }
The traffic analysis data for this network.
GET
/networks/{networkId}/traffic
Optional param
t0
added
Summary changed from
The traffic analysis data for this network. [Traffic Analysis with Hostname Visibility](https://documentation.meraki.com/MR/Monitoring_and_Reporting/Hostname_Visibility) must be enabled on the network.
toThe traffic analysis data for this network. [Traffic Analysis with Hostname Visibility](https://documentation.meraki.com/MR/Monitoring_and_Reporting/Hostname_Visibility) must be enabled on the network.
List the networks in an organization
GET
/organizations/{organizationId}/networks
Response property
productTypes
value added:Code SnippetCopy{ productTypes: ["appliance","switch","wireless"] }
SSIDs
Update the attributes of an SSID
PUT
/networks/{networkId}/ssids/{number}
Optional property
enterpriseAdminAccess
Added
Optional property
radiusAttributeForGroupPolicies
Added
Optional property
radiusOverride
Added
Bluetooth clients
List the Bluetooth clients seen by APs in this network
GET
/networks/{networkId}/bluetoothClients
Optional param
t0
added
Response property
id
value added:Code SnippetCopy{ id: "1284392014819" }
Response property
name
value added:Code SnippetCopy{ name: "Miles's phone" }
Response property
deviceName
value added:Code SnippetCopy{ deviceName: "Bose QuietComfort 35" }
Response property
manufacturer
value added:Code SnippetCopy{ manufacturer: "Bose" }
Response property
lastSeen
value added:Code SnippetCopy{ lastSeen: 1526087474 }
Response property
seenByDeviceMac
value added:Code SnippetCopy{ seenByDeviceMac: "00:11:22:33:44:55" }
Response property
inSightAlert
value added:Code SnippetCopy{ inSightAlert: false }
Response property
outOfSightAlert
value added:Code SnippetCopy{ outOfSightAlert: false }
Response property
tags
value added:Code SnippetCopy{ tags: ["tag1","tag2"] }
Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.
GET
/networks/{networkId}/bluetoothClients/{bluetoothClientId}
Response property
id
value added:Code SnippetCopy{ id: "1284392014819" }
Response property
name
value added:Code SnippetCopy{ name: "Miles's phone" }
Response property
deviceName
value added:Code SnippetCopy{ deviceName: "Bose QuietComfort 35" }
Response property
manufacturer
value added:Code SnippetCopy{ manufacturer: "Bose" }
Response property
lastSeen
value added:Code SnippetCopy{ lastSeen: 1526087474 }
Response property
seenByDeviceMac
value added:Code SnippetCopy{ seenByDeviceMac: "00:11:22:33:44:55" }
Response property
inSightAlert
value added:Code SnippetCopy{ inSightAlert: false }
Response property
outOfSightAlert
value added:Code SnippetCopy{ outOfSightAlert: false }
Response property
tags
value added:Code SnippetCopy{ tags: ["tag1","tag2"] }
Clients
Return the client associated with the given identifier. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.
GET
/networks/{networkId}/clients/{clientId}
Response property
status
value added:Code SnippetCopy{ status: "Online" }
Management interface settings
Return the management interface settings for a device
GET
/networks/{networkId}/devices/{serial}/managementInterfaceSettings
Response property
ddnsHostnames
value added:Code SnippetCopy{ ddnsHostnames: {"activeDdnsHostname":"mx1-sample.dynamic-m.com","ddnsHostnameWan1":"mx1-sample-1.dynamic-m.com","ddnsHostnameWan2":"mx1-sample-2.dynamic-m.com"} }
Switch settings
PATH
/networks/{networkId}/switch/settings/qosRules
Path added
GET
getNetworkSwitchSettingsQosRules
List quality of service rulesCode SnippetCopy[ { "id": "1284392014819", "vlan": 100, "protocol": "TCP", "srcPort": 2000, "srcPortRange": null, "dstPort": null, "dstPortRange": "3000-3100", "dscp": 0 } ]
POST
createNetworkSwitchSettingsQosRule
Add a quality of service ruleCode SnippetCopy{ "id": "1284392014819", "vlan": 100, "protocol": "TCP", "srcPort": 2000, "srcPortRange": null, "dstPort": null, "dstPortRange": "3000-3100", "dscp": 0 }
PATH
/networks/{networkId}/switch/settings/qosRules/order
Path added
GET
getNetworkSwitchSettingsQosRulesOrder
Return the quality of service rule IDs by order in which they will be processed by the switchCode SnippetCopy{ "ruleIds": [ "1284392014819", "2983092129865" ] }
PUT
updateNetworkSwitchSettingsQosRulesOrder
Update the order in which the rules should be processed by the switchCode SnippetCopy{ "ruleIds": [ "1284392014819", "2983092129865" ] }
PATH
/networks/{networkId}/switch/settings/qosRules/{qosRuleId}
Path added
GET
getNetworkSwitchSettingsQosRule
Return a quality of service ruleCode SnippetCopy{ "id": "1284392014819", "vlan": 100, "protocol": "TCP", "srcPort": 2000, "srcPortRange": null, "dstPort": null, "dstPortRange": "3000-3100", "dscp": 0 }
PUT
updateNetworkSwitchSettingsQosRule
Update a quality of service ruleCode SnippetCopy{ "id": "1284392014819", "vlan": 100, "protocol": "TCP", "srcPort": 2000, "srcPortRange": null, "dstPort": null, "dstPortRange": "3000-3100", "dscp": 0 }
DELETE
deleteNetworkSwitchSettingsQosRule
Delete a quality of service rule
Update switch network settings
PUT
/networks/{networkId}/switch/settings
Optional property
vlan
Added
Returns the switch network settings
GET
/networks/{networkId}/switch/settings
Response property
vlan
value added:Code SnippetCopy{ vlan: 100 }
Uplink settings
Updates the uplink settings for your MX network.
PUT
/networks/{networkId}/uplinkSettings
Property
limitUp
Deleted
Property
limitDown
Deleted
Optional property
wan1
Added
Optional property
wan2
Added
Optional property
cellular
Added
Admins
Update an administrator
PUT
/organizations/{organizationId}/admins/{id}
Property
Devices
List the devices in an organization
GET
/organizations/{organizationId}/devices
Response property
firmware
value added:Code SnippetCopy{ firmware: "wireless-25-14" }
Dashboard branding policies
PATH
/organizations/{organizationId}/brandingPolicies
Path added
GET
getOrganizationBrandingPolicies
List the branding policies of an organizationCode SnippetCopy[ { "brandingPolicyId": "456", "name": "My Branding Policy", "enabled": true, "adminSettings": { "appliesTo": "All admins of networks...", "values": [ "N_1234", "L_5678" ] }, "helpSettings": { "helpTab": "show", "getHelpSubtab": "default or inherit", "communitySubtab": "show", "casesSubtab": "hide", "dataProtectionRequestsSubtab": "default or inherit", "getHelpSubtabKnowledgeBaseSearch": "<h1>Some custom HTML content</h1>", "universalSearchKnowledgeBaseSearch": "hide", "ciscoMerakiProductDocumentation": "show", "supportContactInfo": "show", "newFeaturesSubtab": "show", "firewallInfoSubtab": "hide", "apiDocsSubtab": "default or inherit", "hardwareReplacementsSubtab": "hide", "smForums": "hide" } } ]
POST
createOrganizationBrandingPolicy
Add a new branding policy to an organizationCode SnippetCopy{ "brandingPolicyId": "456", "name": "My Branding Policy", "enabled": true, "adminSettings": { "appliesTo": "All admins of networks...", "values": [ "N_1234", "L_5678" ] }, "helpSettings": { "helpTab": "show", "getHelpSubtab": "default or inherit", "communitySubtab": "show", "casesSubtab": "hide", "dataProtectionRequestsSubtab": "default or inherit", "getHelpSubtabKnowledgeBaseSearch": "<h1>Some custom HTML content</h1>", "universalSearchKnowledgeBaseSearch": "hide", "ciscoMerakiProductDocumentation": "show", "supportContactInfo": "show", "newFeaturesSubtab": "show", "firewallInfoSubtab": "hide", "apiDocsSubtab": "default or inherit", "hardwareReplacementsSubtab": "hide", "smForums": "hide" } }
PATH
/organizations/{organizationId}/brandingPolicies/priorities
Path added
GET
getOrganizationBrandingPoliciesPriorities
Return the branding policy IDs of an organization in priority order. IDs are ordered in ascending order of priority (IDs later in the array have higher priority).Code SnippetCopy{ "brandingPolicyIds": [ "123", "456", "789" ] }
PUT
updateOrganizationBrandingPoliciesPriorities
Update the priority ordering of an organization's branding policies.Code SnippetCopy{ "brandingPolicyIds": [ "123", "456", "789" ] }
PATH
/organizations/{organizationId}/brandingPolicies/{brandingPolicyId}
Path added
GET
getOrganizationBrandingPolicy
Return a branding policyCode SnippetCopy{ "brandingPolicyId": "456", "name": "My Branding Policy", "enabled": true, "adminSettings": { "appliesTo": "All admins of networks...", "values": [ "N_1234", "L_5678" ] }, "helpSettings": { "helpTab": "show", "getHelpSubtab": "default or inherit", "communitySubtab": "show", "casesSubtab": "hide", "dataProtectionRequestsSubtab": "default or inherit", "getHelpSubtabKnowledgeBaseSearch": "<h1>Some custom HTML content</h1>", "universalSearchKnowledgeBaseSearch": "hide", "ciscoMerakiProductDocumentation": "show", "supportContactInfo": "show", "newFeaturesSubtab": "show", "firewallInfoSubtab": "hide", "apiDocsSubtab": "default or inherit", "hardwareReplacementsSubtab": "hide", "smForums": "hide" } }
PUT
updateOrganizationBrandingPolicy
Update a branding policyCode SnippetCopy{ "brandingPolicyId": "456", "name": "My Branding Policy", "enabled": true, "adminSettings": { "appliesTo": "All admins of networks...", "values": [ "N_1234", "L_5678" ] }, "helpSettings": { "helpTab": "show", "getHelpSubtab": "default or inherit", "communitySubtab": "show", "casesSubtab": "hide", "dataProtectionRequestsSubtab": "default or inherit", "getHelpSubtabKnowledgeBaseSearch": "<h1>Some custom HTML content</h1>", "universalSearchKnowledgeBaseSearch": "hide", "ciscoMerakiProductDocumentation": "show", "supportContactInfo": "show", "newFeaturesSubtab": "show", "firewallInfoSubtab": "hide", "apiDocsSubtab": "default or inherit", "hardwareReplacementsSubtab": "hide", "smForums": "hide" } }
DELETE
deleteOrganizationBrandingPolicy
Delete a branding policy