Version 1.23.0 to 1.24.0

Summary of Changes

7 - New

35 - Updated

562 - Total operations

355 - Total Paths

What's Changed

[ wireless ]

rfProfiles

Creates new RF profile for this network

POST /networks/{networkId}/wireless/rfProfiles

- Property minBitrate type turn from integer to number

Updates specified RF profile for this network

PUT /networks/{networkId}/wireless/rfProfiles/{rfProfileId}

- Property minBitrate type turn from integer to number

PATH /organizations/{organizationId}/adaptivePolicy/policies/{adaptivePolicyId}

- renamed to /organizations/{organizationId}/adaptivePolicy/policies/{id}

What's Updated

[ wireless ]

ssids

Modify the splash page settings for the given SSID

PUT /networks/{networkId}/wireless/ssids/{number}/splash/settings

- Optional property selfRegistration Added

Display the splash page settings for the given SSID

GET /networks/{networkId}/wireless/ssids/{number}/splash/settings

- Response property enum value added

- Optional property selfRegistration Added

- Response property selfRegistration value added

[ devices ]

pingDevice

Return a ping device job

GET /devices/{serial}/liveTools/pingDevice/{id}

- Summary changed from Return a ping job to Return a ping device job

ping

Return a ping job

GET /devices/{serial}/liveTools/ping/{id}

- Response property properties value added

[ switch ]

ports

List the switch ports for a switch

GET /devices/{serial}/switch/ports

- Response property properties value added

- Response property allowedVlans value added

- Response property accessPolicyNumber value added

- Response property macAllowList value added

- Response property flexibleStackingEnabled value added

Return a switch port

GET /devices/{serial}/switch/ports/{portId}

- Response property properties value added

- Response property allowedVlans value added

- Response property accessPolicyNumber value added

- Response property macAllowList value added

- Response property flexibleStackingEnabled value added

List the switchports in an organization by switch

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

- Response property items value added

configTemplates

Return all the ports of a switch profile

GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports

- Response property items value added

Return a switch profile port

GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}

- Response property properties value added

- Response property allowedVlans value added

- Response property accessPolicyNumber value added

- Response property macAllowList value added

- Response property flexibleStackingEnabled value added

[ networks ]

firmwareUpgrades

Update firmware upgrade information for a network

PUT /networks/{networkId}/firmwareUpgrades

- Property vmxHost Deleted

- Property environmental Deleted

- Property vmxHost Deleted

- Property environmental Deleted

Get firmware upgrade information for a network

GET /networks/{networkId}/firmwareUpgrades

- Property vmxHost Deleted

- Property environmental Deleted

service

Return a network

GET /networks/{networkId}

- Response property properties value added

- Response property url 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 highAvailability value added

[ organizations ]

inventory

Claim a list of devices, licenses, and/or orders into an organization inventory

POST /organizations/{organizationId}/inventory/claim

- Summary changed from Claim a list of devices, licenses, and/or orders into an organization to Claim a list of devices, licenses, and/or orders into an organization inventory

webhooks

Return a list of alert types to be used with managing webhook alerts

GET /organizations/{organizationId}/webhooks/alertTypes

- Response property enrollmentString value added

- Response property notes value added

What's New

[ switch ]

ports

PATH /networks/{networkId}/switch/ports/profiles

- Path added

- New operation

List the Switch Port Profiles in a network

GET /networks/{networkId}/switch/ports/profiles

Code Snippet

Copy[
    {
        "profileId": "1284392014819",
        "networkId": "N_24329156",
        "iname": "phone",
        "name": "Phone",
        "description": "IP Phones for all office workers",
        "tags": [
            "tag1",
            "tag2"
        ],
        "port": {
            "type": "access",
            "vlan": 10,
            "voiceVlan": 20,
            "allowedVlans": "1-100",
            "poeEnabled": true,
            "isolationEnabled": false,
            "rstpEnabled": true,
            "stpGuard": "disabled",
            "linkNegotiation": "Auto negotiate",
            "linkNegotiationCapabilities": [
                "Auto negotiate",
                "1 Gigabit full duplex (auto)"
            ],
            "portScheduleId": "1284392014819",
            "udld": "Alert only",
            "accessPolicyType": "Sticky MAC allow list",
            "accessPolicyNumber": 3,
            "macAllowList": [
                "34:56:fe:ce:8e:b0",
                "34:56:fe:ce:8e:b1"
            ],
            "stickyMacAllowList": [
                "34:56:fe:ce:8e:b0",
                "34:56:fe:ce:8e:b1"
            ],
            "stickyMacAllowListLimit": 5,
            "stormControlEnabled": true,
            "adaptivePolicyGroupId": "1284392014819",
            "peerSgtCapable": false
        }
    }
]

