- What's Updated
- What's New
- [ networks ]
- floorPlans
- Schedule auto locate jobs for one or more floor plans in a network
- Cancel a scheduled or running auto locate job
- Update the status of a finished auto locate job to be published, and update device locations
- Trigger auto locate recalculation for a job, and optionally set anchors
- Update floorplan assignments for a batch of devices
- floorPlans
- [ organizations ]
- [ wireless ]
- [ networks ]
Version v1.51.1 to 1.52.0
Summary of Changes
8 - New
20 - Updated
768 - Total Endpoints
515 - Total Paths
What's Updated
[ switch ]
ports
List the switch ports for a switch
GET /devices/{serial}/switch/ports
- Optional property
stackwiseVirtual
Added
- Response property
stackwiseVirtual
value added
Return a switch port
GET /devices/{serial}/switch/ports/{portId}
- Optional property
stackwiseVirtual
Added
- Response property
stackwiseVirtual
value added
Update a switch port
PUT /devices/{serial}/switch/ports/{portId}
- Optional property
stackwiseVirtual
Added
configTemplates
Return all the ports of a switch template
GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports
- Optional property
stackwiseVirtual
Added
- Response property
stackwiseVirtual
value added
Return a switch template port
GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
- Optional property
stackwiseVirtual
Added
- Response property
stackwiseVirtual
value added
Update a switch template port
PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
- Optional property
stackwiseVirtual
Added
[ networks ]
traffic
Return the traffic analysis data for this network
GET /networks/{networkId}/traffic
- Response property
properties
value added
What's New
[ networks ]
floorPlans
PATH /networks/{networkId}/floorPlans/autoLocate/jobs/batch
- Path added
- New endpoint
Schedule auto locate jobs for one or more floor plans in a network
POST
/networks/{networkId}/floorPlans/autoLocate/jobs/batch
{ "jobs": [ { "id": "1234", "networkId": "N_24329156", "floorPlanId": "g_2176982374", "status": "error", "scheduledAt": "2018-02-11T00:00:00Z", "completed": { "percentage": 50 }, "ranging": { "status": "in progress", "completed": { "percentage": 24 } }, "gnss": { "status": "in progress", "completed": { "percentage": 4 } }, "errors": [ { "source": "ranging", "type": "missing anchors" } ] } ] }
PATH /networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/cancel
- Path added
- New endpoint
Cancel a scheduled or running auto locate job
POST
/networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/cancel
PATH /networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/publish
- Path added
- New endpoint
Update the status of a finished auto locate job to be published, and update device locations
POST
/networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/publish
{ "success": true }
PATH /networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/recalculate
- Path added
- New endpoint
Trigger auto locate recalculation for a job, and optionally set anchors
POST
/networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/recalculate
{ "success": true }
PATH /networks/{networkId}/floorPlans/devices/batchUpdate
- Path added
- New endpoint
Update floorplan assignments for a batch of devices
POST
/networks/{networkId}/floorPlans/devices/batchUpdate
{ "success": true }
[ organizations ]
floorPlans
PATH /organizations/{organizationId}/floorPlans/autoLocate/devices
- Path added
- New endpoint
List auto locate details for each device in your organization
GET
/organizations/{organizationId}/floorPlans/autoLocate/devices
[ { "items": [ { "name": "My AP", "serial": "Q234-ABCD-5678", "mac": "00:11:22:33:44:55", "model": "MR34", "tags": [ "tag1", "tag2" ], "status": "online", "network": { "id": "N_24329156" }, "floorPlan": { "id": "g_2176982374", "status": "My floor plan" }, "lat": 37.4180951010362, "lng": -122.098531723022, "autoLocate": { "lat": 13.23454243, "lng": 18.12938123 }, "type": "user", "isAnchor": true } ], "meta": { "counts": { "items": { "total": 50, "remaining": 100 } } } } ]
PATH /organizations/{organizationId}/floorPlans/autoLocate/statuses
- Path added
- New endpoint
List the status of auto locate for each floorplan in your organization
GET
/organizations/{organizationId}/floorPlans/autoLocate/statuses
[ { "items": [ { "network": { "id": "N_24329156" }, "floorPlanId": "g_2176982374", "name": "My Floorplan", "counts": { "devices": { "total": 120 } }, "jobs": [ { "id": "1234", "status": "error", "scheduledAt": "2018-02-11T00:00:00Z", "completed": { "percentage": 50 }, "ranging": { "status": "in progress", "completed": { "percentage": 24 } }, "gnss": { "status": "in progress", "completed": { "percentage": 4 } }, "errors": [ { "source": "ranging", "type": "missing anchors" } ] } ] } ], "meta": { "counts": { "items": { "total": 50, "remaining": 100 } } } } ]
[ wireless ]
radio
PATH /organizations/{organizationId}/wireless/radio/autoRf/channels/recalculate
- Path added
- New endpoint
Recalculates automatically assigned channels for every AP within specified the specified network(s). Note: This could cause a brief loss in connectivity for wireless clients.
POST
/organizations/{organizationId}/wireless/radio/autoRf/channels/recalculate
{ "estimatedCompletedAt": "2019-01-01T00:00:00Z" }