• What's Updated
  • [ licensing ]
    • subscription
      • List available subscriptions
  • [ devices ]
    • lldpCdp
      • List LLDP and CDP information for a device
  • [ networks ]
    • merakiAuthUsers
      • List the authorized users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a MX network)
    • service
      • Return a network
      • Update a network
      • Split a combined network into individual networks for each type of device
      • Unbind a network from a template.
  • [ camera ]
    • qualityRetentionProfiles
      • Update an existing quality retention profile for this network.
      • Creates new quality retention profile for this network.
  • [ switch ]
    • stacks
      • List the switch stacks in a network
      • Show a switch stack
      • Create a switch stack
      • Add a switch to a stack
      • Remove a switch from a stack
    • stormControl
      • Return the storm control configuration for a switch network
      • Update the storm control configuration for a switch network
    • ports
      • List the switchports in an organization by switch
  • [ appliance ]
    • vpn
      • Update the third party VPN peers for an organization
  • [ cellularGateway ]
    • esims
      • The eSIM inventory of a given organization.
      • Toggle the status of an eSIM
  • [ organizations ]
    • devices
      • List the availability information for devices in an organization
      • List the current uplink addresses for devices in an organization.
    • inventory
      • Returns list of networks eligible for adding cloud monitored device
    • networks
      • List the networks that the user has privileges on in an organization
      • Create a network
      • Combine multiple networks into a single network
• What's New
  • [ wireless ]
    • devices
      • List of Catalyst access points information
    • clients
      • List access point client count at the moment in an organization
  • [ wirelessController ]
    • devices
      • List wireless LAN controller layer 2 interfaces in an organization
      • List wireless LAN controller layer 2 interfaces history status in an organization
      • List wireless LAN controller layer 2 interfaces history usage in an organization
      • List wireless LAN controller layer 3 interfaces in an organization
      • List wireless LAN controller layer 3 interfaces history status in an organization
      • List wireless LAN controller layer 3 interfaces history usage in an organization
      • Retrieve the packet counters for the interfaces of a Wireless LAN controller
      • Retrieve the traffic for the interfaces of a Wireless LAN controller
      • List the failover events of wireless LAN controllers in an organization
      • List redundancy details of wireless LAN controllers in an organization. The failover count refers to the total failovers system happens from the moment of this device onboarding to Dashboard
      • List cpu utilization data of wireless LAN controllers in an organization
    • clients
      • List wireless client counts of wireless LAN controllers over time in an organization
    • overview
      • List the overview information of wireless LAN controllers in an organization and it is updated every minute.
    • availabilities
      • List connectivity data of wireless LAN controllers in an organization. If it is HA setup, then only returns active WLC data start from switchover
    • connections
      • List all access points associated with wireless LAN controllers in an organization

Version 1.50.0 to v1.51.1

Summary of Changes

17 - New

51 - Updated

760 - Total operations

507 - Total Paths

What's Updated

[ licensing ]

subscription

List available subscriptions

GET /administered/licensing/subscription/subscriptions

- Optional param name added

[ devices ]

lldpCdp

List LLDP and CDP information for a device

GET /devices/{serial}/lldpCdp

- Property name Deleted

- Optional property deviceMac Added

- Response property deviceMac value added

[ networks ]

merakiAuthUsers

List the authorized users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a MX network)

GET /networks/{networkId}/merakiAuthUsers

- Summary changed from List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a MX network) to List the authorized users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a MX network)

service

Return a network

GET /networks/{networkId}

- Property isVirtual Deleted

Update a network

PUT /networks/{networkId}

- Property isVirtual Deleted

Split a combined network into individual networks for each type of device

POST /networks/{networkId}/split

- Property isVirtual Deleted

Unbind a network from a template.

POST /networks/{networkId}/unbind

- Property isVirtual Deleted

[ camera ]

qualityRetentionProfiles

Update an existing quality retention profile for this network.

PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- Optional property MV23 Added

- Optional property MV23M Added

- Optional property MV23X Added

- Optional property MV73 Added

- Optional property MV73M Added

- Optional property MV73X Added

Creates new quality retention profile for this network.

POST /networks/{networkId}/camera/qualityRetentionProfiles

- Optional property MV23 Added

- Optional property MV23M Added

- Optional property MV23X Added

- Optional property MV73 Added

- Optional property MV73M Added

- Optional property MV73X Added

