Devices

Devices include all pieces of HW deployed in your Locations.

List of access points of an organization

List hotspots for the organization <br><b>Role</b>: Organization Manager <br><b>Scope</b>: organization_read, hotspots_read

get

/v3/hotspots/organizations/{cid}

Authorizations

Path parameters

cidstringrequired

id of the organization (aka tenant)

Query parameters

creationDateStartstring

Filter hotspots with date bigger than. Format YYYY-MM-DD

creationDateStopstring

Filter hotspots with date lower than. Format YYYY-MM-DD

namestring

Filter by name

macAddressstring

Filter by hotspot macaddress

hotspotIdentifierstring

Filter by hotspot identifier

venueIdstring

Filter by venueId

deletedstring

Filter by deleted properties. Default deleted=false

limitstring

offsetstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://explore.cloud4wi.com//v3/hotspots/organizations/{cid}' \
  --header 'Authorization: Bearer JWT'

200

default

200

{
  "status": "text",
  "generated": "text",
  "count": 1,
  "hotspots": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "firmware": "text",
      "vendor": "text",
      "hotspotIdentifier": "text",
      "date": "text",
      "macAddress": "text",
      "venueId": "text",
      "country": "text",
      "city": "text",
      "address": "text",
      "latitude": 1,
      "longitude": 1,
      "deleted": true
    }
  ]
}

Array with the hotspots

Get an Access Point

Get Access Point by Id <br><b>Role</b>: Organization Manager <br><b>Scope</b>: organization_read, hotspots_read

get

/v3/hotspots/{hotspotId}

Authorizations

Path parameters

hotspotIdstringrequired

Hotspot id

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://explore.cloud4wi.com//v3/hotspots/{hotspotId}' \
  --header 'Authorization: Bearer JWT'

200

default

200

{
  "status": "text",
  "generated": "text",
  "hotspot": {
    "id": "text",
    "name": "text",
    "description": "text",
    "firmware": "text",
    "vendor": "text",
    "hotspotIdentifier": "text",
    "date": "text",
    "macAddress": "text",
    "venueId": "text",
    "country": "text",
    "city": "text",
    "address": "text",
    "latitude": 1,
    "longitude": 1,
    "deleted": true
  }
}

Hotspot

Get an Acess Point by hotspot identifier

Get an Access Point by hotspot identifier <br><b>Role</b>: Organization Manager <br><b>Scope</b>: organization_read, hotspots_read

get

/v3/hotspots/identifier/{hotspotIdentifier}

Authorizations

Path parameters

hotspotIdentifierstringrequired

Hotspot identifier as configured in the dashboard

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://explore.cloud4wi.com//v3/hotspots/identifier/{hotspotIdentifier}' \
  --header 'Authorization: Bearer JWT'

200

default

200

{
  "status": "text",
  "generated": "text",
  "hotspot": {
    "id": "text",
    "name": "text",
    "description": "text",
    "firmware": "text",
    "vendor": "text",
    "hotspotIdentifier": "text",
    "date": "text",
    "macAddress": "text",
    "venueId": "text",
    "country": "text",
    "city": "text",
    "address": "text",
    "latitude": 1,
    "longitude": 1,
    "deleted": true
  }
}

Hotspot

Create a new hotspot

Create a new hotspot
Note:
Depending on the routerType, the fields macAddress, hotspotIdentifier, and ssid may be required, optional, or not allowed. Please refer to the documentation for further information.
<br><b>Role</b>: Organization Manager <br><b>Scope</b>: hotspots_write, organization_write

post

/v3/hotspots

Authorizations

Body

organizationIdstring

venueIdstring

namestringrequired

descriptionstring

macAddressstringrequired

hotspotIdentifierstring

use according with routerType

ssidstring

use according with routerType

addressAsLocationboolean

Use address, city, country, zip and state from location

countrystring

country code as ISO 3166-1 alpha-2. Required if addressAsLocation is false

addressstring

Required if addressAsLocation is false

citystring

Required if addressAsLocation is false

statestring

Required if addressAsLocation is false

zipstring

Required if addressAsLocation is false

