• What's Updated
  • [ switch ]
    • ports
      • List the switch ports for a switch
      • Return the status for all the ports of a switch
      • Return a switch port
    • accessPolicies
      • List the access policies for a switch network
      • Return a specific access policy for a switch network
    • dhcpServerPolicy
      • Return the DHCP server settings
      • Update the DHCP server settings
    • configTemplates
      • Return all the ports of a switch profile
      • Return a switch profile port
  • [ appliance ]
    • uplink
      • List the uplink status of every Meraki MX and Z series appliances in the organization
    • vlans
      • List the VLANs for an MX network
      • Return a VLAN
  • [ networks ]
    • firmwareUpgrades
      • Get firmware upgrade information for a network
  • [ wireless ]
    • ssids
      • List the VPN settings for the SSID.
      • Update the VPN settings for the SSID
  • [ organizations ]
    • loginSecurity
      • Returns the login security settings for an organization.
    • summary
      • Return metrics for organization's top 10 clients by data usage (in mb) over given time range.
    • uplinks
      • List the uplink status of every Meraki MX, MG and Z series devices in the organization
    • service
      • List the organizations that the user has privileges on
      • Return an organization
  • [ cellularGateway ]
    • uplink
      • List the uplink status of every Meraki MG cellular gateway in the organization
• What's New
  • [ appliance ]
    • vmx
      • Generate a new vMX authentication token
  • [ 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

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 to Return the DHCP server settings

Update the DHCP server settings

PUT /networks/{networkId}/switch/dhcpServerPolicy

- Summary changed from Update the DHCP server policy to Update 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

{
    "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

{
    "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

{
    "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

[
    {
        "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

{
    "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}

{
    "artifactId": "1",
    "organizationId": "2",
    "name": "example",
    "status": {
        "type": "pending",
        "message": null
    }
}

---

- New operation

Delete Custom Analytics Artifact

DELETE /organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}

---