Version 1.45.0 to 1.46.0

Summary of Changes

18 - New

66 - Updated

721 - Total operations

472 - Total Paths

What's Changed

[ devices ]

throughputTest

Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput

POST /devices/{serial}/liveTools/throughputTest

- Property downstream type turn from integer to number

Return a throughput test job

GET /devices/{serial}/liveTools/throughputTest/{throughputTestId}

- Property downstream type turn from integer to number

What's Updated

[ devices ]

throughputTest

Return a throughput test job

GET /devices/{serial}/liveTools/throughputTest/{throughputTestId}

- Response property format value added

cableTest

Enqueue a job to perform a cable test for the device on the specified ports

POST /devices/{serial}/liveTools/cableTest

- Summary changed from Enqueue a job to perform a cable test for the device on the specified ports. to Enqueue a job to perform a cable test for the device on the specified ports

service

Return a single device

GET /devices/{serial}

- Property imei Deleted

- Property productType Deleted

Update the attributes of a device

PUT /devices/{serial}

- Property imei Deleted

- Property productType Deleted

[ switch ]

routing

Create a layer 3 interface for a switch

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

- Property ospfV3 Deleted

Update a layer 3 interface for a switch

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

- Property ospfV3 Deleted

accessPolicies

Create an access policy for a switch network

POST /networks/{networkId}/switch/accessPolicies

- Optional property serverId Added

- Optional property serverId Added

- Optional property serverId Added

- Optional property serverId Added

List the access policies for a switch network

GET /networks/{networkId}/switch/accessPolicies

- Optional property serverId Added

- Optional property serverId Added

- Response property serverId value added

- Response property serverId value added

Return a specific access policy for a switch network

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

- Optional property serverId Added

- Optional property serverId Added

- Response property serverId value added

- Response property serverId value added

Update an access policy for a switch network

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

- Optional property serverId Added

- Optional property serverId Added

- Optional property serverId Added

- Optional property serverId Added

[ networks ]

alerts

Return the alert configuration for this network

GET /networks/{networkId}/alerts/settings

- Optional property smsNumbers Added

- Response property smsNumbers value added

Update the alert configuration for this network

PUT /networks/{networkId}/alerts/settings

- Optional property smsNumbers Added

- Optional property smsNumbers Added

bluetoothClients

List the Bluetooth clients seen by APs in this network

GET /networks/{networkId}/bluetoothClients

- Response property properties value added

Return a Bluetooth client

GET /networks/{networkId}/bluetoothClients/{bluetoothClientId}

- Response property properties value added

devices

List the devices in a network

GET /networks/{networkId}/devices

- Property imei Deleted

- Property productType Deleted

firmwareUpgrades

Get firmware upgrade information for a network

GET /networks/{networkId}/firmwareUpgrades

- Optional property secureConnect Added

- Response property secureConnect value added

Update firmware upgrade information for a network

PUT /networks/{networkId}/firmwareUpgrades

- Optional property secureConnect Added

- Optional property secureConnect Added

clients

Return the client associated with the given identifier

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

- Optional property recentDeviceConnection Added

- Response property recentDeviceConnection value added

[ appliance ]

vlans

Add a VLAN

POST /networks/{networkId}/appliance/vlans

- Optional property dhcpHandling Added

- Optional property dhcpLeaseTime Added

- Optional property dhcpBootOptionsEnabled Added

- Optional property dhcpOptions Added

[ organizations ]

apiRequests

Return an aggregated overview of API requests data

GET /organizations/{organizationId}/apiRequests/overview

- Property 501 Deleted

- Property 502 Deleted

- Property 503 Deleted

- Property 504 Deleted

- Property 505 Deleted

- Property 506 Deleted

- Property 507 Deleted

- Property 508 Deleted

- Property 509 Deleted

- Property 510 Deleted

- Property 511 Deleted

earlyAccess

Create a new early access feature opt-in for an organization

POST /organizations/{organizationId}/earlyAccess/features/optIns

- Optional property optOutEligibility Added

List the early access feature opt-ins for an organization

GET /organizations/{organizationId}/earlyAccess/features/optIns

- Optional property optOutEligibility Added

- Response property optOutEligibility value added

Show an early access feature opt-in for an organization

GET /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}

- Optional property optOutEligibility Added

- Response property optOutEligibility value added

Update an early access feature opt-in for an organization

PUT /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}

- Optional property optOutEligibility Added

service

Create a new organization

POST /organizations

- Optional property host Added

Create a new organization by cloning the addressed organization

POST /organizations/{organizationId}/clone

- Optional property host Added

List the organizations that the user has privileges on

GET /organizations

- Optional property host Added

