• What's Updated
  • [ devices ]
    • service
      • Return a single device
  • [ networks ]
    • clients
      • List the clients that have used this network in the timespan
    • devices
      • List the devices in a network
    • firmwareUpgrades
      • Get firmware upgrade information for a network
      • Update firmware upgrade information for a network
    • floorPlans
      • Destroy a floor plan
      • List the floor plans that belong to your network
      • Find a floor plan by ID
      • Update a floor plan's geolocation and other meta data
      • Upload a floor plan
    • settings
      • Update the settings for a network
    • trafficShaping
      • Returns the application categories for traffic shaping rules
  • [ wireless ]
    • settings
      • Update the wireless settings for a network
    • ssids
      • Display the traffic shaping settings for a SSID on an MR network
      • Update the attributes of an MR SSID
      • Update the traffic shaping rules for an SSID on an MR network.
  • [ organizations ]
    • devices
      • List the devices in an organization
    • firmware
      • Get firmware upgrade information for an organization
• What's New
  • [ sm ]
    • devices
      • Install applications on a device
      • Uninstall applications on a device
  • [ networks ]
    • vlanProfiles
      • List VLAN profiles for a network
      • Create a VLAN profile for a network
      • Get the assigned VLAN Profiles for devices in a network
      • Update the assigned VLAN Profile for devices in a network
      • Get an existing VLAN profile of a network
      • Update an existing VLAN profile of a network
      • Delete a VLAN profile of a network

Version 1.37.0 to 1.38.0

Summary of Changes

6 - New

29 - Updated

658 - Total operations

416 - Total Paths

What's Updated

[ devices ]

service

Return a single device

GET /devices/{serial}

- Response property details value added

[ networks ]

clients

List the clients that have used this network in the timespan

GET /networks/{networkId}/clients

- Optional param namedVlan added

devices

List the devices in a network

GET /networks/{networkId}/devices

- Response property details value added

firmwareUpgrades

Get firmware upgrade information for a network

GET /networks/{networkId}/firmwareUpgrades

- Property cloudGateway Deleted

Update firmware upgrade information for a network

PUT /networks/{networkId}/firmwareUpgrades

- Property cloudGateway Deleted

- Property cloudGateway Deleted

floorPlans

Destroy a floor plan

DELETE /networks/{networkId}/floorPlans/{floorPlanId}

- Optional property details Added

List the floor plans that belong to your network

GET /networks/{networkId}/floorPlans

- Optional property details Added

- Response property details value added

Find a floor plan by ID

GET /networks/{networkId}/floorPlans/{floorPlanId}

- Optional property details Added

- Response property details value added

Update a floor plan's geolocation and other meta data

PUT /networks/{networkId}/floorPlans/{floorPlanId}

- Optional property details Added

Upload a floor plan

POST /networks/{networkId}/floorPlans

- Optional property details Added

settings

Update the settings for a network

PUT /networks/{networkId}/settings

- Optional property namedVlans Added

trafficShaping

Returns the application categories for traffic shaping rules

GET /networks/{networkId}/trafficShaping/applicationCategories

- Summary changed from Returns the application categories for traffic shaping rules. to Returns the application categories for traffic shaping rules

[ wireless ]

settings

Update the wireless settings for a network

PUT /networks/{networkId}/wireless/settings

- Optional property namedVlans Added

ssids

Display the traffic shaping settings for a SSID on an MR network

GET /networks/{networkId}/wireless/ssids/{number}/trafficShaping/rules

- Response property properties value added

Update the attributes of an MR SSID

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

- Optional property namedVlans Added

Update the traffic shaping rules for an SSID on an MR network.

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

- Summary changed from Update the traffic shaping settings for an SSID on an MR network to Update the traffic shaping rules for an SSID on an MR network.

[ organizations ]

devices

List the devices in an organization

GET /organizations/{organizationId}/devices

- Optional property details Added

- Response property details value added

