- 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
Version 1.39.0 to 1.40.0
Summary of Changes
2 - New
30 - Updated
663 - Total operations
421 - Total Paths
What's Updated
[ devices ]
ping
Enqueue a job to ping a target host from the device
POST /devices/{serial}/liveTools/ping
- Optional property
callback
Added
- Optional property
callback
Added
pingDevice
Return a ping device job
GET /devices/{serial}/liveTools/pingDevice/{id}
- Optional property
callback
Added
- Response property
callback
value added
Enqueue a job to check connectivity status to the device
POST /devices/{serial}/liveTools/pingDevice
- Optional property
callback
Added
- Optional property
callback
Added
service
Return a single device
GET /devices/{serial}
- Response property
imei
value added
[ networks ]
devices
List the devices in a network
GET /networks/{networkId}/devices
- Response property
imei
value added
floorPlans
List the floor plans that belong to your network
GET /networks/{networkId}/floorPlans
- Optional property
imei
Added
- Response property
imei
value added
Find a floor plan by ID
GET /networks/{networkId}/floorPlans/{floorPlanId}
- Optional property
imei
Added
- Response property
imei
value added
Upload a floor plan
POST /networks/{networkId}/floorPlans
- Optional property
imei
Added
Update a floor plan's geolocation and other meta data
PUT /networks/{networkId}/floorPlans/{floorPlanId}
- Optional property
imei
Added
Destroy a floor plan
DELETE /networks/{networkId}/floorPlans/{floorPlanId}
- Optional property
imei
Added
vlanProfiles
List VLAN profiles for a network
GET /networks/{networkId}/vlanProfiles
- Optional property
adaptivePolicyGroup
Added
- Response property
adaptivePolicyGroup
value added
Get an existing VLAN profile of a network
GET /networks/{networkId}/vlanProfiles/{iname}
- Optional property
adaptivePolicyGroup
Added
- Response property
adaptivePolicyGroup
value added
Create a VLAN profile for a network
POST /networks/{networkId}/vlanProfiles
- Optional property
adaptivePolicyGroup
Added
- Optional property
adaptivePolicyGroup
Added
Update an existing VLAN profile of a network
PUT /networks/{networkId}/vlanProfiles/{iname}
- Optional property
adaptivePolicyGroup
Added
- Optional property
adaptivePolicyGroup
Added
[ organizations ]
devices
List the devices in an organization
GET /organizations/{organizationId}/devices
- Optional property
imei
Added
- Response property
imei
value added
actionBatches
Return an action batch
GET /organizations/{organizationId}/actionBatches/{actionBatchId}
- Optional property
callback
Added
- Response property
callback
value added
Create an action batch
POST /organizations/{organizationId}/actionBatches
- Optional property
callback
Added
- Optional property
callback
Added
webhooks
Return a list of alert types to be used with managing webhook alerts
GET /organizations/{organizationId}/webhooks/alertTypes
- Response property
properties
value added
What's New
[ organizations ]
webhooks
PATH /organizations/{organizationId}/webhooks/callbacks/statuses/{callbackId}
- Path added
- New operation
Return the status of an API callback
GET
/organizations/{organizationId}/webhooks/callbacks/statuses/{callbackId}
Code SnippetCopy{ "callbackId": "1284392014819", "status": "completed", "errors": [ "Callback failed" ], "createdBy": { "adminId": "212406" }, "webhook": { "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031", "httpServer": { "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=" }, "payloadTemplate": { "id": "wpt_2100" }, "sentAt": "2018-02-11T00:00:00.090210Z" } }
[ switch ]
summary
PATH /organizations/{organizationId}/summary/switch/power/history
- Path added
- New operation
Returns the total PoE power draw for all switch ports in the organization over the requested timespan (by default the last 24 hours). The returned array is a newest-first list of intervals. The time between intervals depends on the requested timespan with 20 minute intervals used for timespans up to 1 day, 4 hour intervals used for timespans up to 2 weeks, and 1 day intervals for timespans larger than 2 weeks.
GET
/organizations/{organizationId}/summary/switch/power/history
Code SnippetCopy[ { "ts": "2021-06-20T01:00:00.000Z", "draw": 5.4321 } ]