Devices

Devices include all pieces of HW deployed in your Locations.

List of access points of an organization

get

List hotspots for the organization
Role: Organization Manager
Scope: organization_read, hotspots_read

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cidstringRequired

id of the organization (aka tenant)

Query parameters

creationDateStartstringOptional

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

creationDateStopstringOptional

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

namestringOptional

Filter by name

macAddressstringOptional

Filter by hotspot macaddress

hotspotIdentifierstringOptional

Filter by hotspot identifier

venueIdstringOptional

Filter by venueId

deletedstringOptional

Filter by deleted properties. Default deleted=false

limitstringOptional

offsetstringOptional

Responses

200

Array with the hotspots

application/json

statusstringOptional

generatedstringOptional

date time of response

countnumberOptional

default

Error

application/json

get/v3/hotspots/organizations/{cid}

GET /v3/hotspots/organizations/{cid} HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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
    }
  ]
}

Get an Access Point

get

Get Access Point by Id
Role: Organization Manager
Scope: organization_read, hotspots_read

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

hotspotIdstringRequired

Hotspot id

Responses

200

Hotspot

application/json

statusstringOptional

generatedstringOptional

date time of response

default

Error

application/json

get/v3/hotspots/{hotspotId}

GET /v3/hotspots/{hotspotId} HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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
  }
}

Get an Acess Point by hotspot identifier

get

Get an Access Point by hotspot identifier
Role: Organization Manager
Scope: organization_read, hotspots_read

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

hotspotIdentifierstringRequired

Hotspot identifier as configured in the dashboard

Responses

200

Hotspot

application/json

statusstringOptional

generatedstringOptional

date time of response

default

Error

application/json

get/v3/hotspots/identifier/{hotspotIdentifier}

GET /v3/hotspots/identifier/{hotspotIdentifier} HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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
  }
}

Create a new hotspot

post

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.

Role: Organization Manager
Scope: hotspots_write, organization_write

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

organizationIdstringOptional

venueIdstringOptional

namestringRequired

descriptionstringOptional

routerTypestring · enumRequiredPossible values:

macAddressstringRequired

hotspotIdentifierstringOptional

use according with routerType

ssidstringOptional

use according with routerType

addressAsLocationbooleanOptional

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

countrystringOptional

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

addressstringOptional

Required if addressAsLocation is false

citystringOptional

Required if addressAsLocation is false

statestringOptional

Required if addressAsLocation is false

zipstringOptional

Required if addressAsLocation is false

latitudenumberRequired

longitudenumberRequired

Responses

200

Response

application/json

generatedstringOptional

statusstringOptional

locationIdstringOptional

hotspotIdstringOptional

post/v3/hotspots

POST /v3/hotspots HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 305

{
  "organizationId": "text",
  "venueId": "text",
  "name": "text",
  "description": "text",
  "routerType": "Aerohive Networks, Inc.",
  "macAddress": "text",
  "hotspotIdentifier": "text",
  "ssid": "text",
  "addressAsLocation": true,
  "country": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "latitude": 1,
  "longitude": 1
}

200

Response

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

Update an hotspot

put

Update an hotspot.

Note: The properties venueId, routerType, macAddress, hotspotIdentifier, and ssid are not allowed.

Role: Organization Manager
Scope: hotspots_write, organization_write

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

hotspotIdstringRequired

Hotspot id

Body

namestringOptional

descriptionstringOptional

countrystringOptional

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

addressstringOptional

Required if addressAsLocation is false

citystringOptional

Required if addressAsLocation is false

statestringOptional

Required if addressAsLocation is false

zipstringOptional

Required if addressAsLocation is false

latitudenumberOptional

longitudenumberOptional

enabledbooleanOptional

Responses

200

Response

application/json

generatedstringOptional

statusstringOptional

locationIdstringOptional

hotspotIdstringOptional

put/v3/hotspots/{hotspotId}

PUT /v3/hotspots/{hotspotId} HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "name": "text",
  "description": "text",
  "country": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "latitude": 1,
  "longitude": 1,
  "enabled": true
}

200

Response

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

Delete an hotspot

delete

Delete an hotspot
Role: Organization Manager
Scope: hotspots_write, organization_write

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

hotspotIdstringRequired

Hotspot id

Responses

200

Response

application/json

generatedstringOptional

statusstringOptional

delete/v3/hotspots/{hotspotId}

DELETE /v3/hotspots/{hotspotId} HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response

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

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

PreviousGeofences NextSegments

Last updated 2 years ago

Was this helpful?