What's Updated
What's New
- [ appliance ]
  - rfProfiles
  - radio
    - Return the radio settings of an appliance
    - Update the radio settings of an appliance
- [ wireless ]
  - devices

Version 1.33.0 to 1.34.0

Summary of Changes

7 - New

98 - Updated

631 - Total operations

398 - Total Paths

What's Updated

[ appliance ]

firewall

Return the L7 firewall application categories and their associated applications for an MX network

GET /networks/{networkId}/appliance/firewall/l7FirewallRules/applicationCategories

- Response property properties value added

ssids

Update the attributes of an MX SSID

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

- Optional property dot11w Added

[ networks ]

topology

List the LLDP and CDP information for all discovered devices and connections in a network.

GET /networks/{networkId}/topology/linkLayer

- Response property errors value added

firmwareUpgrades

Get firmware upgrade information for a network

GET /networks/{networkId}/firmwareUpgrades

- Optional property cloudGateway Added

- Response property cloudGateway value added

Update firmware upgrade information for a network

PUT /networks/{networkId}/firmwareUpgrades

- Optional property cloudGateway Added

- Optional property switchCatalyst Added

- Optional property cloudGateway Added

Create a Staged Upgrade Event for a network

POST /networks/{networkId}/firmwareUpgrades/staged/events

- Optional property switchCatalyst Added

clients

List the clients that have used this network in the timespan

GET /networks/{networkId}/clients

- Optional param pskGroup added

- Optional property pskGroup Added

- Response property pskGroup value added

[ sm ]

trustedAccessConfigs

List Trusted Access Configs

GET /networks/{networkId}/sm/trustedAccessConfigs

- Optional property sendExpirationEmails Added

- Optional property notifyTimeBeforeAccessEnds Added

- Optional property additionalEmailText Added

- Response property sendExpirationEmails value added

- Response property notifyTimeBeforeAccessEnds value added

- Response property additionalEmailText value added

[ switch ]

dscpToCosMappings

Return the DSCP to CoS mappings

GET /networks/{networkId}/switch/dscpToCosMappings

- Response property properties value added

qosRules

Return a quality of service rule

GET /networks/{networkId}/switch/qosRules/{qosRuleId}

- Response property properties value added

routing

Return multicast settings for a network

GET /networks/{networkId}/switch/routing/multicast

- Response property properties value added

- Response property stacks value added

- Response property switchProfiles value added

dhcpServerPolicy

Return the DHCP server settings

GET /networks/{networkId}/switch/dhcpServerPolicy

- Response property properties value added

stacks

Return a layer 3 interface DHCP configuration for a switch stack

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

- Response property properties value added

alternateManagementInterface

Return the switch alternate management interface for the network

GET /networks/{networkId}/switch/alternateManagementInterface

- Response property properties value added

configTemplates

List the switch profiles for your switch template configuration

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

- Response property items value added

settings

Returns the switch network settings

GET /networks/{networkId}/switch/settings

- Optional property uplinkClientSampling Added

- Response property uplinkClientSampling value added

Update switch network settings

PUT /networks/{networkId}/switch/settings

- Optional property uplinkClientSampling Added

[ wireless ]

rfProfiles

List RF profiles for this network

GET /networks/{networkId}/wireless/rfProfiles

- Response property properties value added

- Summary changed from List the non-basic RF profiles for this network to List RF profiles for this network

Return a RF profile

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

- Response property properties value added

- Response property sixGhzSettings value added

Updates specified RF profile for this network

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

- Optional property sixGhzSettings Added

Creates new RF profile for this network

POST /networks/{networkId}/wireless/rfProfiles

- Optional property sixGhzSettings Added

[ organizations ]

admins

List the dashboard administrators in this organization

GET /organizations/{organizationId}/admins

- Response property properties value added

apiRequests

Return an aggregated overview of API requests data

GET /organizations/{organizationId}/apiRequests/overview

- Response property properties value added

- Response property 202 value added

- Response property 203 value added

- Response property 205 value added

- Response property 206 value added

- Response property 207 value added

- Response property 208 value added

- Response property 226 value added

- Response property 300 value added

- Response property 301 value added