[ networks ]

alerts

PATH /networks/{networkId}/alerts/history

- Path added

- New operation

Return the alert history for this network

GET /networks/{networkId}/alerts/history

Code Snippet

Copy[
    {
        "occurredAt": "2022-07-11T22:35:34Z",
        "alertTypeId": "settings_changed",
        "alertType": "Settings changed",
        "device": {
            "serial": "Q2KN-6CN7-EC4X"
        },
        "destinations": {
            "email": {
                "sentAt": "2022-07-11T22:40:34Z"
            },
            "push": {
                "sentAt": "2022-07-11T22:40:34Z"
            },
            "sms": {
                "sentAt": "2022-07-11T22:40:34Z"
            },
            "webhook": {
                "sentAt": "2022-07-11T22:40:34Z"
            }
        }
    }
]

[ appliance ]

firewall

PATH /networks/{networkId}/appliance/firewall/settings

- Path added

- New operation

Return the firewall settings for this network

GET /networks/{networkId}/appliance/firewall/settings
Code Snippet
Copy{
    "spoofingProtection": {
        "ipSourceGuard": {
            "mode": "block"
        }
    }
}
- New operation

Update the firewall settings for this network

PUT /networks/{networkId}/appliance/firewall/settings
Code Snippet
Copy{
    "spoofingProtection": {
        "ipSourceGuard": {
            "mode": "block"
        }
    }
}

[ organizations ]

devices

PATH /organizations/{organizationId}/devices/powerModules/statuses/byDevice

- Path added

- New operation

List the power status information for devices in an organization. The data returned by this operation is updated every 5 minutes.

GET /organizations/{organizationId}/devices/powerModules/statuses/byDevice
Code Snippet
Copy[
    {
        "mac": "00:11:22:33:44:55",
        "name": "My AP",
        "network": {
            "id": "N_24329156"
        },
        "productType": "switch",
        "serial": "Q234-ABCD-5678",
        "tags": [
            "tag1",
            "tag2"
        ],
        "slots": [
            {
                "number": 1,
                "serial": "Q234-ABCD-5678",
                "model": "PWR-C5-125WAC",
                "status": "not connected"
            }
        ]
    }
]

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

- Path added

- New operation

List the current uplink addresses for devices in an organization.

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

Code Snippet

Copy[
    {
        "mac": "00:11:22:33:44:55",
        "name": "My AP",
        "network": {
            "id": "N_24329156"
        },
        "productType": "switch",
        "serial": "Q234-ABCD-5678",
        "tags": [
            "tag1",
            "tag2"
        ],
        "uplinks": [
            {
                "interface": "wan1",
                "addresses": [
                    {
                        "protocol": "ipv6",
                        "assignmentMode": "static",
                        "address": "2001:db8:3c4d:15::1",
                        "gateway": "1.2.3.5",
                        "public": {
                            "address": "192.168.1.1"
                        }
                    }
                ]
            }
        ]
    }
]

[ sensor ]

alerts

PATH /networks/{networkId}/sensor/alerts/profiles

- Path added

- New operation

Lists all sensor alert profiles for a network.

GET /networks/{networkId}/sensor/alerts/profiles

Code Snippet

Copy[
    {
        "profileId": "1",
        "name": "My Sensor Alert Profile",
        "schedule": {
            "id": "5",
            "name": "My Schedule"
        },
        "conditions": [
            {
                "metric": "temperature",
                "threshold": {
                    "temperature": {
                        "celsius": 20.5,
                        "fahrenheit": 70,
                        "quality": "good"
                    },
                    "humidity": {
                        "relativePercentage": 65,
                        "quality": "inadequate"
                    },
                    "water": {
                        "present": true
                    },
                    "door": {
                        "open": true
                    },
                    "tvoc": {
                        "concentration": 400,
                        "quality": "poor"
                    },
                    "pm25": {
                        "concentration": 90,
                        "quality": "fair"
                    },
                    "noise": {
                        "ambient": {
                            "level": 120,
                            "quality": "poor"
                        }
                    },
                    "indoorAirQuality": {
                        "score": 80,
                        "quality": "fair"
                    }
                },
                "direction": "above",
                "duration": 60
            }
        ],
        "recipients": {
            "emails": [
                "miles@meraki.com"
            ],
            "smsNumbers": [
                "+15555555555"
            ],
            "httpServerIds": [
                "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="
            ]
        },
        "serials": [
            "Q234-ABCD-0001",
            "Q234-ABCD-0002",
            "Q234-ABCD-0003"
        ]
    }
]