firmware

Get firmware upgrade information for an organization

GET /organizations/{organizationId}/firmware/upgrades

- Optional param perPage added

- Optional param startingAfter added

- Optional param endingBefore added

- Optional property firmware Added

- Optional property firmware Added

- Response property firmware value added

- Response property firmware value added

- Response property headers value added

What's New

[ sm ]

devices

PATH /networks/{networkId}/sm/devices/{deviceId}/installApps

- Path added

- New operation

Install applications on a device

POST /networks/{networkId}/sm/devices/{deviceId}/installApps

---

PATH /networks/{networkId}/sm/devices/{deviceId}/uninstallApps

- Path added

- New operation

Uninstall applications on a device

POST /networks/{networkId}/sm/devices/{deviceId}/uninstallApps

---

[ networks ]

vlanProfiles

PATH /networks/{networkId}/vlanProfiles

- Path added

- New operation

List VLAN profiles for a network

GET /networks/{networkId}/vlanProfiles

[
    {
        "iname": "Profile1",
        "name": "My VLAN profile name",
        "isDefault": false,
        "vlanNames": [
            {
                "name": "named-1",
                "vlanId": "1"
            }
        ],
        "vlanGroups": [
            {
                "name": "named-group-1",
                "vlanIds": "2,5-7"
            }
        ]
    }
]

---

- New operation

Create a VLAN profile for a network

POST /networks/{networkId}/vlanProfiles

{
    "iname": "Profile1",
    "name": "My VLAN profile name",
    "isDefault": false,
    "vlanNames": [
        {
            "name": "named-1",
            "vlanId": "1"
        }
    ],
    "vlanGroups": [
        {
            "name": "named-group-1",
            "vlanIds": "2,5-7"
        }
    ]
}

---

PATH /networks/{networkId}/vlanProfiles/assignments/byDevice

- Path added

- New operation

Get the assigned VLAN Profiles for devices in a network

GET /networks/{networkId}/vlanProfiles/assignments/byDevice

[
    {
        "name": "My switch",
        "serial": "Q234-ABCD-5678",
        "mac": "00:11:22:33:44:55",
        "productType": "switch",
        "vlanProfile": {
            "iname": "Profile1",
            "name": "My VLAN Profile",
            "isDefault": true
        },
        "stack": {
            "id": "1234"
        }
    }
]

---

PATH /networks/{networkId}/vlanProfiles/assignments/reassign

- Path added

- New operation

Update the assigned VLAN Profile for devices in a network

POST /networks/{networkId}/vlanProfiles/assignments/reassign

{
    "vlanProfile": {
        "iname": "Profile1",
        "name": "My VLAN Profile"
    },
    "serials": [
        "Q234-ABCD-5678"
    ],
    "stackIds": [
        "1234"
    ]
}

---

PATH /networks/{networkId}/vlanProfiles/{iname}

- Path added

- New operation

Get an existing VLAN profile of a network

GET /networks/{networkId}/vlanProfiles/{iname}

{
    "iname": "Profile1",
    "name": "My VLAN profile name",
    "isDefault": false,
    "vlanNames": [
        {
            "name": "named-1",
            "vlanId": "1"
        }
    ],
    "vlanGroups": [
        {
            "name": "named-group-1",
            "vlanIds": "2,5-7"
        }
    ]
}

---

- New operation

Update an existing VLAN profile of a network

PUT /networks/{networkId}/vlanProfiles/{iname}

{
    "iname": "Profile1",
    "name": "My VLAN profile name",
    "isDefault": false,
    "vlanNames": [
        {
            "name": "named-1",
            "vlanId": "1"
        }
    ],
    "vlanGroups": [
        {
            "name": "named-group-1",
            "vlanIds": "2,5-7"
        }
    ]
}

---

- New operation

Delete a VLAN profile of a network

DELETE /networks/{networkId}/vlanProfiles/{iname}

---