latitudenumberrequired

longitudenumberrequired

routerTypestring · enumrequired

Options: Aerohive Networks, Inc., Aruba Networks, Browan Communication, Inc., Cambium Networks Limited, chillispot, Cisco Systems, coovachilli, Cradlepoint, dd-wrt, endian, Endian s.r.l., EnGenius, EnGenius CP ready, Extreme Networks, FortiNet, Hewlett Packard, Huawei, ICC, Icomera Moovbox, IgniteNet, LigoWave VAC, Meraki, Inc., Mojo Networks, Inc., Nomadix, Inc., Open Mesh, Inc., PowerCloud Systems, Inc., Routerboard.com, routeros, Ruckus Wireless (Controller), Ruckus Wireless (SCG), Ruckus Wireless (Standalone), Ruckus Wireless (Xclaim), Samsung, tanaza, tanaza_os, Teldat, Teltonika, Tiesse SpA, Ubiquiti Networks, Inc., Wi-Next s.r.l., Wilibox Deliberant Group LLC, Xirrus Inc, Zebra Technologies Inc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://explore.cloud4wi.com//v3/hotspots' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","macAddress":"text","latitude":1,"longitude":1,"routerType":"Aerohive Networks, Inc."}'

200

200

{
  "generated": "text",
  "status": "text",
  "locationId": "text",
  "hotspotId": "text"
}

Response

Update an hotspot

Update an hotspot.

Note: The properties venueId, routerType, macAddress, hotspotIdentifier, and ssid are not allowed.
<br><b>Role</b>: Organization Manager <br><b>Scope</b>: hotspots_write, organization_write

put

/v3/hotspots/{hotspotId}

Authorizations

Path parameters

hotspotIdstringrequired

Hotspot id

Body

namestring

descriptionstring

countrystring

country code as ISO 3166-1 alpha-2. Required if addressAsLocation is false

addressstring

Required if addressAsLocation is false

citystring

Required if addressAsLocation is false

statestring

Required if addressAsLocation is false

zipstring

Required if addressAsLocation is false

latitudenumber

longitudenumber

enabledboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://explore.cloud4wi.com//v3/hotspots/{hotspotId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json'

200

200

{
  "generated": "text",
  "status": "text",
  "locationId": "text",
  "hotspotId": "text"
}

Response

Delete an hotspot

Delete an hotspot <br><b>Role</b>: Organization Manager <br><b>Scope</b>: hotspots_write, organization_write

delete

/v3/hotspots/{hotspotId}

Authorizations

Path parameters

hotspotIdstringrequired

Hotspot id

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://explore.cloud4wi.com//v3/hotspots/{hotspotId}' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "generated": "text",
  "status": "text"
}

Response

To create a new Hotspot using the POST /v3/hotspots endpoint, you need to specify the MAC address of the access point and for some vendors also the Identifier.

The following table specifies for which vendor you need to provide the Identifier attribute. For these vendors, even if the Identifier is the same as the MAC address, it needs to be provided.

Vendor	Identifier
Aerohive Networks, Inc.
Aruba Networks	Required
Cambium Networks Limited
chillispot	Required
Cisco Systems
coovachilli	Required
Cradlepoint
dd-wrt	Required
endian	Required
Endian s.r.l.	Required
EnGenius
EnGenius CP ready
Extreme Networks
FortiNet
Hewlett Packard	Required
Huawei
ICC
Icomera Moovbox	Required
IgniteNet
LigoWave VAC
Meraki
Mojo Networks
Nomadix	Required
Open Mesh	Required
PowerCloud Systems	Required
Routerboard.com	Required
routeros	Required
Ruckus Wireless (Controller)
Ruckus Wireless (SCG)	Required
Ruckus Wireless (Standalone)	Required
Ruckus Wireless (Xclaim)	Required
Samsung
tanaza
tanaza_os
Teldat
Teltonika
Tiesse SpA
Ubiquiti Networks
Wilibox Deliberant Group LLC	Required
Wi-Next s.r.l.	Required
Xirrus Inc
Zebra Technologies Inc
Browan Communication Inc.	Required