- Response property host value added

Return an organization

GET /organizations/{organizationId}

- Optional property host Added

- Response property host value added

Update an organization

PUT /organizations/{organizationId}

- Optional property host Added

What's New

[ organizations ]

alerts

PATH /organizations/{organizationId}/assurance/alerts

- Path added

- New operation

Return all health alerts for an organization

GET /organizations/{organizationId}/assurance/alerts 

[
    {
        "id": "1234",
        "categoryType": "connectivity",
        "network": {
            "name": "Network 2",
            "id": "L_1020981"
        },
        "startedAt": "2022-04-01T15:48:57Z",
        "resolvedAt": "2022-04-02T15:48:57Z",
        "dismissedAt": "2022-04-02T15:48:57Z",
        "deviceType": "MS",
        "type": "crc_errors_error",
        "title": "CRC errors detected",
        "description": "Very high proportion of CRC errors on port id",
        "severity": "warning",
        "scope": {
            "devices": [
                {
                    "url": "https://n237.meraki.com/MS-PM-First-Floo/n/_5kUKaTd/manage/nodes/new_list/7911238",
                    "name": "Device 1",
                    "order": 0,
                    "productType": "switch",
                    "serial": "Q2QP-5VYM-YM8H",
                    "mac": "aa:bb:cd:dd",
                    "imei": "353593090031649",
                    "lldp": {
                        "port": "33"
                    }
                }
            ]
        }
    }
]

PATH /organizations/{organizationId}/assurance/alerts/dismiss

- Path added

- New operation

Dismiss health alerts

POST /organizations/{organizationId}/assurance/alerts/dismiss

PATH /organizations/{organizationId}/assurance/alerts/overview

- Path added

- New operation

Return overview of active health alerts for an organization

GET /organizations/{organizationId}/assurance/alerts/overview 

{
    "counts": {
        "total": 14,
        "bySeverity": [
            {
                "type": "critical",
                "count": 1
            }
        ]
    }
}

PATH /organizations/{organizationId}/assurance/alerts/overview/byNetwork

- Path added

- New operation

Return a Summary of Alerts grouped by network and severity

GET /organizations/{organizationId}/assurance/alerts/overview/byNetwork 

