- Release Notes
- API Changelog
- Overview
- Generally Available
- v1.57.0
- v1.56.0
- v1.55.0
- v1.54.0
- v1.53.0
- v1.52.0
- v1.51.1
- v1.50.0
- v1.49.0
- v1.48.0
- v1.47.0
- v1.46.0
- v1.45.0
- v1.44.0
- v1.43.0
- v1.42.0
- v1.41.0
- v1.40.0
- v1.39.0
- v1.38.0
- v1.37.0
- v1.36.0
- v1.35.0
- v1.34.0
- v1.33.0
- v1.32.0
- v1.31.0
- v1.30.0
- v1.29.0
- v1.28.0
- v1.27.0
- v1.26.0
- v1.25.0
- v1.24.0
- v1.23.0
- v1.22.0
- v1.21.0
- v1.20.0
- v1.19.0
- v1.18.0
- v1.17.0
- v1.16.0
- v1.15.0
- v1.14.0
- v1.13.0
- v1.12.0
- v1.11.0
- v1.10.0
- v1.8.0
- v1.7.0
- v1.6.0
- v1.5.0
- v1.4.0
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.0
- v0.11.0
- v0.10.0
- v0.9.0
- v0.8.0
- v0.7.0
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- v0.2.0
- Beta
- What's Updated
- [ networks ]
- [ switch ]
- [ wireless ]
- [ organizations ]
- apiRequests
- brandingPolicies
- clients
- networks
- summary
- Return the top 10 appliances sorted by utilization 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 switches by energy usage over given time range
- What's New
Version 1.20.0 to 1.21.0
Summary of Changes
1 - New
18 - Updated
534 - Total operations
337 - Total Paths
What's Updated
[ networks ]
service
Return a network
GET /networks/{networkId}
- Response property
isBoundToConfigTemplate
value added
[ switch ]
accessPolicies
Create an access policy for a switch network
POST /networks/{networkId}/switch/accessPolicies
- Optional property
dot1x
Added
Update an access policy for a switch network
PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
- Optional property
dot1x
Added
[ wireless ]
ssids
List the VPN settings for the SSID.
GET /networks/{networkId}/wireless/ssids/{number}/vpn
- Response property
vlanId
value added
Update the VPN settings for the SSID
PUT /networks/{networkId}/wireless/ssids/{number}/vpn
- Optional property
vlanId
Added
[ organizations ]
apiRequests
List the API requests made by an organization
GET /organizations/{organizationId}/apiRequests
- Optional param
userAgent
added
- Response property
properties
value added
brandingPolicies
List the branding policies of an organization
GET /organizations/{organizationId}/brandingPolicies
- Response property
customLogo
value added
Return a branding policy
GET /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}
- Response property
customLogo
value added
Add a new branding policy to an organization
POST /organizations/{organizationId}/brandingPolicies
- Optional property
customLogo
Added
Update a branding policy
PUT /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}
- Optional property
customLogo
Added
clients
Return the client details in an organization
GET /organizations/{organizationId}/clients/search
- Response property
isBoundToConfigTemplate
value added
networks
List the networks that the user has privileges on in an organization
GET /organizations/{organizationId}/networks
- Optional param
isBoundToConfigTemplate
added
- Response property
isBoundToConfigTemplate
value added
summary
Return the top 10 appliances sorted by utilization over given time range.
GET /organizations/{organizationId}/summary/top/appliances/byUtilization
- Response property
properties
value 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
- Response property
properties
value added
Return metrics for organization's top 10 devices sorted by data usage over given time range
GET /organizations/{organizationId}/summary/top/devices/byUsage
- Response property
properties
value added
Return metrics for organization's top 10 switches by energy usage over given time range
GET /organizations/{organizationId}/summary/top/switches/byEnergyUsage
- Response property
properties
value added
What's New
[ switch ]
ports
PATH /organizations/{organizationId}/switch/ports/bySwitch
- Path added
- New operation
List the switchports in an organization by switch
GET
/organizations/{organizationId}/switch/ports/bySwitch
Code SnippetCopy{ "name": "My switch", "serial": "Q234-ABCD-5678", "mac": "00:11:22:33:44:55", "network": { "name": "Main Office", "id": "N_24329156" }, "model": "MS", "ports": [ { "portId": "1", "name": "My switch port", "tags": [ "tag1", "tag2" ], "enabled": true, "poeEnabled": true, "type": "access", "vlan": 10, "voiceVlan": 20, "rstpEnabled": true, "stpGuard": "disabled", "linkNegotiation": "Auto negotiate", "accessPolicyType": "Sticky MAC allow list", "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", "34:56:fe:ce:8e:b1" ], "stickyMacAllowListLimit": 5 } ] }