- Response property 302 value added

- Response property 303 value added

- Response property 304 value added

- Response property 305 value added

- Response property 306 value added

- Response property 307 value added

- Response property 308 value added

- Response property 401 value added

- Response property 402 value added

- Response property 403 value added

- Response property 405 value added

- Response property 406 value added

- Response property 407 value added

- Response property 408 value added

- Response property 409 value added

- Response property 410 value added

- Response property 411 value added

- Response property 412 value added

- Response property 413 value added

- Response property 414 value added

- Response property 415 value added

- Response property 416 value added

- Response property 417 value added

- Response property 421 value added

- Response property 422 value added

- Response property 423 value added

- Response property 424 value added

- Response property 425 value added

- Response property 426 value added

- Response property 428 value added

- Response property 431 value added

- Response property 451 value added

- Response property 500 value added

- Response property 501 value added

- Response property 502 value added

- Response property 503 value added

- Response property 504 value added

- Response property 505 value added

- Response property 506 value added

- Response property 507 value added

- Response property 508 value added

- Response property 509 value added

- Response property 510 value added

- Response property 511 value added

openapiSpec

Return the OpenAPI Specification of the organization's API documentation in JSON

GET /organizations/{organizationId}/openapiSpec

- Optional param version added

- Summary changed from Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON to Return the OpenAPI Specification of the organization's API documentation in JSON

samlRoles

List the SAML roles for this organization

GET /organizations/{organizationId}/samlRoles

- Response property properties value added

Return a SAML role

GET /organizations/{organizationId}/samlRoles/{samlRoleId}

- Response property properties value added

What's New

[ appliance ]

rfProfiles

PATH /networks/{networkId}/appliance/rfProfiles

- Path added

- New operation

List the RF profiles for this network

GET /networks/{networkId}/appliance/rfProfiles

Code Snippet

Copy{
    "assigned": [
        {
            "id": "1234",
            "networkId": "N_24329156",
            "name": "Some Custom RF Profile",
            "twoFourGhzSettings": {
                "minBitrate": 11,
                "axEnabled": true
            },
            "fiveGhzSettings": {
                "minBitrate": 12,
                "axEnabled": true
            },
            "perSsidSettings": {
                "1": {
                    "bandOperationMode": "dual",
                    "bandSteeringEnabled": true
                },
                "2": {
                    "bandOperationMode": "dual",
                    "bandSteeringEnabled": true
                },
                "3": {
                    "bandOperationMode": "dual",
                    "bandSteeringEnabled": true
                },
                "4": {
                    "bandOperationMode": "dual",
                    "bandSteeringEnabled": true
                }
            }
        }
    ]
}

- New operation

Creates new RF profile for this network

POST /networks/{networkId}/appliance/rfProfiles

Code Snippet

Copy{
    "id": "1234",
    "networkId": "N_24329156",
    "name": "Some Custom RF Profile",
    "twoFourGhzSettings": {
        "minBitrate": 11,
        "axEnabled": true
    },
    "fiveGhzSettings": {
        "minBitrate": 12,
        "axEnabled": true
    },
    "perSsidSettings": {
        "1": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "2": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "3": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "4": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        }
    }
}

PATH /networks/{networkId}/appliance/rfProfiles/{rfProfileId}

- Path added

- New operation

Return a RF profile

GET /networks/{networkId}/appliance/rfProfiles/{rfProfileId}

Code Snippet

Copy{
    "id": "1234",
    "networkId": "N_24329156",
    "name": "Some Custom RF Profile",
    "twoFourGhzSettings": {
        "minBitrate": 11,
        "axEnabled": true
    },
    "fiveGhzSettings": {
        "minBitrate": 12,
        "axEnabled": true
    },
    "perSsidSettings": {
        "1": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "2": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "3": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "4": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        }
    }
}

- New operation

Updates specified RF profile for this network

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

Code Snippet

Copy{
    "id": "1234",
    "networkId": "N_24329156",
    "name": "Some Custom RF Profile",
    "twoFourGhzSettings": {
        "minBitrate": 11,
        "axEnabled": true
    },
    "fiveGhzSettings": {
        "minBitrate": 12,
        "axEnabled": true
    },
    "perSsidSettings": {
        "1": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "2": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "3": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        },
        "4": {
            "bandOperationMode": "dual",
            "bandSteeringEnabled": true
        }
    }
}

