Documentation Powered by ReDoc

RUCKUS Cloud - Wi-Fi API and Model Documentation (v20.11.11)

License: RUCKUS Cloud Privacy Policy Terms of Service

APIs published in this document are subject to strict change control by Ruckus. As far as possible, when new versions of the Public API are published, all documented API endpoints will maintain backward compatibility. When not possible, an API endpoint will be deprecated and a replacement API or some other workaround will be provided. Support for deprecated API endpoints will continue for at least six months prior to removal in order to provide API client developers sufficient time to adopt the replacement. This document will indicate when API endpoints are deprecated along with the schedule for their removal. API client developers may discover other experimental API endpoints provided by the Ruckus Cloud, not included in this API document. Ruckus reserves the right to change these experimental APIs without notice to API client developers.

AP

Manage APs including pinging, trace-routing, resetting, rebooting, floor-plan positioning, bonjour gateway and LAN-Ports settings.

Get APs by AP-Group

Get the APs in the AP-group.

path Parameters
apGroupId
required
string

AP-group ID

tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get APs

Get the AP list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
operational
boolean
Default: true
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add APs

Add a list of new APs.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema:
application/json
application/json
multipart/form-data
Array ()
serialNumber
required
string^[1-9][0-9]{11}$
apGroupId
string
venueId
required
string
name
required
string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
description
string [ 0 .. 180 ] characters
tags
Array of strings [ 0 .. 24 ] items
model
string [ 0 .. 64 ] characters
Default: "null"
object (ApPosition)

Ap Position object

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
[
  • {
    }
]

Response samples

Content type
application/json
Example
OperationResponseImportDetails
OperationResponseImportDetails
OperationResponseListAp
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk APs

Delete a list of APs.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get AP Radio

Get AP radio details.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "apRadioParams24G": {
    },
  • "apRadioParams50G": {
    },
  • "useVenueSettings": true,
  • "enable24G": false,
  • "enable50G": false
}

Update AP Radio

Update an AP radio settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Request Body schema: application/json
object (ApRadioParams24G)

AP radio customization for 2.4 Ghz

object (ApRadioParams50G)

AP radio customization for 5 Ghz

useVenueSettings
boolean
Default: true
enable24G
boolean
Default: false
enable50G
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "apRadioParams24G": {
    },
  • "apRadioParams50G": {
    },
  • "useVenueSettings": true,
  • "enable24G": false,
  • "enable50G": false
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Reset AP Radio Customization

Reset AP radio to default settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get AP LAN-Ports

Get AP LAN-ports details.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "poeOut": false,
  • "poeMode": "Auto",
  • "lanPorts": [
    ],
  • "useVenueSettings": false
}

Update AP LAN-Ports

Update LAN-ports of an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Request Body schema: application/json
poeOut
boolean
Default: false
poeMode
string
Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8"
Array of objects (ApLanPort)
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "poeOut": false,
  • "poeMode": "Auto",
  • "lanPorts": [
    ],
  • "useVenueSettings": false
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Reset AP LAN-Ports

Reset the LAN-ports of an AP to the default values.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Ap Customization

Get AP customization details.

path Parameters
serialNumber
required
string
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "externalAntenna": {
    },
  • "poeOut": false,
  • "poeMode": "Auto",
  • "lanPorts": [
    ],
  • "useVenueSettings": false,
  • "id": "string"
}

Update Ap Customization

Update the customization of an AP.

path Parameters
serialNumber
required
string
tenantId
required
string

Tenant ID

Request Body schema: application/json
object (ExternalAntenna)

External antenna settings

poeOut
boolean
Default: false
poeMode
string
Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8"
Array of objects (ApLanPort)
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "externalAntenna": {
    },
  • "poeOut": false,
  • "poeMode": "Auto",
  • "lanPorts": [
    ],
  • "useVenueSettings": false
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Reset Ap Customization

Reset the customization of an AP to the default values.

path Parameters
serialNumber
required
string
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Reboot AP

Reboot an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Factory Reset AP

Perform a factory reset on an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Update AP Position

Update an AP floor-plan position.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Request Body schema: application/json
floorplanId
string
xPercent
number <float> [ 0 .. 100 ]
yPercent
number <float> [ 0 .. 100 ]

Responses

Request samples

