What's Updated
What's New

Version 1.43.0 to 1.44.0

Summary of Changes

7 - New

41 - Updated

694 - Total Endpoints

449 - Total Paths

What's Updated

[ devices ]

clients

List the clients of a device, up to a maximum of a month ago

GET /devices/{serial}/clients

- Response property properties value added

[ switch ]

ports

List the switch ports for a switch

GET /devices/{serial}/switch/ports

- Optional property module Added

- Optional property mirror Added

- Response property module value added

- Response property mirror value added

Return a switch port

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

- Optional property module Added

- Optional property mirror Added

- Response property module value added

- Response property mirror value added

Update a switch port

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

- Optional property module Added

- Optional property mirror Added

configTemplates

Return all the ports of a switch template

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

- Optional property module Added

- Optional property mirror Added

- Response property module value added

- Response property mirror value added

Return a switch template port

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

- Optional property module Added

- Optional property mirror Added

- Response property module value added

- Response property mirror value added

Update a switch template port

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

- Optional property module Added

- Optional property mirror Added

[ networks ]

clients

Returns a timeseries of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second.

GET /networks/{networkId}/clients/bandwidthUsageHistory

- Response property properties value added

- Response property upstream value added

- Response property downstream value added

Return overview statistics for network clients

GET /networks/{networkId}/clients/overview

- Response property properties value added

Return the policy assigned to a client on the network

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

- Response property properties value added

Return the client's network traffic data over time

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

- Response property properties value added

Return the client's daily usage history

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

- Response property properties value added

[ sm ]

profiles

List all profiles in a network

GET /networks/{networkId}/sm/profiles

- Optional param payloadTypes added

- Optional property payloadTypes Added

- Response property payloadTypes value added

[ wireless ]

ssids

Display the splash page settings for the given SSID

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

- Optional property themeId Added

- Response property themeId value added

Modify the splash page settings for the given SSID

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

- Optional property themeId Added

[ organizations ]

service

List the organizations that the user has privileges on

GET /organizations

- Response property headers value added

- Optional param perPage added

- Optional param startingAfter added

- Optional param endingBefore added

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

POST /organizations/{organizationId}/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

[ appliance ]

trafficShaping

Display VPN exclusion rules for MX networks.

GET /organizations/{organizationId}/appliance/trafficShaping/vpnExclusions/byNetwork

- Response property properties value added

What's New

[ devices ]

throughputTest

PATH /devices/{serial}/liveTools/throughputTest

- Path added

- New endpoint

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

POST /devices/{serial}/liveTools/throughputTest

{
    "throughputTestId": "123",
    "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/throughputTest/123",
    "status": "complete",
    "result": {
        "speeds": {
            "downstream": 1337
        }
    },
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "error": "error description",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

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

- Path added

- New endpoint

Return a throughput test job

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

{
    "throughputTestId": "123",
    "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/throughputTest/123",
    "status": "complete",
    "result": {
        "speeds": {
            "downstream": 1337
        }
    },
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "error": "error description"
}

[ networks ]

vlansEnabledState

PATH /networks/{networkId}/vlansEnabledState

- Path added

- New endpoint

Returns the enabled status of VLANs for the network

GET /networks/{networkId}/vlansEnabledState
{
    "enabled": true,
    "networkId": "N_24329156"
}

[ organizations ]

inventory

PATH /organizations/{organizationId}/inventory/devices/swaps/bulk

- Path added

- New endpoint

Swap the devices identified by devices.old with a devices.new, then perform the :afterAction on the devices.old.

POST /organizations/{organizationId}/inventory/devices/swaps/bulk

{
    "jobId": "1284392014819",
    "swaps": [
        {
            "id": "1284392014819",
            "devices": {
                "old": {
                    "mac": "00:11:22:33:44:55",
                    "serial": "Q234-ABCD-5678",
                    "model": "MR34",
                    "name": "My AP"
                },
                "new": {
                    "mac": "00:11:22:33:44:55",
                    "serial": "Q234-ABCD-5678",
                    "model": "MR34",
                    "name": "My AP"
                }
            },
            "status": "complete",
            "afterAction": "remove from network",
            "createdAt": "2023-04-24T12:40:11Z",
            "completedAt": "2023-04-24T12:40:12Z",
            "errors": []
        }
    ]
}

PATH /organizations/{organizationId}/inventory/devices/swaps/bulk/{id}

- Path added

- New endpoint

List of device swaps for a given request ID ({id}).

GET /organizations/{organizationId}/inventory/devices/swaps/bulk/{id}

{
    "jobId": "1284392014819",
    "swaps": [
        {
            "id": "1284392014819",
            "devices": {
                "old": {
                    "mac": "00:11:22:33:44:55",
                    "serial": "Q234-ABCD-5678",
                    "model": "MR34",
                    "name": "My AP"
                },
                "new": {
                    "mac": "00:11:22:33:44:55",
                    "serial": "Q234-ABCD-5678",
                    "model": "MR34",
                    "name": "My AP"
                }
            },
            "status": "complete",
            "afterAction": "remove from network",
            "createdAt": "2023-04-24T12:40:11Z",
            "completedAt": "2023-04-24T12:40:12Z",
            "errors": []
        }
    ]
}

[ licensing ]

subscription

PATH /administered/licensing/subscription/entitlements

- Path added

- New endpoint

Retrieve the list of purchasable entitlements

GET /administered/licensing/subscription/entitlements
{
    "sku": "LIC-MR-A",
    "name": "MR",
    "productType": "wireless",
    "productClass": "MR",
    "featureTier": "advantage",
    "isAddOn": false
}

PATH /administered/licensing/subscription/subscriptions/compliance/statuses

- Path added

- New endpoint

Get compliance status for requested subscriptions

GET /administered/licensing/subscription/subscriptions/compliance/statuses

[
    {
        "subscription": {
            "id": "12345",
            "name": "Corporate Subscription",
            "status": "active"
        },
        "violations": {
            "byProductClass": [
                {
                    "productClass": "MS 100 Small",
                    "gracePeriodEndsAt": "2023-12-07T00:00:00Z",
                    "missing": {
                        "entitlements": [
                            {
                                "sku": "LIC-MS-100-S-E",
                                "quantity": 11
                            }
                        ]
                    }
                }
            ]
        }
    }
]