- New operation

Delete a RF Profile

DELETE /networks/{networkId}/appliance/rfProfiles/{rfProfileId}

radio

PATH /devices/{serial}/appliance/radio/settings

- Path added

- New operation

Return the radio settings of an appliance

GET /devices/{serial}/appliance/radio/settings
Code Snippet
Copy{
    "serial": "Q234-ABCD-5678",
    "rfProfileId": "1234",
    "twoFourGhzSettings": {
        "channel": 11,
        "targetPower": 21
    },
    "fiveGhzSettings": {
        "channel": 149,
        "channelWidth": 20,
        "targetPower": 15
    }
}
- New operation

Update the radio settings of an appliance

PUT /devices/{serial}/appliance/radio/settings
Code Snippet
Copy{
    "serial": "Q234-ABCD-5678",
    "rfProfileId": "1234",
    "twoFourGhzSettings": {
        "channel": 11,
        "targetPower": 21
    },
    "fiveGhzSettings": {
        "channel": 149,
        "channelWidth": 20,
        "targetPower": 15
    }
}

[ wireless ]

devices

PATH /organizations/{organizationId}/wireless/devices/channelUtilization/byDevice

- Path added

- New operation

Get average channel utilization for all bands in a network, split by AP

GET /organizations/{organizationId}/wireless/devices/channelUtilization/byDevice

Code Snippet

Copy[
    {
        "serial": "Q234-ABCD-5678",
        "mac": "00:11:22:33:44:55",
        "network": {
            "id": "N_24329156"
        },
        "byBand": [
            {
                "band": "5",
                "wifi": {
                    "percentage": 33.84
                },
                "nonWifi": {
                    "percentage": 1.84
                },
                "total": {
                    "percentage": 32
                }
            }
        ]
    }
]

PATH /organizations/{organizationId}/wireless/devices/channelUtilization/byNetwork

- Path added

- New operation

Get average channel utilization across all bands for all networks in the organization

GET /organizations/{organizationId}/wireless/devices/channelUtilization/byNetwork
Code Snippet
Copy[
    {
        "network": {
            "id": "N_24329156"
        },
        "byBand": [
            {
                "band": "5",
                "wifi": {
                    "percentage": 33.84
                },
                "nonWifi": {
                    "percentage": 1.84
                },
                "total": {
                    "percentage": 32
                }
            }
        ]
    }
]

PATH /organizations/{organizationId}/wireless/devices/channelUtilization/history/byDevice/byInterval

- Path added

- New operation

Get a time-series of average channel utilization for all bands, segmented by device.

GET /organizations/{organizationId}/wireless/devices/channelUtilization/history/byDevice/byInterval

Code Snippet

Copy[
    {
        "startTs": "2018-02-11T00:00:00Z",
        "endTs": "2018-05-12T00:00:00Z",
        "serial": "Q234-ABCD-5678",
        "mac": "00:11:22:33:44:55",
        "network": {
            "id": "N_24329156"
        },
        "byBand": [
            {
                "band": "5",
                "wifi": {
                    "percentage": 33.84
                },
                "nonWifi": {
                    "percentage": 1.84
                },
                "total": {
                    "percentage": 32
                }
            }
        ]
    }
]

PATH /organizations/{organizationId}/wireless/devices/channelUtilization/history/byNetwork/byInterval

- Path added

- New operation

Get a time-series of average channel utilization for all bands

GET /organizations/{organizationId}/wireless/devices/channelUtilization/history/byNetwork/byInterval

Code Snippet

Copy[
    {
        "startTs": "2018-02-11T00:00:00Z",
        "endTs": "2018-05-12T00:00:00Z",
        "network": {
            "id": "N_24329156"
        },
        "byBand": [
            {
                "band": "5",
                "wifi": {
                    "percentage": 33.84
                },
                "nonWifi": {
                    "percentage": 1.84
                },
                "total": {
                    "percentage": 32
                }
            }
        ]
    }
]