Content type
application/json
{
  • "floorplanId": "string",
  • "xPercent": 0,
  • "yPercent": 0
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get AP Bonjour Gateway

Get the AP bonjour gateway details.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Update AP Bonjour Gateway

Update the AP bonjour gateway.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Request Body schema: application/json
required
Array of objects (BonjourGatewayRule) [ 1 .. 2147483647 ] items

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Reset AP Bonjour Gateway

Reset the AP bonjour gateway.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Ping AP

Perform a ping to the AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Request Body schema: application/json
targetHost
required
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...

Responses

Request samples

Content type
application/json
{
  • "targetHost": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get AP

Get the AP operational and configuration data.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

query Parameters
operational
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "serialNumber": "string",
  • "apGroupId": "string",
  • "venueId": "string",
  • "lanPorts": {
    },
  • "bonjourGateway": {
    },
  • "radio": {
    },
  • "clientCount": 0,
  • "lastContacted": "null",
  • "lastUpdated": "null",
  • "indoorModel": false,
  • "firmware": "null",
  • "state": "null",
  • "subState": "null",
  • "mac": "null",
  • "ip": "null",
  • "externalIp": "null",
  • "meshRole": "null",
  • "uptime_seconds": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "softDeleted": false,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "model": "null",
  • "position": {
    },
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Update AP

Update an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Request Body schema: application/json
serialNumber
required
string^[1-9][0-9]{11}$
apGroupId
string
venueId
required
string
name
required
string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
description
string [ 0 .. 180 ] characters
tags
Array of strings [ 0 .. 24 ] items
model
string [ 0 .. 64 ] characters
Default: "null"
object (ApPosition)

Ap Position object

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "string",
  • "apGroupId": "string",
  • "venueId": "string",
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "model": "null",
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete AP

Delete an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get AP (Deep)

Get the AP operational and configuration data, including nested details.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "serialNumber": "string",
  • "apGroupId": "string",
  • "venueId": "string",
  • "lanPorts": {
    },
  • "bonjourGateway": {
    },
  • "radio": {
    },
  • "clientCount": 0,
  • "lastContacted": "null",
  • "lastUpdated": "null",
  • "indoorModel": false,
  • "firmware": "null",
  • "state": "null",
  • "subState": "null",
  • "mac": "null",
  • "ip": "null",
  • "externalIp": "null",
  • "meshRole": "null",
  • "uptime_seconds": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "softDeleted": false,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "model": "null",
  • "position": {
    },
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Trace-Route AP

Perform a trace-route on an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Request Body schema: application/json
targetHost
required
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...

Responses

Request samples

Content type
application/json
{
  • "targetHost": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Download AP Log

Download the AP log file.

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "fileURL": "string"
}

Get DHCP Pool Usages

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get DHCP Lease Times

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Blink LED AP

Blink an AP's LED lights

path Parameters
serialNumber
required
string

The serial number of the AP.

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Packet Capture State

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "errors": [
    ],
  • "downloadUrl": "string"
}

Start Packet Capture

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string
Request Body schema: application/json
captureInterface
required
string^RADIO(24|50)$|^ETH[0-7]$
macAddressFilter
string^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$|...
frameTypeFilter
Array of strings
Items Enum: "MANAGEMENT" "CONTROL" "DATA"

Responses

Request samples

Content type
application/json
{
  • "captureInterface": "string",
  • "macAddressFilter": "string",
  • "frameTypeFilter": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "errors": [
    ],
  • "downloadUrl": "string"
}

Stop Packet Capture

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "errors": [
    ],
  • "downloadUrl": "string"
}

AP-Group

Manage AP-Groups.

Get AP-Groups

Get the AP-group list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create AP-Group

Create a new AP-group.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
venueId
required
string
Array of objects (ApSerialNumber)
name
required
string [ 2 .. 64 ] characters
description
string [ 2 .. 180 ] characters

Responses

Request samples

Content type
application/json
{
  • "venueId": "string",
  • "apSerialNumbers": [
    ],
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk AP-Groups

Delete a list of AP-groups.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get AP-Groups by Venue

Get the AP-group list by venue.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Venue Default AP-Group

Get venue default AP-group details.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "venueId": "string",
  • "aps": [
    ],
  • "isDefault": false,
  • "name": "string",
  • "description": "string",
  • "id": "string"
}

Get AP-Group

Get the AP-group details.

path Parameters
apGroupId
required
string

AP-group ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "venueId": "string",
  • "aps": [
    ],
  • "isDefault": false,
  • "name": "string",
  • "description": "string",
  • "id": "string"
}

Update AP-Group

Update an AP-group.
Note: AP-Groups cannot be moved between Venues, but a single AP can be moved between Venues using UpdateAP

path Parameters
apGroupId
required
string

AP-group ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
venueId
required
string
Array of objects (ApSerialNumber)
name
required
string [ 2 .. 64 ] characters
description
string [ 2 .. 180 ] characters

Responses

Request samples