[ switch ]

stacks

List the switch stacks in a network

GET /networks/{networkId}/switch/stacks

- Optional property isMonitorOnly Added

- Optional property members Added

- Response property isMonitorOnly value added

- Response property members value added

Show a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}

- Optional property isMonitorOnly Added

- Optional property members Added

- Response property isMonitorOnly value added

- Response property members value added

Create a switch stack

POST /networks/{networkId}/switch/stacks

- Optional property isMonitorOnly Added

- Optional property members Added

Add a switch to a stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/add

- Optional property isMonitorOnly Added

- Optional property members Added

Remove a switch from a stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/remove

- Optional property isMonitorOnly Added

- Optional property members Added

stormControl

Return the storm control configuration for a switch network

GET /networks/{networkId}/switch/stormControl

- Optional property treatTheseTrafficTypesAsOneThreshold Added

- Response property treatTheseTrafficTypesAsOneThreshold value added

Update the storm control configuration for a switch network

PUT /networks/{networkId}/switch/stormControl

- Optional property treatTheseTrafficTypesAsOneThreshold Added

- Optional property treatTheseTrafficTypesAsOneThreshold Added

ports

List the switchports in an organization by switch

GET /organizations/{organizationId}/switch/ports/bySwitch

- Response property properties value added

[ appliance ]

vpn

Update the third party VPN peers for an organization

PUT /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers

- Optional property publicHostname Added

[ cellularGateway ]

esims

The eSIM inventory of a given organization.

GET /organizations/{organizationId}/cellularGateway/esims/inventory

- Optional property status Added

- Response property status value added

Toggle the status of an eSIM

PUT /organizations/{organizationId}/cellularGateway/esims/inventory/{id}

- Optional property status Added

[ organizations ]

devices

List the availability information for devices in an organization

GET /organizations/{organizationId}/devices/availabilities

- Optional param statuses added

List the current uplink addresses for devices in an organization.

GET /organizations/{organizationId}/devices/uplinks/addresses/byDevice

- Optional property nameservers Added

- Response property nameservers value added

inventory

Returns list of networks eligible for adding cloud monitored device

GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks

- Property isVirtual Deleted

networks

List the networks that the user has privileges on in an organization

GET /organizations/{organizationId}/networks

- Property isVirtual Deleted

Create a network

POST /organizations/{organizationId}/networks

- Property isVirtual Deleted

Combine multiple networks into a single network

POST /organizations/{organizationId}/networks/combine

- Property isVirtual Deleted

What's New

[ wireless ]

devices

PATH /organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice

- Path added

- New operation

List of Catalyst access points information

GET /organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice

