Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extreme Networks Location API

Hierarchical locations and floor plan

Extreme Networks Location API is one of 52 APIs that Extreme Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Location. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 27 operations across 15 paths, and defines 28 schemas. It is described by OpenAPI 3.0.3, at version 25.9.0-36.

Requests are made against a single base URL, https://api.extremecloudiq.com.

27 operations 15 paths 28 schemas 5 DELETE11 GET6 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
25.9.0-36
Base URL
https://api.extremecloudiq.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Extreme Networks Location API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 27

Across 15 paths, the API surfaces 27 operations — 5 DELETE, 11 GET, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Location 27

Hierarchical locations and floor plan

POST
/locations
Create location
createLocation body → 200default
GET
/locations/tree
Get location tree
getLocationTree 2 params → 200default
GET
/locations/tree/devices
Get devices on the location hierarchy
getLocationDevicesList 4 params → 200default
GET
/locations/tree/maps
Get maps on the location hierarchy
getLocationMapsList 4 params → 200default
POST
/locations/floorplan
Upload floorplan
uploadFloorplan body → 200default
PUT
/locations/{id}
Update location
updateLocation 1 param body → 200default
DELETE
/locations/{id}
Delete location by ID
deleteLocation 2 params → 200default
GET
/locations/floor
List floors
getFloors 4 params → 200default
POST
/locations/floor
Create floor
createFloor body → 200default
GET
/locations/floor/{id}
Get a floor by ID
getFloor 1 param → 200default
PUT
/locations/floor/{id}
Update floor
updateFloor 1 param body → 200default
DELETE
/locations/floor/{id}
Delete floor by ID
deleteFloor 1 param → 200default
GET
/locations/building
List buildings
getBuildings 4 params → 200default
POST
/locations/building
Create building
createBuilding body → 200default
GET
/locations/building/{id}
Get a building by ID
getBuilding 1 param → 200default
PUT
/locations/building/{id}
Update building
updateBuilding 1 param body → 200default
DELETE
/locations/building/{id}
Delete building by ID
deleteBuilding 2 params → 200default
GET
/locations/site
List sites
getSites 4 params → 200default
POST
/locations/site
Create site
createSite body → 200default
GET
/locations/site/{id}
Get site by ID
getSite 1 param → 200default
PUT
/locations/site/{id}
Update site by ID
updateSite 1 param body → 200default
DELETE
/locations/site/{id}
Delete site by ID
deleteSite 2 params → 200default
GET
/locations/wall/type
Get a wall types
getWallType → 200default
POST
/locations/wall/type
Create a wall type
createWallType → 200default
PUT
/locations/wall/type/{id}
Update a wall type
updateWallType 1 param body → 200default
DELETE
/locations/wall/type/{id}
Delete a wall type
deleteWallType 1 param → 204default
GET
/locations/wall/type/references/{id}
Find references of a wall type
findWallTypeReference 1 param → 200default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ClsLocationTreeDevice (12 properties), ClsUpdateFloorRequest (9 properties), ClsCreateFloorRequest (9 properties), ClsWallType (7 properties). Each schema is shown below with its type and property counts.

ClsCreateBuildingRequest
object
5 properties 3 required
PagedClsLocationTreeMap
ClsMeasurementUnit
string
The measurement unit in feet/meters
ClsCreateLocationRequest
object
2 properties 2 required
ClsAddress
object
5 properties 3 required
ClsUpdateWallTypeRequest
object
3 properties 3 required
ClsBuilding
ClsWallTypeReference
object
2 properties
ClsFloor
XiqErrorParams
object
Error parameters
2 properties
ClsSite
XiqBaseEntity
object
3 properties 3 required
ClsUpdateBuildingRequest
object
5 properties 3 required
ClsRfEnvironmentType
string
The floor RF environment
ClsLocationTreeDevice
object
The device on the location hierarchy.
12 properties 11 required
ClsCreateSiteRequest
object
6 properties 2 required
XiqError
object
6 properties 3 required
ClsLocation
ClsUpdateLocationRequest
object
2 properties 2 required
XiqPage
object
4 properties 4 required
ClsUpdateSiteRequest
object
6 properties 2 required
XiqViqEntity
PagedClsLocationTreeDevice
ClsCreateWallTypeRequest
object
3 properties 3 required
ClsWallType
object
7 properties
ClsUpdateFloorRequest
object
9 properties 7 required
ClsLocationTreeMap
object
The map on the location hierarchy.
4 properties 4 required
ClsCreateFloorRequest
object
9 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-location-api-openapi.yml Raw ↑

Other APIs Extreme Networks publishes across the network.

ExtremeCloud IQ Controller REST API Gateway
ExtremeCloud IQ Controller Application Manager API
Ansible Network Collection for Extreme EXOS
Ansible Network Collection for Extreme VOSS
Ansible Network Collection for Extreme SLX-OS
Ansible Network Collection for Extreme NOS
Ansible Network Collection for Extreme Fabric Engine
Extreme Networks Account API
Extreme Networks Administration API
Extreme Networks AFC API
Extreme Networks Alert API
Extreme Networks Application API