- New operation

Creates a sensor alert profile for a network.

POST /networks/{networkId}/sensor/alerts/profiles

Code Snippet

Copy{
    "profileId": "1",
    "name": "My Sensor Alert Profile",
    "schedule": {
        "id": "5",
        "name": "My Schedule"
    },
    "conditions": [
        {
            "metric": "temperature",
            "threshold": {
                "temperature": {
                    "celsius": 20.5,
                    "fahrenheit": 70,
                    "quality": "good"
                },
                "humidity": {
                    "relativePercentage": 65,
                    "quality": "inadequate"
                },
                "water": {
                    "present": true
                },
                "door": {
                    "open": true
                },
                "tvoc": {
                    "concentration": 400,
                    "quality": "poor"
                },
                "pm25": {
                    "concentration": 90,
                    "quality": "fair"
                },
                "noise": {
                    "ambient": {
                        "level": 120,
                        "quality": "poor"
                    }
                },
                "indoorAirQuality": {
                    "score": 80,
                    "quality": "fair"
                }
            },
            "direction": "above",
            "duration": 60
        }
    ],
    "recipients": {
        "emails": [
            "miles@meraki.com"
        ],
        "smsNumbers": [
            "+15555555555"
        ],
        "httpServerIds": [
            "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="
        ]
    },
    "serials": [
        "Q234-ABCD-0001",
        "Q234-ABCD-0002",
        "Q234-ABCD-0003"
    ]
}

PATH /networks/{networkId}/sensor/alerts/profiles/{id}

- Path added

- New operation

Show details of a sensor alert profile for a network.

GET /networks/{networkId}/sensor/alerts/profiles/{id}

Code Snippet

Copy{
    "profileId": "1",
    "name": "My Sensor Alert Profile",
    "schedule": {
        "id": "5",
        "name": "My Schedule"
    },
    "conditions": [
        {
            "metric": "temperature",
            "threshold": {
                "temperature": {
                    "celsius": 20.5,
                    "fahrenheit": 70,
                    "quality": "good"
                },
                "humidity": {
                    "relativePercentage": 65,
                    "quality": "inadequate"
                },
                "water": {
                    "present": true
                },
                "door": {
                    "open": true
                },
                "tvoc": {
                    "concentration": 400,
                    "quality": "poor"
                },
                "pm25": {
                    "concentration": 90,
                    "quality": "fair"
                },
                "noise": {
                    "ambient": {
                        "level": 120,
                        "quality": "poor"
                    }
                },
                "indoorAirQuality": {
                    "score": 80,
                    "quality": "fair"
                }
            },
            "direction": "above",
            "duration": 60
        }
    ],
    "recipients": {
        "emails": [
            "miles@meraki.com"
        ],
        "smsNumbers": [
            "+15555555555"
        ],
        "httpServerIds": [
            "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="
        ]
    },
    "serials": [
        "Q234-ABCD-0001",
        "Q234-ABCD-0002",
        "Q234-ABCD-0003"
    ]
}

- New operation

Updates a sensor alert profile for a network.

PUT /networks/{networkId}/sensor/alerts/profiles/{id}

Code Snippet

Copy{
    "profileId": "1",
    "name": "My Sensor Alert Profile",
    "schedule": {
        "id": "5",
        "name": "My Schedule"
    },
    "conditions": [
        {
            "metric": "temperature",
            "threshold": {
                "temperature": {
                    "celsius": 20.5,
                    "fahrenheit": 70,
                    "quality": "good"
                },
                "humidity": {
                    "relativePercentage": 65,
                    "quality": "inadequate"
                },
                "water": {
                    "present": true
                },
                "door": {
                    "open": true
                },
                "tvoc": {
                    "concentration": 400,
                    "quality": "poor"
                },
                "pm25": {
                    "concentration": 90,
                    "quality": "fair"
                },
                "noise": {
                    "ambient": {
                        "level": 120,
                        "quality": "poor"
                    }
                },
                "indoorAirQuality": {
                    "score": 80,
                    "quality": "fair"
                }
            },
            "direction": "above",
            "duration": 60
        }
    ],
    "recipients": {
        "emails": [
            "miles@meraki.com"
        ],
        "smsNumbers": [
            "+15555555555"
        ],
        "httpServerIds": [
            "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="
        ]
    },
    "serials": [
        "Q234-ABCD-0001",
        "Q234-ABCD-0002",
        "Q234-ABCD-0003"
    ]
}

- New operation

Deletes a sensor alert profile from a network.

DELETE /networks/{networkId}/sensor/alerts/profiles/{id}