What's Updated
What's New

Version 1.54.0 to 1.55.0

Summary of Changes

15 - New

82 - Updated

797 - Total Endpoints

537 - Total Paths

What's Updated

[ switch ]

routing

List layer 3 interfaces for a switch

GET /devices/{serial}/switch/routing/interfaces

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property vrf Added

- Response property uplinkV4 value added

- Response property uplinkV6 value added

Return a layer 3 interface for a switch

GET /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property vrf Added

- Response property uplinkV4 value added

- Response property uplinkV6 value added

Create a layer 3 interface for a switch

POST /devices/{serial}/switch/routing/interfaces

- Optional property vrf Added

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property vrf Added

Update a layer 3 interface for a switch

PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Optional property vrf Added

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property vrf Added

stacks

List layer 3 interfaces for a switch stack

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

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property vrf Added

- Response property uplinkV4 value added

- Response property uplinkV6 value added

Return a layer 3 interface from a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property vrf Added

- Response property uplinkV4 value added

- Response property uplinkV6 value added

Create a layer 3 interface for a switch stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property vrf Added

Update a layer 3 interface for a switch stack

PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property vrf Added

[ appliance ]

uplinks

Get the sent and received bytes for each uplink of a network.

GET /networks/{networkId}/appliance/uplinks/usageHistory

- Response property properties value added

performance

Return the performance score for a single MX

GET /devices/{serial}/appliance/performance

- Response property properties value added

vpn

Show VPN history stat for networks in an organization

GET /organizations/{organizationId}/appliance/vpn/stats

- Response property properties value added

dhcp

Return the DHCP subnet information for an appliance

GET /devices/{serial}/appliance/dhcp/subnets

- Response property properties value added

[ networks ]

floorPlans

List the floor plans that belong to your network

GET /networks/{networkId}/floorPlans

- Optional property floorNumber Added

- Response property floorNumber value added

Find a floor plan by ID

GET /networks/{networkId}/floorPlans/{floorPlanId}

- Optional property floorNumber Added

- Response property floorNumber value added

Upload a floor plan

POST /networks/{networkId}/floorPlans

- Optional property floorNumber Added

Update a floor plan's geolocation and other meta data

PUT /networks/{networkId}/floorPlans/{floorPlanId}

- Optional property floorNumber Added

Destroy a floor plan

DELETE /networks/{networkId}/floorPlans/{floorPlanId}

- Optional property floorNumber Added

settings

Update the settings for a network

PUT /networks/{networkId}/settings

- Optional property username Added

syslogServers

List the syslog servers for a network

GET /networks/{networkId}/syslogServers

- Optional property encryption Added

- Response property encryption value added

Update the syslog servers for a network

PUT /networks/{networkId}/syslogServers

- Optional property encryption Added

[ organizations ]

uplinks

List the uplink status of every Meraki MX, MG and Z series devices in the organization

GET /organizations/{organizationId}/uplinks/statuses

- Optional property mcc Added

- Optional property mnc Added

- Optional property roaming Added

- Optional property mtu Added

- Optional property imsi Added

- Optional property msisdn Added

- Response property mcc value added

- Response property mnc value added

- Response property roaming value added

- Response property mtu value added

- Response property imsi value added

- Response property msisdn value added

apiRequests

List the API requests made by an organization

GET /organizations/{organizationId}/apiRequests

- Optional property client Added

- Response property client value added

configurationChanges

View the Change Log for your organization

GET /organizations/{organizationId}/configurationChanges

- Optional property client Added

- Response property client value added

[ cellularGateway ]

uplink

List the uplink status of every Meraki MG cellular gateway in the organization

GET /organizations/{organizationId}/cellularGateway/uplink/statuses

- Optional property mcc Added

- Optional property mnc Added

- Optional property roaming Added

- Optional property mtu Added

- Optional property imsi Added

- Optional property msisdn Added

- Response property mcc value added

- Response property mnc value added

- Response property roaming value added

- Response property mtu value added

- Response property imsi value added

- Response property msisdn value added

[ wirelessController ]

overview

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

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

- Optional property redundantSerial Added

- Response property redundantSerial value added

What's New

[ appliance ]

dns

PATH /organizations/{organizationId}/appliance/dns/local/profiles