{
    "items": [
        {
            "networkId": "L_30618",
            "networkName": "s01797.us",
            "alertCount": 3,
            "severityCounts": [
                {
                    "type": "warning",
                    "count": 3
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": 2
        }
    }
}

PATH /organizations/{organizationId}/assurance/alerts/overview/byType

- Path added

- New operation

Return a Summary of Alerts grouped by type and severity

GET /organizations/{organizationId}/assurance/alerts/overview/byType 

{
    "items": [
        {
            "type": "vlan_mismatch",
            "count": 3
        }
    ],
    "meta": {
        "counts": {
            "items": 4
        }
    }
}

PATH /organizations/{organizationId}/assurance/alerts/overview/historical

- Path added

- New operation

Returns historical health alert overviews

GET /organizations/{organizationId}/assurance/alerts/overview/historical 

{
    "items": [
        {
            "segmentStart": "2018-02-11T00:00:00Z",
            "totals": {
                "informational": 1,
                "warning": 1,
                "critical": 1
            },
            "byAlertType": [
                {
                    "type": "vlan_mismatch",
                    "informational": 1,
                    "warning": 1,
                    "critical": 1
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": 4
        }
    }
}

PATH /organizations/{organizationId}/assurance/alerts/restore

- Path added

- New operation

Restore health alerts from dismissed

POST /organizations/{organizationId}/assurance/alerts/restore

PATH /organizations/{organizationId}/assurance/alerts/{id}

- Path added

- New operation

Return a singular Health Alert by its id

GET /organizations/{organizationId}/assurance/alerts/{id} 

{
    "id": "1234",
    "categoryType": "connectivity",
    "network": {
        "name": "Network 2",
        "id": "L_1020981"
    },
    "startedAt": "2022-04-01T15:48:57Z",
    "resolvedAt": "2022-04-02T15:48:57Z",
    "dismissedAt": "2022-04-02T15:48:57Z",
    "deviceType": "MS",
    "type": "crc_errors_error",
    "title": "CRC errors detected",
    "description": "Very high proportion of CRC errors on port id",
    "severity": "warning",
    "scope": {
        "devices": [
            {
                "url": "https://n237.meraki.com/MS-PM-First-Floo/n/_5kUKaTd/manage/nodes/new_list/7911238",
                "name": "Device 1",
                "order": 0,
                "productType": "switch",
                "serial": "Q2QP-5VYM-YM8H",
                "mac": "aa:bb:cd:dd",
                "imei": "353593090031649",
                "lldp": {
                    "port": "33"
                }
            }
        ]
    }
}

devices

PATH /organizations/{organizationId}/devices/overview/byModel

- Path added

- New operation

Lists the count for each device model

GET /organizations/{organizationId}/devices/overview/byModel 

{
    "counts": [
        {
            "model": "MR34",
            "total": 1
        }
    ]
}

splash

PATH /organizations/{organizationId}/splash/assets/{id}

- Path added

- New operation

Get a Splash Theme Asset

GET /organizations/{organizationId}/splash/assets/{id} 

{
    "id": "1284392014819",
    "name": "continue.html",
    "fileData": "PGh0bWw+PC9odG1sPg==\n"
}

- New operation

Delete a Splash Theme Asset

DELETE /organizations/{organizationId}/splash/assets/{id}

PATH /organizations/{organizationId}/splash/themes

- Path added

- New operation

List Splash Themes

GET /organizations/{organizationId}/splash/themes 

[
    {
        "id": "482367494044dbbb1d2cc8579d967cef5b4ce59f",
        "name": "My Custom Splash Theme",
        "themeAssets": [
            {
                "id": "1284392014819",
                "name": "continue.html"
            }
        ]
    }
]

- New operation

Create a Splash Theme

POST /organizations/{organizationId}/splash/themes 

{
    "id": "482367494044dbbb1d2cc8579d967cef5b4ce59f",
    "name": "My Custom Splash Theme",
    "themeAssets": [
        {
            "id": "1284392014819",
            "name": "continue.html"
        }
    ]
}

PATH /organizations/{organizationId}/splash/themes/{id}

- Path added

- New operation

Delete a Splash Theme

DELETE /organizations/{organizationId}/splash/themes/{id}

PATH /organizations/{organizationId}/splash/themes/{themeIdentifier}/assets

- Path added

- New operation

Create a Splash Theme Asset

POST /organizations/{organizationId}/splash/themes/{themeIdentifier}/assets 

{
    "id": "1284392014819",
    "name": "continue.html",
    "fileData": "PGh0bWw+PC9odG1sPg==\n"
}

[ wireless ]

airMarshal

PATH /networks/{networkId}/wireless/airMarshal/rules

- Path added

- New operation

Creates a new rule

POST /networks/{networkId}/wireless/airMarshal/rules 

{
    "network": {
        "id": "N_12345",
        "name": "Network 1"
    },
    "ruleId": "5239",
    "type": "allow",
    "updatedAt": "2023-05-23 12:02:46.298",
    "createdAt": "2023-05-23 12:02:46.298",
    "match": {
        "string": "ipsum",
        "type": "contains"
    }
}

PATH /networks/{networkId}/wireless/airMarshal/rules/{ruleId}

- Path added

- New operation

Update a rule

PUT /networks/{networkId}/wireless/airMarshal/rules/{ruleId} 

{
    "network": {
        "id": "N_12345",
        "name": "Network 1"
    },
    "ruleId": "5239",
    "type": "allow",
    "updatedAt": "2023-05-23 12:02:46.298",
    "createdAt": "2023-05-23 12:02:46.298",
    "match": {
        "string": "ipsum",
        "type": "contains"
    }
}

- New operation

Delete an Air Marshal rule.

DELETE /networks/{networkId}/wireless/airMarshal/rules/{ruleId}

PATH /networks/{networkId}/wireless/airMarshal/settings

- Path added

- New operation

Updates Air Marshal settings.

PUT /networks/{networkId}/wireless/airMarshal/settings 

{
    "networkId": "N_12345",
    "defaultPolicy": "allow"
}

PATH /organizations/{organizationId}/wireless/airMarshal/rules

- Path added

- New operation

Returns the current Air Marshal rules for this organization

GET /organizations/{organizationId}/wireless/airMarshal/rules 

{
    "items": [
        {
            "network": {
                "id": "N_12345",
                "name": "Network 1"
            },
            "ruleId": "5239",
            "type": "allow",
            "updatedAt": "2023-05-23 12:02:46.298",
            "createdAt": "2023-05-23 12:02:46.298",
            "match": {
                "string": "ipsum",
                "type": "contains"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1
            }
        }
    }
}

PATH /organizations/{organizationId}/wireless/airMarshal/settings/byNetwork

- Path added

- New operation

Returns the current Air Marshal settings for this network

GET /organizations/{organizationId}/wireless/airMarshal/settings/byNetwork 

{
    "items": [
        {
            "networkId": "N_12345",
            "defaultPolicy": "allow"
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1,
                "remaining": 0
            }
        }
    }
}