• What's Updated
  • [ organizations ]
    • clients
      • Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.
    • devices
      • List the current uplink addresses for devices in an organization.
    • networks
      • List the networks that the user has privileges on in an organization
    • summary
      • Return the top 10 appliances sorted by utilization over given time range.
      • Return metrics for organization's top 10 clients by data usage (in mb) over given time range.
      • Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.
      • Return metrics for organization's top 10 devices sorted by data usage over given time range
      • Return metrics for organization's top 10 device models sorted by data usage over given time range
      • List the client and status overview information for the networks in an organization
      • Return metrics for organization's top 10 ssids by data usage over given time range
      • Return metrics for organization's top 10 switches by energy usage over given time range
  • [ camera ]
    • qualityRetentionProfiles
      • Creates new quality retention profile for this network.
      • Update an existing quality retention profile for this network.
  • [ networks ]
    • clients
      • Return the client associated with the given identifier
    • 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)
  • [ sensor ]
    • alerts
      • Creates a sensor alert profile for a network.
      • Updates a sensor alert profile for a network.
      • Lists all sensor alert profiles for a network.
      • Show details of a sensor alert profile for a network.
  • [ switch ]
    • accessPolicies
      • Create an access policy for a switch network
      • Update an access policy for a switch network
      • List the access policies for a switch network
      • Return a specific access policy for a switch network
  • [ wireless ]
    • ssids
      • Display the splash page settings for the given SSID
• What's New
  • [ organizations ]
    • summary
      • Return the top applications sorted by data usage over given time range. Default unit is megabytes.
      • Return the top application categories sorted by data usage over given time range. Default unit is megabytes.
  • [ wireless ]
    • electronicShelfLabel
      • Return the ESL settings of a device
      • Update the ESL settings of a device
      • Return the ESL settings of a wireless network
      • Update the ESL settings of a wireless network
      • Get a list of all ESL eligible devices of a network

Version 1.46.0 to 1.47.0

Summary of Changes

5 - New

87 - Updated

728 - Total Endpoints

477 - Total Paths

What's Updated

[ organizations ]

clients

Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.

GET /organizations/{organizationId}/clients/bandwidthUsageHistory

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param ssidName added

- Optional param usageUplink added

devices

List the current uplink addresses for devices in an organization.

GET /organizations/{organizationId}/devices/uplinks/addresses/byDevice

- Optional property vlan Added

- Response property vlan value added

networks

List the networks that the user has privileges on in an organization

GET /organizations/{organizationId}/networks

- Optional param productTypes added

summary

Return the top 10 appliances sorted by utilization over given time range.

GET /organizations/{organizationId}/summary/top/appliances/byUtilization

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param quantity added

- Optional param ssidName added

- Optional param usageUplink added

Return metrics for organization's top 10 clients by data usage (in mb) over given time range.

GET /organizations/{organizationId}/summary/top/clients/byUsage

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param quantity added

- Optional param ssidName added

- Optional param usageUplink added

Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.

GET /organizations/{organizationId}/summary/top/clients/manufacturers/byUsage

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param quantity added

- Optional param ssidName added

- Optional param usageUplink added

Return metrics for organization's top 10 devices sorted by data usage over given time range

GET /organizations/{organizationId}/summary/top/devices/byUsage

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param quantity added

- Optional param ssidName added

- Optional param usageUplink added

Return metrics for organization's top 10 device models sorted by data usage over given time range

GET /organizations/{organizationId}/summary/top/devices/models/byUsage

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param quantity added

- Optional param ssidName added

- Optional param usageUplink added

List the client and status overview information for the networks in an organization

GET /organizations/{organizationId}/summary/top/networks/byStatus

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param quantity added

- Optional param ssidName added

- Optional param usageUplink added

Return metrics for organization's top 10 ssids by data usage over given time range

GET /organizations/{organizationId}/summary/top/ssids/byUsage

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param quantity added

- Optional param ssidName added

- Optional param usageUplink added

Return metrics for organization's top 10 switches by energy usage over given time range

GET /organizations/{organizationId}/summary/top/switches/byEnergyUsage

- Optional param networkTag added

- Optional param deviceTag added

- Optional param networkId added

- Optional param quantity added

- Optional param ssidName added

- Optional param usageUplink added

[ camera ]

qualityRetentionProfiles

Creates new quality retention profile for this network.