Content type
application/json
{
  • "venueId": "string",
  • "apSerialNumbers": [
    ],
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete AP-Group

Delete an AP-group.

path Parameters
apGroupId
required
string

AP-group ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Network

Manage WLANs.

Get Network

Get the network details.

path Parameters
networkId
required
string

Network ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
Example
aaa
aaa
cloudpath
dpsk
guest
open
psk
{
  • "type": "aaa",
  • "wlan": {
    },
  • "authRadiusId": "string",
  • "accountingRadiusId": "string",
  • "tenantId": "string",
  • "name": "string",
  • "description": "string",
  • "id": "string"
}

Update Network

Update a network, including nested details.

path Parameters
networkId
required
string

Network ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
type
required
string
aaa
aaa
cloudpath
dpsk
guest
open
psk
required
object (AAAWlan)

WLAN

authRadiusId
string
accountingRadiusId
string
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
description
string [ 0 .. 255 ] characters

Responses

Request samples

Content type
application/json
Example
aaa
aaa
cloudpath
dpsk
guest
open
psk
{
  • "type": "aaa",
  • "wlan": {
    },
  • "authRadiusId": "string",
  • "accountingRadiusId": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Network

Delete a network.

path Parameters
networkId
required
string

Network ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Networks

Get the network list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
Example
aaa
aaa
cloudpath
dpsk
guest
open
psk
{
  • "type": "aaa",
  • "wlan": {
    },
  • "authRadiusId": "string",
  • "accountingRadiusId": "string",
  • "tenantId": "string",
  • "name": "string",
  • "description": "string",
  • "id": "string"
}

Create Network

Create a new network.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
type
required
string
aaa
aaa
cloudpath
dpsk
guest
open
psk
required
object (AAAWlan)

WLAN

authRadiusId
string
accountingRadiusId
string
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
description
string [ 0 .. 255 ] characters

Responses

Request samples

Content type
application/json
Example
aaa
aaa
cloudpath
dpsk
guest
open
psk
{
  • "type": "aaa",
  • "wlan": {
    },
  • "authRadiusId": "string",
  • "accountingRadiusId": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk Networks

Delete a list of networks.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Network (Deep)

Get network details, including nested details.

path Parameters
networkId
required
string

Network ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
Example
aaa
aaa
cloudpath
psk
guest
open
DpskNetworkDeep
{
  • "description": "string",
  • "id": "string",
  • "venues": [
    ],
  • "tenantId": "string",
  • "name": "string",
  • "type": "aaa",
  • "wlan": {
    },
  • "authRadius": {
    },
  • "accountingRadius": {
    }
}

Update Network (Deep)

Update a network

path Parameters
networkId
required
string

Network ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
description
string [ 0 .. 255 ] characters
Array of objects (NetworkVenue)
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
type
required
string
aaa
aaa
cloudpath
psk
guest
open
DpskNetworkDeep
required
object (AAAWlan)

WLAN

required
object (Radius)

Primary and secondary RADIUS servers

object (Radius)

Primary and secondary RADIUS servers

Responses

Request samples

Content type
application/json
Example
aaa
aaa
cloudpath
psk
guest
open
DpskNetworkDeep
{
  • "description": "string",
  • "id": "string",
  • "venues": [
    ],
  • "tenantId": "string",
  • "name": "string",
  • "type": "aaa",
  • "wlan": {
    },
  • "authRadius": {
    },
  • "accountingRadius": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Create Network (Deep)

Create a new network (deep).

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
description
string [ 0 .. 255 ] characters
Array of objects (NetworkVenue)
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
type
required
string
aaa
aaa
cloudpath
psk
guest
open
DpskNetworkDeep
required
object (AAAWlan)

WLAN

required
object (Radius)

Primary and secondary RADIUS servers

object (Radius)

Primary and secondary RADIUS servers

Responses

Request samples

Content type
application/json
Example
aaa
aaa
cloudpath
psk
guest
open
DpskNetworkDeep
{
  • "description": "string",
  • "id": "string",
  • "venues": [
    ],
  • "tenantId": "string",
  • "name": "string",
  • "type": "aaa",
  • "wlan": {
    },
  • "authRadius": {
    },
  • "accountingRadius": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Network-Venue

Manage network activation in venues.

Get Network-Venue activation

Get the network-venue activation details.

path Parameters
networkVenueId
required
string

Network-Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "venueId": "string",
  • "networkId": "string",
  • "apGroups": [
    ],
  • "scheduler": {
    },
  • "isAllApGroups": true,
  • "allApGroupsVlanId": 1,
  • "vlanPoolId": "string",
  • "allApGroupsRadio": "RadioEnum.Both",
  • "id": "string"
}

Update Network-Venue

Update a network-venue activation.

path Parameters
networkVenueId
required
string

Network-Venue ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
venueId
string
networkId
string
Array of objects (NetworkApGroup)
object (NetworkVenueScheduler)

Network-Venue Scheduler

isAllApGroups
boolean
Default: true
allApGroupsVlanId
integer <int32> [ 1 .. 4094 ]
vlanPoolId
string
allApGroupsRadio
string
Default: "RadioEnum.Both"
Enum: "Both" "2.4-GHz" "5-GHz"

Responses

Request samples

Content type
application/json
{
  • "venueId": "string",
  • "networkId": "string",
  • "apGroups": [
    ],
  • "scheduler": {
    },
  • "isAllApGroups": true,
  • "allApGroupsVlanId": 1,
  • "vlanPoolId": "string",
  • "allApGroupsRadio": "RadioEnum.Both"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Network-Venue

Delete a network-venue activation.

path Parameters
networkVenueId
required
string

Network-Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Network-Venue activation by Network and Venue

Get a network-venue activation by network and venue.

path Parameters
networkId
required
string

Network ID

venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "venueId": "string",
  • "networkId": "string",
  • "apGroups": [
    ],
  • "scheduler": {
    },
  • "isAllApGroups": true,
  • "allApGroupsVlanId": 1,
  • "vlanPoolId": "string",
  • "allApGroupsRadio": "RadioEnum.Both",
  • "id": "string"
}

Get Venue-Network Activations

Get venue-network activation list

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Network-Venue

Create a new network-venue activation.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
venueId
string
networkId
string
Array of objects (NetworkApGroup)
object (NetworkVenueScheduler)

Network-Venue Scheduler

isAllApGroups
boolean
Default: true
allApGroupsVlanId
integer <int32> [ 1 .. 4094 ]
vlanPoolId
string
allApGroupsRadio
string
Default: "RadioEnum.Both"
Enum: "Both" "2.4-GHz" "5-GHz"

Responses

Request samples

Content type
application/json
{
  • "venueId": "string",
  • "networkId": "string",
  • "apGroups": [
    ],
  • "scheduler": {
    },
  • "isAllApGroups": true,
  • "allApGroupsVlanId": 1,
  • "vlanPoolId": "string",
  • "allApGroupsRadio": "RadioEnum.Both"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk Network-Venues

Delete a list of network-venue activations.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Network-Venues activations

Get network-venue activation list.

path Parameters
networkId
required
string

Network ID

tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Venue

Manage Wi-Fi venue configuration, including radio settings, mesh, LEDs, LAN-ports, syslogs, and vSPoT server.

Update Mesh

Enable/disable the venue mesh.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
enabled
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Venue LAN-Ports

List venue LAN-port settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Venue LAN-Ports

Update a venue LAN-port settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
Array of objects (VenueLanPort)
model
string [ 0 .. 64 ] characters
poeOut
boolean
Default: false
poeMode
string
Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Get Venue LED

Get venue LED settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Venue LED

Update venue LED settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
ledEnabled
boolean
Default: false
model
string [ 0 .. 64 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Get Venue External Antenna

List venue external antenna settings. The settings are defined per AP model.

path Parameters
venueId
required
string
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Venue External Antenna

Update a venue external antenna settings. The settings are defined per AP model.

path Parameters
venueId
required
string
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
enable24G
boolean
Default: false
enable50G
boolean
Default: false
gain24G
integer <int32> [ 0 .. 60 ]
gain50G
integer <int32> [ 0 .. 60 ]
model
string [ 0 .. 64 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Get Venue Radio

Get the venue radio.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "radioParams24G": {
    },
  • "radioParams50G": {
    }
}

Update venue radio

Update the venue radio.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
object (RadioParams24G)

Radio customization for 2.4 Ghz

object (RadioParams50G)

Radio customization for 5 Ghz

Responses

Request samples

Content type
application/json
{
  • "radioParams24G": {
    },
  • "radioParams50G": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Reset Venue Radio

Reset venue radio to default values.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Default Radio

Get the venue radio default values.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "radioParams24G": {
    },
  • "radioParams50G": {
    }
}

Get Venue Default Regulatory-Channels

Get venue default regulatory channels.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "2.4GChannels": {
    },
  • "5GChannels": {
    }
}

Get Venue Syslog

Get the venue syslog settings.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "enabled": false,
  • "server": "string",
  • "port": 514,
  • "facility": "FacilityEnum.KEEP_ORIGINAL",
  • "priority": "PriorityEnum.INFO",
  • "protocol": "ProtocolEnum.UDP",
  • "flowLevel": "FlowLevelEnum.CLIENT_FLOW",
  • "secondaryServer": "string",
  • "secondaryPort": 514,
  • "secondaryProtocol": "ProtocolEnum.TCP"
}

Update Venue Syslog

Update the venue syslog settings.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
enabled
boolean
Default: false
server
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...
port
integer <int32> [ 1 .. 65535 ]
Default: 514
facility
string
Default: "FacilityEnum.KEEP_ORIGINAL"
Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7"
priority
string
Default: "PriorityEnum.INFO"
Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL"
protocol
string
Default: "ProtocolEnum.UDP"
Enum: "TCP" "UDP"
flowLevel
string
Default: "FlowLevelEnum.CLIENT_FLOW"
Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL"
secondaryServer
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...
secondaryPort
integer <int32> [ 1 .. 65535 ]
Default: 514
secondaryProtocol
string
Default: "ProtocolEnum.TCP"
Enum: "TCP" "UDP"

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "server": "string",
  • "port": 514,
  • "facility": "FacilityEnum.KEEP_ORIGINAL",
  • "priority": "PriorityEnum.INFO",
  • "protocol": "ProtocolEnum.UDP",
  • "flowLevel": "FlowLevelEnum.CLIENT_FLOW",
  • "secondaryServer": "string",
  • "secondaryPort": 514,
  • "secondaryProtocol": "ProtocolEnum.TCP"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Reset Venue Syslog

Reset venue syslog settings to default values.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Venues

Get the venue list of Wi-Fi details.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Venue

Get the venue Wi-Fi details.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "countryCode": "string",
  • "apPassword": "string",
  • "mesh": {
    },
  • "bandBalancing": {
    },
  • "radioCustomization": {
    },
  • "syslog": {
    },
  • "dhcpServiceSetting": {
    },
  • "lteBandLockChannels": [
    ],
  • "id": "string"
}

Get Venue vSPoT

Get the vSPoT details of a venue.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "venues": [
    ],
  • "serverName": "string",
  • "vspotGlobalId": "string",
  • "serverAddress": "string",
  • "port": 8883,
  • "password": "stringst",
  • "id": "string"
}

Unbind Venue vSPoT

Unbind a venue from the vSPoT server.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Bind Venue vSPoT

Bind a venue to the vSPoT server.

path Parameters
venueId
required
string

Venue ID

vspotId
required
string

vSPoT ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Venue Ap Model Cellular

Get AP model cellular settings and LteBandLockChannels of the venue

path Parameters
venueId
required
string
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "model": "string",
  • "primarySim": {
    },
  • "secondarySim": {
    },
  • "wanConnection": "ETH_WITH_CELLULAR_FAILOVER",
  • "primaryWanRecoveryTimer": 10
}

Update Venue Ap Model Cellular

Update AP model cellular settings and LteBandLockChannels of the venue

path Parameters
venueId
required
string
tenantId
required
string

Tenant ID

Request Body schema: application/json
model
string [ 0 .. 64 ] characters
object (SimSettings)

Sim Setting Embeddable Domain Object

object (SimSettings)

Sim Setting Embeddable Domain Object

wanConnection
required
string
Enum: "ETH_WITH_CELLULAR_FAILOVER" "CELLULAR_WITH_ETH_FAILOVER" "ETH" "CELLULAR"
primaryWanRecoveryTimer
required
integer <int32> [ 10 .. 300 ]

Responses

Request samples

Content type
application/json
{
  • "model": "string",
  • "primarySim": {
    },
  • "secondarySim": {
    },
  • "wanConnection": "ETH_WITH_CELLULAR_FAILOVER",
  • "primaryWanRecoveryTimer": 10
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Recovery

Manage the recovery PSK.

Get Available LTE Bands

Get available LTE bands for each regions

path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Recovery PSK

Get the PSK for the recovery network.

path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "psk": "string",
  • "tenantId": "string",
  • "obsolete": false
}

Update Recovery PSK

Update the PSK for the recovery network.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
psk
string^([0-9]{4}){4}$
obsolete
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "psk": "string",
  • "obsolete": false
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

DHCP Service-Profile

Manage DHCP service-profiles.

Get DHCP Service-Profiles

Get list of DHCP service-profiles.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
excludeDefault
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create DHCP Service-Profile

Create a new DHCP service-profile.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array of objects (IdAndName)
name
required
string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$
vlanId
required
integer <int32> [ 1 .. 4094 ]
subnetAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
subnetMask
required
string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...
startIpAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
endIpAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
primaryDnsIp
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
secondaryDnsIp
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
leaseTimeHours
required
integer <int32> [ 0 .. 24 ]
leaseTimeMinutes
required
integer <int32> [ 0 .. 59 ]

Responses

Request samples

Content type
application/json
{
  • "venues": [
    ],
  • "name": "string",
  • "vlanId": 1,
  • "subnetAddress": "string",
  • "subnetMask": "string",
  • "startIpAddress": "string",
  • "endIpAddress": "string",
  • "primaryDnsIp": "string",
  • "secondaryDnsIp": "string",
  • "leaseTimeHours": 0,
  • "leaseTimeMinutes": 0
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk DHCP Service-Profiles

Delete a list of DHCP service-profiles.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get DHCP Service-Profile

Get the DHCP service-profile details.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "venues": [
    ],
  • "name": "string",
  • "vlanId": 1,
  • "subnetAddress": "string",
  • "subnetMask": "string",
  • "startIpAddress": "string",
  • "endIpAddress": "string",
  • "primaryDnsIp": "string",
  • "secondaryDnsIp": "string",
  • "leaseTimeHours": 0,
  • "leaseTimeMinutes": 0,
  • "id": "string"
}

Update DHCP Service Profile

Update a DHCP service-profile.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
Array of objects (IdAndName)
name
required
string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$
vlanId
required
integer <int32> [ 1 .. 4094 ]
subnetAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
subnetMask
required
string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...
startIpAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
endIpAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
primaryDnsIp
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
secondaryDnsIp
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
leaseTimeHours
required
integer <int32> [ 0 .. 24 ]
leaseTimeMinutes
required
integer <int32> [ 0 .. 59 ]

Responses

Request samples

Content type
application/json
{
  • "venues": [
    ],
  • "name": "string",
  • "vlanId": 1,
  • "subnetAddress": "string",
  • "subnetMask": "string",
  • "startIpAddress": "string",
  • "endIpAddress": "string",
  • "primaryDnsIp": "string",
  • "secondaryDnsIp": "string",
  • "leaseTimeHours": 0,
  • "leaseTimeMinutes": 0
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete DHCP Service-Profile

Delete a DHCP service-profile.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Venue DHCP Service Profiles

Get a venue's DHCP service profiles.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DhcpServiceProfileVenue

Manage DHCP service-profile assignments to venues.

Update DHCP Service-Profile Venue Bindings

Update the DHCP service profiles bound to a venue.

path Parameters
venueId
required
string

Venue ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Get DHCP Service-Profile Venue Bindings

Get the list of venues using a DHCP service profile.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bind DHCP Service-Profile Venues

Bind a DHCP service profile to a list of venues.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Unbind DHCP Service-Profile Venues

Unbind a DHCP service profile from a list of venues.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Bind Venue DHCP Service-Profile

Bind a DHCP service profile to a venue.

path Parameters
venueId
required
string

Venue ID

dhcpServiceProfileId
required
string

DHCP Service-Profile ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Unbind Venue DHCP Service-Profile

Unbind a DHCP service profile from a venue.

path Parameters
venueId
required
string

Venue ID

dhcpServiceProfileId
required
string

DHCP Service-Profile ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

L2AclPolicy

Manage layer-2 ACL (Access Control List) policies.

Get Layer-2 ACL Policy

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "access": "AccessEnum.BLOCK",
  • "macAddresses": [
    ],
  • "id": "string"
}

Update Layer-2 ACL Policy

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
name
required
string [ 2 .. 32 ] characters
description
string
access
string
Default: "AccessEnum.BLOCK"
Enum: "ALLOW" "BLOCK"
macAddresses
Array of strings [ 1 .. 128 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "access": "AccessEnum.BLOCK",
  • "macAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Layer-2 ACL Policy

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get All Layer-2 ACL Policies

path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Layer-2 ACL Policy

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
name
required
string [ 2 .. 32 ] characters
description
string
access
string
Default: "AccessEnum.BLOCK"
Enum: "ALLOW" "BLOCK"
macAddresses
Array of strings [ 1 .. 128 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "access": "AccessEnum.BLOCK",
  • "macAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk Layer-2 ACL Policies

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Layer-2 ACL Policy By Query

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
sortField
string
sortOrder
string
Enum: "ASC" "DESC"
searchTargetFields
Array of strings
searchString
string

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "sortField": "string",
  • "sortOrder": "ASC",
  • "searchTargetFields": [
    ],
  • "searchString": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "totalCount": 0,
  • "totalPages": 0,
  • "page": 0
}

L3AclPolicy

Manage layer-3 ACL (Access Control List) policies.

Get All Layer-3 ACL Policies

path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Layer-3 ACL Policy

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
name
required
string [ 2 .. 32 ] characters
description
string
defaultAccess
string
Default: "AccessEnum.ALLOW"
Enum: "ALLOW" "BLOCK"
Array of objects (L3Rule) [ 1 .. 128 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "defaultAccess": "AccessEnum.ALLOW",
  • "l3Rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk Layer-3 ACL Policies

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Layer-3 ACL Policy

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "defaultAccess": "AccessEnum.ALLOW",
  • "l3Rules": [
    ],
  • "id": "string"
}

Update Layer-3 ACL Policy

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
name
required
string [ 2 .. 32 ] characters
description
string
defaultAccess
string
Default: "AccessEnum.ALLOW"
Enum: "ALLOW" "BLOCK"
Array of objects (L3Rule) [ 1 .. 128 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "defaultAccess": "AccessEnum.ALLOW",
  • "l3Rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Layer-3 ACL Policy

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Layer-3 ACL Policy By Query

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
sortField
string
sortOrder
string
Enum: "ASC" "DESC"
searchTargetFields
Array of strings
searchString
string

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "sortField": "string",
  • "sortOrder": "ASC",
  • "searchTargetFields": [
    ],
  • "searchString": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "totalCount": 0,
  • "totalPages": 0,
  • "page": 0
}

Device-Policy

Manage device policies.

Get All Device Policies

path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Device-Policy

Create a new device-policy.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
name
required
string [ 2 .. 32 ] characters
description
string [ 2 .. 180 ] characters
defaultAccess
string
Default: "AccessEnum.ALLOW"
Enum: "ALLOW" "BLOCK"
Array of objects (DevicePolicyRule) [ 1 .. 32 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "defaultAccess": "AccessEnum.ALLOW",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk Device-Policies

Delete a list of device-policies.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Device-Policies

Get the device-policy list.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
sortField
string
sortOrder
string
Enum: "ASC" "DESC"
searchTargetFields
Array of strings
searchString
string

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "sortField": "string",
  • "sortOrder": "ASC",
  • "searchTargetFields": [
    ],
  • "searchString": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "totalCount": 0,
  • "totalPages": 0,
  • "page": 0
}

Get Device-Policy

Get the device-policy details.

path Parameters
devicePolicyId
required
string

Device-policy ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "description": "string",
  • "defaultAccess": "AccessEnum.ALLOW",
  • "rules": [
    ],
  • "id": "string"
}

Update Device-Policy

Update a device-policy.

path Parameters
devicePolicyId
required
string

Device-policy ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
name
required
string [ 2 .. 32 ] characters
description
string [ 2 .. 180 ] characters
defaultAccess
string
Default: "AccessEnum.ALLOW"
Enum: "ALLOW" "BLOCK"
Array of objects (DevicePolicyRule) [ 1 .. 32 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "defaultAccess": "AccessEnum.ALLOW",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Device-Policy

Delete a device-policy.

path Parameters
devicePolicyId
required
string

Device-policy ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

VlanPool

Manage VLAN pools.

Get Vlan Pool By Query

Use this API command to get the VLAN pool list by query

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
sortField
string
sortOrder
string
Enum: "ASC" "DESC"
searchTargetFields
Array of strings
searchString
string

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "sortField": "string",
  • "sortOrder": "ASC",
  • "searchTargetFields": [
    ],
  • "searchString": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "totalCount": 0,
  • "totalPages": 0,
  • "page": 0
}

Get Vlan Pool

Use this API command to get the VLAN pool details.

path Parameters
vlanPoolId
required
string

VLAN Pool ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "description": "string",
  • "vlanMembers": [
    ],
  • "id": "string"
}

