Version 1.57.0 to 1.58.0

Summary of Changes

15 - New

25 - Updated

826 - Total Endpoints

559 - Total Paths

What's Updated

[ licensing ]

subscription

List available subscriptions

GET /administered/licensing/subscription/subscriptions

- Optional param skus added

[ switch ]

ports

List the switch ports for a switch

GET /devices/{serial}/switch/ports

- Optional property macWhitelistLimit Added

- Response property macWhitelistLimit value added

Return a switch port

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

- Optional property macWhitelistLimit Added

- Response property macWhitelistLimit value added

Update a switch port

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

- Optional property macWhitelistLimit Added

- Optional property macWhitelistLimit Added

accessPolicies

List the access policies for a switch network

GET /networks/{networkId}/switch/accessPolicies

- Optional property enforceRadiusMonitoring Added

- Response property enforceRadiusMonitoring value added

Return a specific access policy for a switch network

GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}

- Optional property enforceRadiusMonitoring Added

- Response property enforceRadiusMonitoring value added

Update an access policy for a switch network

PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}

- Optional property enforceRadiusMonitoring Added

Create an access policy for a switch network

POST /networks/{networkId}/switch/accessPolicies

- Optional property enforceRadiusMonitoring Added

configTemplates

Return all the ports of a switch template

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

- Optional property macWhitelistLimit Added

- Response property macWhitelistLimit value added

Return a switch template port

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

- Optional property macWhitelistLimit Added

- Response property macWhitelistLimit value added

Update a switch template port

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

- Optional property macWhitelistLimit Added

- Optional property macWhitelistLimit Added

[ networks ]

clients

Return the client associated with the given identifier

GET /networks/{networkId}/clients/{clientId}

- Optional property namedVlan Added

- Optional property deviceTypePrediction Added

- Response property namedVlan value added

- Response property deviceTypePrediction value added

devices

Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requests against that device to succeed)

POST /networks/{networkId}/devices/claim

- Optional property detailsByDevice Added

[ wireless ]

ssids

Update the attributes of an MR SSID

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

- Optional property adaptivePolicyGroupId Added

What's New

[ wireless ]

location

PATH /networks/{networkId}/wireless/location/scanning

- Path added

- New endpoint

Change scanning API settings

PUT /networks/{networkId}/wireless/location/scanning 

{
    "enabled": true,
    "api": {
        "enabled": true,
        "validator": {
            "string": "sample_validator"
        }
    }
}

PATH /organizations/{organizationId}/wireless/location/scanning/byNetwork

- Path added

- New endpoint

Return scanning API settings

GET /organizations/{organizationId}/wireless/location/scanning/byNetwork 