POST /networks/{networkId}/camera/qualityRetentionProfiles

- Optional property MV33M Added

- Optional property MV13M Added

- Optional property MV63M Added

- Optional property MV93M Added

Update an existing quality retention profile for this network.

PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- Optional property MV33M Added

- Optional property MV13M Added

- Optional property MV63M Added

- Optional property MV93M Added

[ networks ]

clients

Return the client associated with the given identifier

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

- Optional property notes Added

- Response property notes 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 param addAtomically added

- Optional property errors Added

[ sensor ]

alerts

Creates a sensor alert profile for a network.

POST /networks/{networkId}/sensor/alerts/profiles

- Optional property co2 Added

- Optional property co2 Added

Updates a sensor alert profile for a network.

PUT /networks/{networkId}/sensor/alerts/profiles/{id}

- Optional property co2 Added

- Optional property co2 Added

Lists all sensor alert profiles for a network.

GET /networks/{networkId}/sensor/alerts/profiles

- Optional property co2 Added

- Response property co2 value added

Show details of a sensor alert profile for a network.

GET /networks/{networkId}/sensor/alerts/profiles/{id}

- Optional property co2 Added

- Response property co2 value added

[ switch ]

accessPolicies

Create an access policy for a switch network

POST /networks/{networkId}/switch/accessPolicies

- Property serverId Deleted

- Optional property cache Added

- Property serverId Deleted

- Optional property cache Added

Update an access policy for a switch network

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

- Optional property cache Added

- Optional property cache Added

List the access policies for a switch network

GET /networks/{networkId}/switch/accessPolicies

- Optional property cache Added

- Response property cache value added

Return a specific access policy for a switch network

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

- Optional property cache Added

- Response property cache value added

[ wireless ]

ssids

Display the splash page settings for the given SSID

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

- Response property enum value added

What's New

[ organizations ]

summary

PATH /organizations/{organizationId}/summary/top/applications/byUsage

- Path added

- New endpoint

Return the top applications sorted by data usage over given time range. Default unit is megabytes.

GET /organizations/{organizationId}/summary/top/applications/byUsage

[
    {
        "application": "sample name",
        "total": 18000,
        "downstream": 10000,
        "upstream": 8000,
        "percentage": 80.223456789
    }
]

---

PATH /organizations/{organizationId}/summary/top/applications/categories/byUsage

- Path added

- New endpoint

Return the top application categories sorted by data usage over given time range. Default unit is megabytes.

GET /organizations/{organizationId}/summary/top/applications/categories/byUsage

[
    {
        "category": "other",
        "total": 18000,
        "downstream": 10000,
        "upstream": 8000,
        "percentage": 80.223456789
    }
]

---

[ wireless ]

electronicShelfLabel

PATH /devices/{serial}/wireless/electronicShelfLabel

- Path added

- New endpoint

Return the ESL settings of a device

GET /devices/{serial}/wireless/electronicShelfLabel

{
    "apEslId": 16777216,
    "serial": "Q234-ABCD-5678",
    "channel": "1",
    "enabled": true,
    "networkId": "N_24329156",
    "hostname": "localhost:700",
    "provider": "imagotag"
}

---

- New endpoint

Update the ESL settings of a device

PUT /devices/{serial}/wireless/electronicShelfLabel

{
    "apEslId": 16777216,
    "serial": "Q234-ABCD-5678",
    "channel": "1",
    "enabled": true,
    "networkId": "N_24329156",
    "hostname": "localhost:700",
    "provider": "imagotag"
}

---

PATH /networks/{networkId}/wireless/electronicShelfLabel

- Path added

- New endpoint

Return the ESL settings of a wireless network

GET /networks/{networkId}/wireless/electronicShelfLabel

{
    "hostname": "N_24329156",
    "enabled": true
}

---

- New endpoint

Update the ESL settings of a wireless network

PUT /networks/{networkId}/wireless/electronicShelfLabel

{
    "hostname": "N_24329156",
    "enabled": true
}

---

PATH /networks/{networkId}/wireless/electronicShelfLabel/configuredDevices

- Path added

- New endpoint

Get a list of all ESL eligible devices of a network

GET /networks/{networkId}/wireless/electronicShelfLabel/configuredDevices

[
    {
        "hostname": "N_24329156",
        "enabled": true
    }
]

---