- Path added

- New endpoint

Fetch the local DNS profiles used in the organization

GET /organizations/{organizationId}/appliance/dns/local/profiles
[
    {
        "profileId": "123456",
        "name": "Default profile"
    }
]
- New endpoint

Create a new local DNS profile

POST /organizations/{organizationId}/appliance/dns/local/profiles
{
    "profileId": "123456",
    "name": "Default profile"
}

PATH /organizations/{organizationId}/appliance/dns/local/profiles/assignments

- Path added

- New endpoint

Fetch the local DNS profile assignments in the organization

GET /organizations/{organizationId}/appliance/dns/local/profiles/assignments

{
    "items": [
        {
            "assignmentId": "123456",
            "network": {
                "id": "N_123456"
            },
            "profile": {
                "id": "1234"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

PATH /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate

- Path added

- New endpoint

Assign the local DNS profile to networks in the organization

POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate
{
    "items": [
        {
            "assignmentId": "123456",
            "network": {
                "id": "N_123456"
            },
            "profile": {
                "id": "1234"
            }
        }
    ]
}

PATH /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete

- Path added

- New endpoint

Unassign the local DNS profile to networks in the organization

POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete
{
    "items": [
        {
            "assignmentId": "123456",
            "network": {
                "id": "N_123456"
            },
            "profile": {
                "id": "1234"
            }
        }
    ]
}

PATH /organizations/{organizationId}/appliance/dns/local/profiles/{profileId}

- Path added

- New endpoint

Update a local DNS profile

PUT /organizations/{organizationId}/appliance/dns/local/profiles/{profileId}
{
    "profileId": "123456",
    "name": "Default profile"
}
- New endpoint

Deletes a local DNS profile

DELETE /organizations/{organizationId}/appliance/dns/local/profiles/{profileId}

PATH /organizations/{organizationId}/appliance/dns/local/records

- Path added

- New endpoint

Fetch the DNS records used in local DNS profiles

GET /organizations/{organizationId}/appliance/dns/local/records
[
    {
        "recordId": "12345",
        "hostname": "www.test.com",
        "address": "10.1.1.0",
        "profile": {
            "id": "1"
        }
    }
]
- New endpoint

Create a new local DNS record

POST /organizations/{organizationId}/appliance/dns/local/records
[
    {
        "recordId": "12345",
        "hostname": "www.test.com",
        "address": "10.1.1.0",
        "profile": {
            "id": "1"
        }
    }
]

PATH /organizations/{organizationId}/appliance/dns/local/records/{recordId}

- Path added

- New endpoint

Updates a local DNS record

PUT /organizations/{organizationId}/appliance/dns/local/records/{recordId}
{
    "recordId": "12345",
    "hostname": "www.test.com",
    "address": "10.1.1.0",
    "profile": {
        "id": "1"
    }
}
- New endpoint

Deletes a local DNS record

DELETE /organizations/{organizationId}/appliance/dns/local/records/{recordId}

PATH /organizations/{organizationId}/appliance/dns/split/profiles

- Path added

- New endpoint

Fetch the split DNS profiles used in the organization

GET /organizations/{organizationId}/appliance/dns/split/profiles
[
    {
        "profileId": "123456",
        "name": "Default profile",
        "hostnames": [
            "*.test1.com",
            "*.test2.com"
        ],
        "nameservers": {
            "addresses": [
                "12.1.10.1"
            ]
        }
    }
]
- New endpoint

Create a new split DNS profile

POST /organizations/{organizationId}/appliance/dns/split/profiles
{
    "profileId": "123456",
    "name": "Default profile",
    "hostnames": [
        "*.test1.com",
        "*.test2.com"
    ],
    "nameservers": {
        "addresses": [
            "12.1.10.1"
        ]
    }
}

PATH /organizations/{organizationId}/appliance/dns/split/profiles/assignments

- Path added

- New endpoint

Fetch the split DNS profile assignments in the organization

GET /organizations/{organizationId}/appliance/dns/split/profiles/assignments

{
    "items": [
        {
            "assignmentId": "123456",
            "network": {
                "id": "N_123456"
            },
            "profile": {
                "id": "1234"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

PATH /organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkCreate

- Path added

- New endpoint

Assign the split DNS profile to networks in the organization

POST /organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkCreate
{
    "items": [
        {
            "assignmentId": "123456",
            "network": {
                "id": "N_123456"
            },
            "profile": {
                "id": "1234"
            }
        }
    ]
}

PATH /organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkDelete

- Path added

- New endpoint

Unassign the split DNS profile to networks in the organization

POST /organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkDelete
{
    "items": [
        {
            "assignmentId": "123456",
            "network": {
                "id": "N_123456"
            },
            "profile": {
                "id": "1234"
            }
        }
    ]
}

PATH /organizations/{organizationId}/appliance/dns/split/profiles/{profileId}

- Path added

- New endpoint

Update a split DNS profile

PUT /organizations/{organizationId}/appliance/dns/split/profiles/{profileId}
{
    "profileId": "123456",
    "name": "Default profile",
    "hostnames": [
        "*.test1.com",
        "*.test2.com"
    ],
    "nameservers": {
        "addresses": [
            "12.1.10.1"
        ]
    }
}
- New endpoint

Deletes a split DNS profile

DELETE /organizations/{organizationId}/appliance/dns/split/profiles/{profileId}

[ organizations ]

devices

PATH /organizations/{organizationId}/devices/system/memory/usage/history/byInterval

- Path added

- New endpoint

Return the memory utilization history in kB for devices in the organization.

GET /organizations/{organizationId}/devices/system/memory/usage/history/byInterval

{
    "items": [
        {
            "serial": "Q234-ABCD-0001",
            "model": "MS",
            "name": "My switch",
            "mac": "00:11:22:33:44:55",
            "tags": [
                "tag1",
                "tag2"
            ],
            "provisioned": 300,
            "used": {
                "median": 100
            },
            "free": {
                "median": 150
            },
            "network": {
                "id": "N_24329156",
                "name": "Main Office",
                "tags": [
                    "tag1",
                    "tag2"
                ]
            },
            "intervals": [
                {
                    "startTs": "2018-02-11T00:00:00.090210Z",
                    "endTs": "2018-02-11T00:00:00.090210Z",
                    "memory": {
                        "used": {
                            "minimum": 50,
                            "maximum": 150,
                            "median": 100,
                            "percentages": {
                                "maximum": 60
                            }
                        },
                        "free": {
                            "minimum": 100,
                            "maximum": 200,
                            "median": 150
                        }
                    }
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 4,
                "remaining": 2
            }
        }
    }
}

[ wireless ]

devices

PATH /organizations/{organizationId}/wireless/devices/power/mode/history

- Path added

- New endpoint

Return a record of power mode changes for wireless devices in the organization. For each device, it provides a series of events with timestamps indicating when a power mode change occurred and the new mode. The events are ordered by timestamp.

GET /organizations/{organizationId}/wireless/devices/power/mode/history
{
    "items": [
        {
            "serial": "Q234-ABCD-0001",
            "model": "MR",
            "name": "My AP",
            "mac": "00:11:22:33:44:55",
            "tags": [
                "tag1",
                "tag2"
            ],
            "network": {
                "id": "N_24329156",
                "name": "Main Office",
                "tags": [
                    "tag1",
                    "tag2"
                ]
            },
            "events": [
                {
                    "ts": "2018-02-11T00:00:00.090210Z",
                    "powerMode": "full power"
                }
            ]
        }
    ]
}

PATH /organizations/{organizationId}/wireless/devices/system/cpu/load/history

- Path added

- New endpoint

Return the CPU Load history for a list of wireless devices in the organization.

GET /organizations/{organizationId}/wireless/devices/system/cpu/load/history

{
    "items": [
        {
            "serial": "Q234-ABCD-0001",
            "model": "MR",
            "name": "My AP",
            "mac": "00:11:22:33:44:55",
            "tags": [
                "tag1",
                "tag2"
            ],
            "network": {
                "id": "N_24329156",
                "name": "Main Office",
                "tags": [
                    "tag1",
                    "tag2"
                ]
            },
            "cpuCount": 4,
            "series": [
                {
                    "ts": "2018-02-11T00:00:00.090210Z",
                    "cpuLoad5": 1000
                }
            ]
        }
    ]
}