Update Vlan Pool

Use this API command to update a VLAN pool

path Parameters
vlanPoolId
required
string

VLAN Pool ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
name
required
string [ 1 .. 32 ] characters
description
string [ 0 .. 64 ] characters
vlanMembers
required
Array of strings [ 0 .. 16 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "vlanMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Vlan Pool

Use this API command to delete a VLAN pool

path Parameters
vlanPoolId
required
string

VLAN Pool ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Vlan Pools

Use this API command to get the VLAN pool list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Vlan Pool

Use this API command to create a new VLAN pool

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
name
required
string [ 1 .. 32 ] characters
description
string [ 0 .. 64 ] characters
vlanMembers
required
Array of strings [ 0 .. 16 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "vlanMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Vlan Pools

Use this API command to delete a VLAN pool list

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Wi-Fi Calling

Manage Wi-Fi Calling profiles.

Get Wi-Fi Calling Profiles

Get the Wi-Fi Calling profiles.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Wi-Fi Calling Profile

Create a new Wi-Fi Calling profile.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
profileName
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
description
string [ 2 .. 180 ] characters
qosPriority
string
Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE"
Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"
required
Array of objects (Epdg) [ 1 .. 5 ] items

Responses

Request samples

Content type
application/json
{
  • "profileName": "string",
  • "description": "string",
  • "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
  • "ePDGs": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Bulk Wi-Fi Calling Profiles

Delete a list of Wi-Fi Calling profiles.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Get Wi-Fi Calling Profile

Get the Wi-Fi Calling profile details.

path Parameters
wifiCallingProfileId
required
string

Wi-Fi calling profile ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "profileName": "string",
  • "description": "string",
  • "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
  • "id": "string",
  • "ePDGs": [
    ]
}

Update Wi-Fi Calling Profile

Update a Wi-Fi Calling profile.

path Parameters
wifiCallingProfileId
required
string

Wi-Fi calling profile ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
profileName
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
description
string [ 2 .. 180 ] characters
qosPriority
string
Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE"
Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"
required
Array of objects (Epdg) [ 1 .. 5 ] items

Responses

Request samples

Content type
application/json
{
  • "profileName": "string",
  • "description": "string",
  • "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
  • "ePDGs": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Wi-Fi Calling Profile

Delete a Wi-Fi Calling profile.

path Parameters
wifiCallingProfileId
required
string

Wi-Fi calling profile ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

vSPoT

Manage vSPoT (virtualized Smart Positioning Technology) servers.

Get Vspots

Get the vSPoT server details.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create vSPoT

Create a new vSPoT server.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array of objects (IdAndName)
serverName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
vspotGlobalId
string
serverAddress
required
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...
port
integer <int32> [ 1 .. 65535 ]
Default: 8883
password
required
string [ 8 .. 63 ] characters ^(?!(`|\$))[!-~]{8,63}$

Responses

Request samples

Content type
application/json
{
  • "venues": [
    ],
  • "serverName": "string",
  • "vspotGlobalId": "string",
  • "serverAddress": "string",
  • "port": 8883,
  • "password": "stringst"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get vSPoTs

Get the vSPoT server list.

path Parameters
vspotId
required
string

vSPoT ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "venues": [
    ],
  • "serverName": "string",
  • "vspotGlobalId": "string",
  • "serverAddress": "string",
  • "port": 8883,
  • "password": "stringst",
  • "id": "string"
}

Update vSPoT

Update a vSPoT server.

path Parameters
vspotId
required
string

vSPoT ID

tenantId
required
string

Tenant ID

Request Body schema: application/json
Array of objects (IdAndName)
serverName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
vspotGlobalId
string
serverAddress
required
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...
port
integer <int32> [ 1 .. 65535 ]
Default: 8883
password
required
string [ 8 .. 63 ] characters ^(?!(`|\$))[!-~]{8,63}$

Responses

Request samples

Content type
application/json
{
  • "venues": [
    ],
  • "serverName": "string",
  • "vspotGlobalId": "string",
  • "serverAddress": "string",
  • "port": 8883,
  • "password": "stringst"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete vSPoT

Delete a vSPoT server.

path Parameters
vspotId
required
string

vSPoT ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": { }
}

Client-Disconnect

Disconnect clients (i.e., end-user devices).

Disconnect Clients

Disconnect a list of clients.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json
Array ()
clientMac
required
string
apMac
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "errors": [
    ],
  • "downloadUrl": "string"
}

Guest-user

Manage Guest-users.

Get Guest-user List

path Parameters
tenantId
required
string

tenantId

query Parameters
page
string
Default: "1"

page

size
string
Default: "50"

size

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "totalElements": 0
}

Add Guest-users

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

guestsPayload

Array ()
deliveryMethods
required
Array of strings
Items Enum: "MAIL" "SMS" "STUB" "PRINT"

At least one

disabled
boolean
email
string
required
object (GuestUserExpiration)
maxDevices
required
integer <int32>

Maximum number of devices on which the guest pass can be used simultaneously. Set to -1 for unlimited number of devices.

mobilePhoneNumber
required
string
name
required
string
networkId
required
string

The network that the guest can connected to

notes
string [ 0 .. 180 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": "string"
}

Delete Guest-users

path Parameters
tenantId
required
string

tenantId

Request Body schema: */*

ids

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Import Guest-users

path Parameters
tenantId
required
string

tenantId

query Parameters
deliveryMethods
Array of strings
Items Enum: "MAIL" "SMS" "STUB" "PRINT"

deliveryMethods

expiration.activationType
required
string
Enum: "Creation" "Login"

expiration.activationType

expiration.duration
required
integer <int32> [ 1 .. 8760 ]

expiration.duration

expiration.unit
required
string
Enum: "Minute" "Hour" "Day" "Week" "Month" "Year" "Never"

expiration.unit

maxDevices
required
integer <int32>

maxDevices

networkId
required
string

networkId

Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Guest-user by ID

path Parameters
guestUserId
required
string

guestUserId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "createdDate": 0,
  • "deliveryMethods": [
    ],
  • "disabled": false,
  • "email": "string",
  • "expiration": {
    },
  • "expirationDate": 0,
  • "guestUserType": "GuestPass",
  • "id": "string",
  • "lastModified": 0,
  • "macAddresses": [
    ],
  • "maxDevices": 3,
  • "mobilePhoneNumber": "string",
  • "name": "string",
  • "networkId": "string",
  • "notes": "string",
  • "password": "string",
  • "ssid": "string"
}

Delete Guest-user by ID

path Parameters
guestUserId
required
string

guestUserId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Disable Guest-user

path Parameters
guestUserId
required
string

guestUserId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Enable Guest-user

path Parameters
guestUserId
required
string

guestUserId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Regenerate Guest-user Credential

path Parameters
guestUserId
required
string

guestUserId

tenantId
required
string

tenantId

Request Body schema: application/json

deliveryMethods

Array ()
string
Enum: "MAIL" "SMS" "STUB" "PRINT"

Responses

Request samples

Content type
application/json
[
  • "MAIL"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

View

View WiFi information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Clients

Get client (i.e., end-user devices) parameters and operational data.

path Parameters
tenantId
required
string

tenantId

query Parameters
apSerialNumber
string

apSerialNumber

page
string

page

size
string

size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Client by MAC

Get extended set of parameters and operational data for the client having this MAC address.

path Parameters
mac
required
string

mac

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "apMac": "string",
  • "apName": "string",
  • "apSerialNumber": "string",
  • "bssid": "string",
  • "connectedSince": "string",
  • "hostname": "string",
  • "ip": "string",
  • "mac": "string",
  • "networkId": "string",
  • "noiseFloor_dBm": 0,
  • "osType": "string",
  • "radioChannel": 0,
  • "receiveSignalStrength_dBm": 0,
  • "rxBytes": 0,
  • "rxPackets": 0,
  • "snr_dB": 0,
  • "ssid": "string",
  • "switchMac": "string",
  • "switchName": "string",
  • "switchSerialNumber": "string",
  • "txBytes": 0,
  • "txDropDataPacket": 0,
  • "txPackets": 0,
  • "username": "string",
  • "venueId": "string",
  • "venueName": "string",
  • "vlan": 0
}

Get Venue AP Models

Get the AP models deployed in this venue.

path Parameters
tenant_id
required
string

Tenant ID

venue_id
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "models": [
    ]
}

Get APs

Get parameters and operational data for a list of APs.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

fields
Array of strings
object
Array of objects (MatchFieldDto)
multiSortFields
Array of strings
Array of objects (MustNotMatchFieldDto)
page
integer <int32>
object (EntryOfstringAndstring)
pageSize
integer <int32>
object (RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
object (TermFieldDto)

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "filters": {
    },
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [
    ],
  • "totalCount": 0
}

Get Mesh APs

Get parameters and operational data for a list of mesh APs.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

fields
Array of strings
object
Array of objects (MatchFieldDto)
multiSortFields
Array of strings
Array of objects (MustNotMatchFieldDto)
page
integer <int32>
object (EntryOfstringAndstring)
pageSize
integer <int32>
object (RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
object (TermFieldDto)

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "filters": {
    },
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [
    ],
  • "totalCount": 0
}