{
    "items": [
        {
            "network": {
                "id": "N_24329156"
            },
            "serial": "Q234-ABCD-5678",
            "controller": {
                "serial": "Q234-ABCD-5678"
            },
            "joinedAt": "2020-01-01T00:00:00Z",
            "model": "C9115AXI-H",
            "tags": [
                {
                    "policy": "4F",
                    "site": "default-site-tag",
                    "rf": "default-rf-tag"
                }
            ],
            "mode": "local",
            "countryCode": "CA",
            "details": [
                {
                    "name": "catalyst serial",
                    "value": "FGL2446L7QQ"
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

clients

PATH /organizations/{organizationId}/wireless/clients/overview/byDevice

- Path added

- New operation

List access point client count at the moment in an organization

GET /organizations/{organizationId}/wireless/clients/overview/byDevice

{
    "items": [
        {
            "network": {
                "id": "N_24329156"
            },
            "serial": "Q234-ABCD-5678",
            "counts": {
                "byStatus": {
                    "online": 1
                }
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

[ wirelessController ]

devices

PATH /organizations/{organizationId}/wirelessController/devices/interfaces/l2/byDevice

- Path added

- New operation

List wireless LAN controller layer 2 interfaces in an organization

GET /organizations/{organizationId}/wirelessController/devices/interfaces/l2/byDevice

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "interfaces": [
                {
                    "name": "TenGigabitEthernet0/0/5",
                    "description": "Uplink",
                    "enabled": true,
                    "mac": "b0:c5:3c:0d:c5:0b",
                    "status": "disabled",
                    "speed": "1 Gbps",
                    "isUplink": true,
                    "vlan": 10,
                    "isRedundancyPort": true,
                    "linkNegotiation": "auto",
                    "channelGroup": {
                        "number": 5
                    },
                    "module": {
                        "model": "C9800-2X40GE"
                    }
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/interfaces/l2/statuses/changeHistory/byDevice

- Path added

- New operation

List wireless LAN controller layer 2 interfaces history status in an organization

GET /organizations/{organizationId}/wirelessController/devices/interfaces/l2/statuses/changeHistory/byDevice

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "interfaces": [
                {
                    "name": "TenGigabitEthernet0/0/5",
                    "mac": "b0:c5:3c:0d:c5:0b",
                    "changes": [
                        {
                            "ts": "2020-01-01T00:00:00Z",
                            "status": "disabled",
                            "warnings": [
                                "CRC warnings"
                            ],
                            "errors": [
                                "CRC errors"
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/interfaces/l2/usage/history/byInterval

- Path added

- New operation

List wireless LAN controller layer 2 interfaces history usage in an organization

GET /organizations/{organizationId}/wirelessController/devices/interfaces/l2/usage/history/byInterval

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "readings": [
                {
                    "name": "TenGigabitEthernet0/0/5",
                    "mac": "b0:c5:3c:0d:c5:0b",
                    "recv": 0,
                    "send": 0
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/interfaces/l3/byDevice

- Path added

- New operation

List wireless LAN controller layer 3 interfaces in an organization

GET /organizations/{organizationId}/wirelessController/devices/interfaces/l3/byDevice

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "interfaces": [
                {
                    "name": "vlan123",
                    "description": "Wireless Mgmt",
                    "mac": "1c:e8:5d:00:00:0c",
                    "status": "disabled",
                    "speed": "1 Gbps",
                    "addresses": [
                        {
                            "protocol": "ipv4",
                            "address": "192.168.123.1",
                            "subnet": "192.168.123.0/24"
                        }
                    ],
                    "vrf": {
                        "name": "Global"
                    },
                    "isUplink": true,
                    "vlan": 10,
                    "linkNegotiation": "auto",
                    "channelGroup": {
                        "number": 5
                    },
                    "module": {
                        "model": "C9800-2X40GE"
                    }
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/interfaces/l3/statuses/changeHistory/byDevice

- Path added

- New operation

List wireless LAN controller layer 3 interfaces history status in an organization

GET /organizations/{organizationId}/wirelessController/devices/interfaces/l3/statuses/changeHistory/byDevice

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "interfaces": [
                {
                    "name": "TenGigabitEthernet0/0/5",
                    "mac": "b0:c5:3c:0d:c5:0b",
                    "changes": [
                        {
                            "ts": "2020-01-01T00:00:00Z",
                            "status": "disabled",
                            "warnings": [
                                "CRC warnings"
                            ],
                            "errors": [
                                "CRC errors"
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/interfaces/l3/usage/history/byInterval

- Path added

- New operation

List wireless LAN controller layer 3 interfaces history usage in an organization

GET /organizations/{organizationId}/wirelessController/devices/interfaces/l3/usage/history/byInterval

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "readings": [
                {
                    "name": "TenGigabitEthernet0/0/5",
                    "mac": "b0:c5:3c:0d:c5:0b",
                    "recv": 0,
                    "send": 0
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/interfaces/packets/overview/byDevice

- Path added

- New operation

Retrieve the packet counters for the interfaces of a Wireless LAN controller

GET /organizations/{organizationId}/wirelessController/devices/interfaces/packets/overview/byDevice

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "interfaces": [
                {
                    "name": "TenGigabitEthernet0/0/0",
                    "readings": [
                        {
                            "name": "Total",
                            "total": 2001,
                            "recv": 1000,
                            "send": 1001,
                            "rate": {
                                "total": 12,
                                "recv": 3,
                                "send": 8
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/interfaces/usage/history/byInterval

- Path added

- New operation

Retrieve the traffic for the interfaces of a Wireless LAN controller

GET /organizations/{organizationId}/wirelessController/devices/interfaces/usage/history/byInterval

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "intervals": [
                {
                    "startTs": "2024-07-25T03:20:55Z",
                    "endTs": "2024-07-25T03:25:55Z",
                    "overall": {
                        "total": 12300,
                        "recv": 2300,
                        "send": 10000
                    },
                    "byInterface": [
                        {
                            "name": "TenGigabitEthernet0/0/1",
                            "usage": {
                                "total": 12300,
                                "recv": 2300,
                                "send": 10000
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/redundancy/failover/history

- Path added

- New operation

List the failover events of wireless LAN controllers in an organization

GET /organizations/{organizationId}/wirelessController/devices/redundancy/failover/history

[
    {
        "items": [
            {
                "serial": "Q234-ABCD-5678",
                "ts": "2020-01-01T00:00:00Z",
                "reason": "Active Unit Failed",
                "failed": {
                    "chassis": {
                        "name": "Chassis 2"
                    }
                },
                "active": {
                    "chassis": {
                        "name": "Chassis 1"
                    }
                }
            }
        ],
        "meta": {
            "counts": {
                "items": {
                    "total": 10,
                    "remaining": 0
                }
            }
        }
    }
]

---

PATH /organizations/{organizationId}/wirelessController/devices/redundancy/statuses

- Path added

- New operation

List redundancy details of wireless LAN controllers in an organization. The failover count refers to the total failovers system happens from the moment of this device onboarding to Dashboard

GET /organizations/{organizationId}/wirelessController/devices/redundancy/statuses

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "mode": "SSO",
            "enabled": true,
            "failover": {
                "last": {
                    "ts": "2020-01-01T00:00:00Z",
                    "reason": "Active Unit Failed"
                },
                "counts": {
                    "total": 2
                }
            },
            "mobilityMac": "b0:c5:3c:0d:c5:0b"
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

PATH /organizations/{organizationId}/wirelessController/devices/system/utilization/history/byInterval

- Path added

- New operation

List cpu utilization data of wireless LAN controllers in an organization

GET /organizations/{organizationId}/wirelessController/devices/system/utilization/history/byInterval

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "intervals": [
                {
                    "startTs": "2024-03-04T05:25:03Z",
                    "endTs": "2024-03-04T05:30:19Z",
                    "overall": {
                        "usage": {
                            "average": {
                                "percentage": 10.59
                            }
                        }
                    },
                    "byCore": [
                        {
                            "name": "0",
                            "usage": {
                                "average": {
                                    "percentage": 2.74
                                }
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

clients

PATH /organizations/{organizationId}/wirelessController/clients/overview/history/byDevice/byInterval

- Path added

- New operation

List wireless client counts of wireless LAN controllers over time in an organization

GET /organizations/{organizationId}/wirelessController/clients/overview/history/byDevice/byInterval

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "network": {
                "id": "N_24329156"
            },
            "readings": [
                {
                    "startTs": "2020-01-01T00:00:00Z",
                    "endTs": "2020-01-01T01:00:00Z",
                    "counts": {
                        "byStatus": {
                            "online": 1
                        }
                    }
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

overview

PATH /organizations/{organizationId}/wirelessController/overview/byDevice

- Path added

- New operation

List the overview information of wireless LAN controllers in an organization and it is updated every minute.

GET /organizations/{organizationId}/wirelessController/overview/byDevice

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "network": {
                "id": "N_24329156"
            },
            "counts": {
                "clients": {
                    "byStatus": {
                        "online": 300
                    }
                },
                "connections": {
                    "total": 200,
                    "byStatus": {
                        "online": 180,
                        "offline": 20
                    }
                }
            },
            "redundancy": {
                "role": "Active",
                "id": "123456",
                "chassisName": "Chassis 1",
                "management": {
                    "addresses": [
                        {
                            "address": "10.14.140.5"
                        }
                    ]
                }
            },
            "firmware": {
                "version": {
                    "shortName": "ios-xe"
                }
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

availabilities

PATH /organizations/{organizationId}/wirelessController/availabilities/changeHistory

- Path added

- New operation

List connectivity data of wireless LAN controllers in an organization. If it is HA setup, then only returns active WLC data start from switchover

GET /organizations/{organizationId}/wirelessController/availabilities/changeHistory

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "changes": [
                {
                    "startTs": "2020-01-01T00:00:00Z",
                    "endTs": "null",
                    "status": "online"
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

connections

PATH /organizations/{organizationId}/wirelessController/connections

- Path added

- New operation

List all access points associated with wireless LAN controllers in an organization

GET /organizations/{organizationId}/wirelessController/connections

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "controller": {
                "serial": "Q234-ABCD-5678"
            },
            "network": {
                "id": "N_24329156",
                "url": "https://network/url",
                "name": "Network1"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---