- 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
- What's New
- [ organizations ]
- inventory
- Claim a list of devices, licenses, and/or orders into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory. Use /organizations/{organizationId}/inventory/release to release devices from an organization.
- Release a list of claimed devices from an organization.
- inventory
- [ sensor ]
- [ organizations ]
- What's Changed
Version 1.18.0 to 1.19.0
Summary of Changes
4 - New
28 - Updated
526 - Total operations
332 - Total Paths
What's Updated
[ switch ]
ports
List the switch ports for a switch
GET /devices/{serial}/switch/ports
- Response property
adaptivePolicyGroupId
value added
- Response property
peerSgtCapable
value added
Return a switch port
GET /devices/{serial}/switch/ports/{portId}
- Response property
adaptivePolicyGroupId
value added
- Response property
peerSgtCapable
value added
Update a switch port
PUT /devices/{serial}/switch/ports/{portId}
- Optional property
adaptivePolicyGroupId
Added
- Optional property
peerSgtCapable
Added
configTemplates
Return all the ports of a switch profile
GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports
- Response property
adaptivePolicyGroupId
value added
- Response property
peerSgtCapable
value added
Return a switch profile port
GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
- Response property
adaptivePolicyGroupId
value added
- Response property
peerSgtCapable
value added
[ camera ]
qualityRetentionProfiles
Update an existing quality retention profile for this network.
PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
- Optional property
MV52
Added
Creates new quality retention profile for this network.
POST /networks/{networkId}/camera/qualityRetentionProfiles
- Optional property
MV52
Added
[ networks ]
settings
Return the settings for a network
GET /networks/{networkId}/settings
- Response property
localStatusPage
value added
[ wireless ]
rfProfiles
Updates specified RF profile for this network
PUT /networks/{networkId}/wireless/rfProfiles/{rfProfileId}
- Optional property
perSsidSettings
Added
Creates new RF profile for this network
POST /networks/{networkId}/wireless/rfProfiles
- Optional property
perSsidSettings
Added
ssids
Update the attributes of an MR SSID
PUT /networks/{networkId}/wireless/ssids/{number}
- Optional property
secondaryConcentratorNetworkId
Added
- Optional property
disassociateClientsOnVpnFailover
Added
- Optional property
speedBurst
Added
[ organizations ]
adaptivePolicy
List adaptive policy groups in a organization
GET /organizations/{organizationId}/adaptivePolicy/groups
- Response property
isDefaultGroup
value added
- Response property
requiredIpMappings
value added
Returns an adaptive policy group
GET /organizations/{organizationId}/adaptivePolicy/groups/{groupId}
- Response property
isDefaultGroup
value added
- Response property
requiredIpMappings
value added
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
- Response property
properties
value added
loginSecurity
Returns the login security settings for an organization.
GET /organizations/{organizationId}/loginSecurity
- Response property
properties
value added
- Response property
apiAuthentication
value added
Update the login security settings for an organization
PUT /organizations/{organizationId}/loginSecurity
- Optional property
apiAuthentication
Added
service
List the organizations that the user has privileges on
GET /organizations
- Optional property
cloud
Added
Return an organization
GET /organizations/{organizationId}
- Optional property
cloud
Added
What's New
[ organizations ]
inventory
PATH /organizations/{organizationId}/inventory/claim
- Path added
- New operation
Claim a list of devices, licenses, and/or orders into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory. Use /organizations/{organizationId}/inventory/release to release devices from an organization.
POST
/organizations/{organizationId}/inventory/claim
Code SnippetCopy{ "orders": [ "4CXXXXXXX" ], "serials": [ "Q234-ABCD-5678" ], "licenses": [ { "key": "Z2XXXXXXXXXX", "mode": "addDevices" } ] }
PATH /organizations/{organizationId}/inventory/release
- Path added
- New operation
Release a list of claimed devices from an organization.
POST
/organizations/{organizationId}/inventory/release
Code SnippetCopy{ "serials": [ "Q234-ABCD-5678" ] }
[ sensor ]
readings
PATH /organizations/{organizationId}/sensor/readings/history
- Path added
- New operation
Return all reported readings from sensors in a given timespan, sorted by timestamp
GET
/organizations/{organizationId}/sensor/readings/history
Code SnippetCopy[ { "ts": "2021-10-18T23:54:48Z", "serial": "Q234-ABCD-5678", "network": { "id": "N_24329156", "name": "Main Office" }, "metric": "temperature", "temperature": { "fahrenheit": 77.81, "celsius": 25.45 } } ]
PATH /organizations/{organizationId}/sensor/readings/latest
- Path added
- New operation
Return the latest available reading for each metric from each sensor, sorted by sensor serial
GET
/organizations/{organizationId}/sensor/readings/latest
Code SnippetCopy[ { "serial": "Q234-ABCD-5678", "network": { "id": "N_24329156", "name": "Main Office" }, "readings": [ { "ts": "2021-10-18T23:54:48Z", "metric": "temperature", "temperature": { "fahrenheit": 77.81, "celsius": 25.45 } } ] } ]