Devices

Devices include all pieces of HW deployed in your Locations.

List of access points of an organization

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

GEThttps://explore.cloud4wi.com//v3/hotspots/organizations/{cid}

Path parameters

cid*string

id of the organization (aka tenant)

Query parameters

Response

Array with the hotspots

Body

statusstring

generatedstring

date time of response

countnumber

hotspotsarray of hotspot (object)

Request

const response = await fetch('https://explore.cloud4wi.com//v3/hotspots/organizations/{cid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text",
  "generated": "text",
  "count": 0,
  "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": 0,
      "longitude": 0,
      "deleted": false
    }
  ]
}

Get an Access Point

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

GEThttps://explore.cloud4wi.com//v3/hotspots/{hotspotId}

Path parameters

hotspotId*string

Hotspot id

Response

Hotspot

Body

statusstring

generatedstring

date time of response

hotspothotspot (object)

Request

const response = await fetch('https://explore.cloud4wi.com//v3/hotspots/{hotspotId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": 0,
    "longitude": 0,
    "deleted": false
  }
}

Get an Acess Point by hotspot identifier

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

GEThttps://explore.cloud4wi.com//v3/hotspots/identifier/{hotspotIdentifier}

Path parameters

hotspotIdentifier*string

Hotspot identifier as configured in the dashboard

Response

Hotspot

Body

statusstring

generatedstring

date time of response

hotspothotspot (object)

Request

const response = await fetch('https://explore.cloud4wi.com//v3/hotspots/identifier/{hotspotIdentifier}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": 0,
    "longitude": 0,
    "deleted": false
  }
}

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.
Role: Organization Manager Scope: hotspots_write, organization_write

POSThttps://explore.cloud4wi.com//v3/hotspots

Body

organizationIdstring

venueIdstring

name*string

descriptionstring

routerType*enum

Aerohive Networks, Inc.Aruba NetworksBrowan Communication, Inc.Cambium Networks LimitedchillispotCisco SystemscoovachilliCradlepointdd-wrtendianEndian s.r.l.EnGeniusEnGenius CP readyExtreme NetworksFortiNetHewlett PackardHuaweiICCIcomera MoovboxIgniteNetLigoWave VACMeraki, Inc.Mojo Networks, Inc.Nomadix, Inc.Open Mesh, Inc.PowerCloud Systems, Inc.Routerboard.comrouterosRuckus Wireless (Controller)Ruckus Wireless (SCG)Ruckus Wireless (Standalone)Ruckus Wireless (Xclaim)Samsungtanazatanaza_osTeldatTeltonikaTiesse SpAUbiquiti Networks, Inc.Wi-Next s.r.l.Wilibox Deliberant Group LLCXirrus IncZebra Technologies Inc

macAddress*string

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

latitude*number

longitude*number

Response

Body

generatedstring

statusstring

locationIdstring

hotspotIdstring

Request

const response = await fetch('https://explore.cloud4wi.com//v3/hotspots', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "routerType": "Aerohive Networks, Inc.",
      "macAddress": "text",
      "latitude": 0,
      "longitude": 0
    }),
});
const data = await response.json();

Response

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

Update an hotspot

Update an hotspot.

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

PUThttps://explore.cloud4wi.com//v3/hotspots/{hotspotId}

Path parameters

hotspotId*string

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

Response

Body

generatedstring

statusstring

locationIdstring

hotspotIdstring

Request

const response = await fetch('https://explore.cloud4wi.com//v3/hotspots/{hotspotId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Delete an hotspot

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

DELETEhttps://explore.cloud4wi.com//v3/hotspots/{hotspotId}

Path parameters

hotspotId*string

Hotspot id

Response

Body

generatedstring

statusstring

Request

const response = await fetch('https://explore.cloud4wi.com//v3/hotspots/{hotspotId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

PreviousGeofences NextSegments

Last updated 7 months ago

Create a new hotspot

POSThttps://explore.cloud4wi.com//v3/hotspots

const response = await fetch('https://explore.cloud4wi.com//v3/hotspots', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "routerType": "Aerohive Networks, Inc.", "macAddress": "text", "latitude": 0, "longitude": 0 }), }); const data = await response.json();