{
    "items": [
        {
            "networkId": "L_1234",
            "name": "My Network",
            "enabled": true,
            "api": {
                "enabled": true,
                "validator": {
                    "string": "sample_validator"
                }
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

PATH /organizations/{organizationId}/wireless/location/scanning/receivers

- Path added

- New endpoint

Return scanning API receivers

GET /organizations/{organizationId}/wireless/location/scanning/receivers 

{
    "items": [
        {
            "network": {
                "id": "L_1234",
                "name": "My Network"
            },
            "receiverId": "1234567",
            "url": "https://www.myreceiver.com",
            "version": "3",
            "radio": {
                "type": "Wi-Fi"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

- New endpoint

Add new receiver for scanning API

POST /organizations/{organizationId}/wireless/location/scanning/receivers 

{
    "network": {
        "id": "L_1234",
        "name": "My Network"
    },
    "receiverId": "1234567",
    "url": "https://www.myreceiver.com",
    "version": "3",
    "radio": {
        "type": "Wi-Fi"
    }
}

PATH /organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}

- Path added

- New endpoint

Change scanning API receiver settings

PUT /organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId} 

{
    "network": {
        "id": "L_1234",
        "name": "My Network"
    },
    "receiverId": "1234567",
    "url": "https://www.myreceiver.com",
    "version": "3",
    "radio": {
        "type": "Wi-Fi"
    }
}

- New endpoint

Delete a scanning API receiver

DELETE /organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}

[ devices ]

macTable

PATH /devices/{serial}/liveTools/macTable

- Path added

- New endpoint

Enqueue a job to request the MAC table from the device. Switches currently support this feature. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/macTable 

{
    "macTableId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/macTable/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

PATH /devices/{serial}/liveTools/macTable/{macTableId}

- Path added

- New endpoint

Return a MAC table live tool job.

GET /devices/{serial}/liveTools/macTable/{macTableId} 

{
    "macTableId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/macTable/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "entries": [
        {
            "mac": "00:11:22:33:44:55",
            "port": "Tw1/0/9",
            "vlanId": 100
        }
    ],
    "error": "The device is unreachable."
}

[ organizations ]

devices

PATH /organizations/{organizationId}/devices/packetCapture/captures

- Path added

- New endpoint

List Packet Captures

GET /organizations/{organizationId}/devices/packetCapture/captures 

{
    "items": [
        {
            "captureId": "1234",
            "network": {
                "id": "N_24329156",
                "name": "Main Office"
            },
            "device": {
                "name": "My AP",
                "serial": "Q234-ABCD-5678"
            },
            "admin": {
                "id": "1234",
                "name": "Miles Meraki"
            },
            "client": {
                "id": "k74272e",
                "mac": "22:33:44:55:66:77"
            },
            "details": [
                {
                    "name": "reason",
                    "value": "bad_password",
                    "productType": "wireless"
                }
            ],
            "name": "file_name",
            "startTs": "2018-02-11T00:00:00.090210Z",
            "ports": "1, 2",
            "status": "capturing",
            "errorMessage": "Some error message",
            "destination": "upload_to_cloud",
            "process": "automatic",
            "file": {
                "size": 1066
            },
            "duration": 60,
            "filterExpression": "(icmp)",
            "counts": {
                "packets": {
                    "total": 10
                }
            },
            "interface": "wired"
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 100,
                "remaining": 100
            }
        }
    }
}

- New endpoint

Perform a packet capture on a device and store in Meraki Cloud. Only a single switch may be chosen per request, while multiple access points are allowed at once.

POST /organizations/{organizationId}/devices/packetCapture/captures 

{
    "captureId": "1234",
    "network": {
        "id": "N_24329156",
        "name": "Main Office"
    },
    "device": {
        "name": "My AP",
        "serial": "Q234-ABCD-5678"
    },
    "admin": {
        "id": "1234",
        "name": "Miles Meraki"
    },
    "client": {
        "id": "k74272e",
        "mac": "22:33:44:55:66:77"
    },
    "details": [
        {
            "name": "reason",
            "value": "bad_password",
            "productType": "wireless"
        }
    ],
    "name": "file_name",
    "startTs": "2018-02-11T00:00:00.090210Z",
    "ports": "1, 2",
    "status": "capturing",
    "errorMessage": "Some error message",
    "destination": "upload_to_cloud",
    "process": "automatic",
    "file": {
        "size": 1066
    },
    "duration": 60,
    "filterExpression": "(icmp)",
    "counts": {
        "packets": {
            "total": 10
        }
    },
    "interface": "wired"
}

PATH /organizations/{organizationId}/devices/packetCapture/captures/bulkCreate

- Path added

- New endpoint

Perform a packet capture on multiple devices and store in Meraki Cloud.

POST /organizations/{organizationId}/devices/packetCapture/captures/bulkCreate 

{
    "items": [
        {
            "captureId": "1234",
            "network": {
                "id": "N_24329156",
                "name": "Main Office"
            },
            "device": {
                "name": "My AP",
                "serial": "Q234-ABCD-5678"
            },
            "admin": {
                "id": "1234",
                "name": "Miles Meraki"
            },
            "client": {
                "id": "k74272e",
                "mac": "22:33:44:55:66:77"
            },
            "details": [
                {
                    "name": "reason",
                    "value": "bad_password",
                    "productType": "wireless"
                }
            ],
            "name": "file_name",
            "startTs": "2018-02-11T00:00:00.090210Z",
            "ports": "1, 2",
            "status": "capturing",
            "errorMessage": "Some error message",
            "destination": "upload_to_cloud",
            "process": "automatic",
            "file": {
                "size": 1066
            },
            "duration": 60,
            "filterExpression": "(icmp)",
            "counts": {
                "packets": {
                    "total": 10
                }
            },
            "interface": "wired"
        }
    ]
}

PATH /organizations/{organizationId}/devices/packetCapture/captures/bulkDelete

- Path added

- New endpoint

BulkDelete packet captures from cloud

POST /organizations/{organizationId}/devices/packetCapture/captures/bulkDelete

PATH /organizations/{organizationId}/devices/packetCapture/captures/{captureId}

- Path added

- New endpoint

Delete a single packet capture from cloud using captureId

DELETE /organizations/{organizationId}/devices/packetCapture/captures/{captureId}

PATH /organizations/{organizationId}/devices/packetCapture/captures/{captureId}/downloadUrl/generate

- Path added

- New endpoint

Get presigned download URL for given packet capture id

POST /organizations/{organizationId}/devices/packetCapture/captures/{captureId}/downloadUrl/generate 

{
    "captureId": "1234",
    "downloadUrl": "example.com",
    "url": "example.com"
}

PATH /organizations/{organizationId}/devices/packetCapture/captures/{captureId}/stop

- Path added

- New endpoint

Stop a specific packet capture (not supported for Catalyst devices)

POST /organizations/{organizationId}/devices/packetCapture/captures/{captureId}/stop 

{
    "captureId": "1234",
    "network": {
        "id": "N_24329156",
        "name": "Main Office"
    },
    "device": {
        "name": "My AP",
        "serial": "Q234-ABCD-5678"
    },
    "admin": {
        "id": "1234",
        "name": "Miles Meraki"
    },
    "client": {
        "id": "k74272e",
        "mac": "22:33:44:55:66:77"
    },
    "details": [
        {
            "name": "reason",
            "value": "bad_password",
            "productType": "wireless"
        }
    ],
    "name": "file_name",
    "startTs": "2018-02-11T00:00:00.090210Z",
    "ports": "1, 2",
    "status": "capturing",
    "errorMessage": "Some error message",
    "destination": "upload_to_cloud",
    "process": "automatic",
    "file": {
        "size": 1066
    },
    "duration": 60,
    "filterExpression": "(icmp)",
    "counts": {
        "packets": {
            "total": 10
        }
    },
    "interface": "wired"
}

PATH /organizations/{organizationId}/devices/packetCapture/schedules

- Path added

- New endpoint

List the Packet Capture Schedules

GET /organizations/{organizationId}/devices/packetCapture/schedules 

{
    "items": [
        {
            "scheduleId": "1234",
            "devices": [
                {
                    "device": {
                        "serial": "Q234-ABCD-5678",
                        "switchports": "1-3, 9",
                        "interface": "GigabitEthernet1/0/1"
                    }
                }
            ],
            "name": "pcap_file_name",
            "admin": {
                "id": "1234",
                "name": "Miles Meraki"
            },
            "notes": "capture reason",
            "duration": 60,
            "filterExpression": "(icmp)",
            "createdAt": "2018-02-11T00:00:00.090210Z",
            "updatedAt": "2018-02-11T00:00:00.090210Z",
            "captureCount": 2,
            "lastCaptureId": "1234",
            "enabled": true,
            "priority": 1,
            "schedule": {
                "name": "schedule_name",
                "startTs": "2018-02-11T00:00:00.090210Z",
                "endTs": "2018-02-11T00:00:00.090210Z",
                "frequency": "week",
                "weekdays": [
                    "Monday",
                    "Tuesday"
                ],
                "recurrence": 1,
                "nextCaptureTs": "2018-02-11T00:00:00.090210Z"
            },
            "warnings": [
                "This schedule conflicts with the schedule Test Schedule at the time 2025-01-28T18:25:06Z"
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 100
            }
        }
    }
}

- New endpoint

Create a schedule for packet capture

POST /organizations/{organizationId}/devices/packetCapture/schedules 

{
    "scheduleId": "1234",
    "devices": [
        {
            "device": {
                "serial": "Q234-ABCD-5678",
                "switchports": "1-3, 9",
                "interface": "GigabitEthernet1/0/1"
            }
        }
    ],
    "name": "pcap_file_name",
    "admin": {
        "id": "1234",
        "name": "Miles Meraki"
    },
    "notes": "capture reason",
    "duration": 60,
    "filterExpression": "(icmp)",
    "createdAt": "2018-02-11T00:00:00.090210Z",
    "updatedAt": "2018-02-11T00:00:00.090210Z",
    "captureCount": 2,
    "lastCaptureId": "1234",
    "enabled": true,
    "priority": 1,
    "schedule": {
        "name": "schedule_name",
        "startTs": "2018-02-11T00:00:00.090210Z",
        "endTs": "2018-02-11T00:00:00.090210Z",
        "frequency": "week",
        "weekdays": [
            "Monday",
            "Tuesday"
        ],
        "recurrence": 1,
        "nextCaptureTs": "2018-02-11T00:00:00.090210Z"
    },
    "warnings": [
        "This schedule conflicts with the schedule Test Schedule at the time 2025-01-28T18:25:06Z"
    ]
}

PATH /organizations/{organizationId}/devices/packetCapture/schedules/reorder

- Path added

- New endpoint

Bulk update priorities of pcap schedules

POST /organizations/{organizationId}/devices/packetCapture/schedules/reorder 

{
    "updatedPriorities": [
        {
            "pcapScheduleConfigurationId": "1234",
            "priority": 1
        }
    ]
}

PATH /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}

- Path added

- New endpoint

Update a schedule for packet capture

PUT /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId} 

{
    "scheduleId": "1234",
    "devices": [
        {
            "device": {
                "serial": "Q234-ABCD-5678",
                "switchports": "1-3, 9",
                "interface": "GigabitEthernet1/0/1"
            }
        }
    ],
    "name": "pcap_file_name",
    "admin": {
        "id": "1234",
        "name": "Miles Meraki"
    },
    "notes": "capture reason",
    "duration": 60,
    "filterExpression": "(icmp)",
    "createdAt": "2018-02-11T00:00:00.090210Z",
    "updatedAt": "2018-02-11T00:00:00.090210Z",
    "captureCount": 2,
    "lastCaptureId": "1234",
    "enabled": true,
    "priority": 1,
    "schedule": {
        "name": "schedule_name",
        "startTs": "2018-02-11T00:00:00.090210Z",
        "endTs": "2018-02-11T00:00:00.090210Z",
        "frequency": "week",
        "weekdays": [
            "Monday",
            "Tuesday"
        ],
        "recurrence": 1,
        "nextCaptureTs": "2018-02-11T00:00:00.090210Z"
    },
    "warnings": [
        "This schedule conflicts with the schedule Test Schedule at the time 2025-01-28T18:25:06Z"
    ]
}

- New endpoint

Delete schedule from cloud

DELETE /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}