- 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
- [ appliance ]
- [ camera ]
- customAnalytics
- Return custom analytics settings for a camera
- Update custom analytics settings for a camera
- List Custom Analytics Artifacts
- Create custom analytics artifact. Returns an artifact upload URL with expiry time. Upload the artifact file with a put request to the returned upload URL before its expiry.
- Get Custom Analytics Artifact
- Delete Custom Analytics Artifact
- customAnalytics
Version 1.19.0 to 1.20.0
Summary of Changes
4 - New
54 - Updated
533 - Total operations
336 - Total Paths
What's Updated
[ switch ]
ports
List the switch ports for a switch
GET /devices/{serial}/switch/ports
- Response property
linkNegotiationCapabilities
value added
Return the status for all the ports of a switch
GET /devices/{serial}/switch/ports/statuses
- Response property
isUplink
value added
Return a switch port
GET /devices/{serial}/switch/ports/{portId}
- Response property
linkNegotiationCapabilities
value added
accessPolicies
List the access policies for a switch network
GET /networks/{networkId}/switch/accessPolicies
- Response property
dot1x
value added
Return a specific access policy for a switch network
GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
- Response property
dot1x
value added
dhcpServerPolicy
Return the DHCP server settings
GET /networks/{networkId}/switch/dhcpServerPolicy
- Response property
alerts
value added
- Response property
blockedServers
value added
- Response property
arpInspection
value added
- Summary changed from
Return the DHCP server policy
toReturn the DHCP server settings
Update the DHCP server settings
PUT /networks/{networkId}/switch/dhcpServerPolicy
- Summary changed from
Update the DHCP server policy
toUpdate the DHCP server settings
configTemplates
Return all the ports of a switch profile
GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports
- Response property
linkNegotiationCapabilities
value added
Return a switch profile port
GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
- Response property
linkNegotiationCapabilities
value added
[ appliance ]
uplink
List the uplink status of every Meraki MX and Z series appliances in the organization
GET /organizations/{organizationId}/appliance/uplink/statuses
- Response property
gateway
value added
- Response property
dns1
value added
- Response property
dns2
value added
- Response property
signalType
value added
vlans
List the VLANs for an MX network
GET /networks/{networkId}/appliance/vlans
- Response property
interfaceId
value added
Return a VLAN
GET /networks/{networkId}/appliance/vlans/{vlanId}
- Response property
interfaceId
value added
[ networks ]
firmwareUpgrades
Get firmware upgrade information for a network
GET /networks/{networkId}/firmwareUpgrades
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
- Response property
releaseDate
value added
[ wireless ]
ssids
List the VPN settings for the SSID.
GET /networks/{networkId}/wireless/ssids/{number}/vpn
- Response property
concentrator
value added
Update the VPN settings for the SSID
PUT /networks/{networkId}/wireless/ssids/{number}/vpn
- Optional property
concentrator
Added
[ organizations ]
loginSecurity
Returns the login security settings for an organization.
GET /organizations/{organizationId}/loginSecurity
- Optional property
enforceAccountLockout
Added
- Optional property
loginIpRanges
Added
summary
Return metrics for organization's top 10 clients by data usage (in mb) over given time range.
GET /organizations/{organizationId}/summary/top/clients/byUsage
- Response property
schema
value added
- Response property
examples
value added
uplinks
List the uplink status of every Meraki MX, MG and Z series devices in the organization
GET /organizations/{organizationId}/uplinks/statuses
- Response property
gateway
value added
- Response property
dns1
value added
- Response property
dns2
value added
- Response property
signalType
value added
- Response property
gateway
value added
- Response property
dns1
value added
- Response property
dns2
value added
- Response property
signalType
value added
service
List the organizations that the user has privileges on
GET /organizations
- Response property
cloud
value added
Return an organization
GET /organizations/{organizationId}
- Response property
cloud
value added
[ cellularGateway ]
uplink
List the uplink status of every Meraki MG cellular gateway in the organization
GET /organizations/{organizationId}/cellularGateway/uplink/statuses
- Response property
gateway
value added
- Response property
dns1
value added
- Response property
dns2
value added
- Response property
signalType
value added
What's New
[ appliance ]
vmx
PATH /devices/{serial}/appliance/vmx/authenticationToken
- Path added
- New operation
Generate a new vMX authentication token
POST
/devices/{serial}/appliance/vmx/authenticationToken
Code SnippetCopy{ "token": "ffc0b7b578b61be5bd1d172132c78044/9af03bd84d474", "expiresAt": "2021-06-18T12:40:10Z" }
[ camera ]
customAnalytics
PATH /devices/{serial}/camera/customAnalytics
- Path added
- New operation
Return custom analytics settings for a camera
GET
/devices/{serial}/camera/customAnalytics
Code SnippetCopy{ "enabled": true, "artifactId": "1", "parameters": [ { "name": "detection_threshold", "value": 0.5 } ] }
- New operation
Update custom analytics settings for a camera
PUT
/devices/{serial}/camera/customAnalytics
Code SnippetCopy{ "enabled": true, "artifactId": "1", "parameters": [ { "name": "detection_threshold", "value": 0.5 } ] }
PATH /organizations/{organizationId}/camera/customAnalytics/artifacts
- Path added
- New operation
List Custom Analytics Artifacts
GET
/organizations/{organizationId}/camera/customAnalytics/artifacts
Code SnippetCopy[ { "artifactId": "1", "organizationId": "2", "name": "example", "status": { "type": "pending", "message": null } } ]
- New operation
Create custom analytics artifact. Returns an artifact upload URL with expiry time. Upload the artifact file with a put request to the returned upload URL before its expiry.
POST
/organizations/{organizationId}/camera/customAnalytics/artifacts
Code SnippetCopy{ "artifactId": "1", "organizationId": "2", "name": "example", "status": { "type": "pending", "message": null }, "uploadId": "00112233445566778899aabbccddeeff", "uploadUrl": "https://meraki_custom_cv_upload_url", "uploadUrlExpiry": "2022-01-23T01:23:45.123456+00:00" }
PATH /organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}
- Path added
- New operation
Get Custom Analytics Artifact
GET
/organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}
Code SnippetCopy{ "artifactId": "1", "organizationId": "2", "name": "example", "status": { "type": "pending", "message": null } }
- New operation
Delete Custom Analytics Artifact
DELETE
/organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}