logo

OmniVista Cirrus Developer API Reference (10.5.1)

Alcatel-Lucent Enterprise: ALE.WelcomeCenter@al-enterprise.com URL: https://manage.ovcirrus.com License: ALE Terms of Service

Introduction

Preamble

Introduction

This guide describes list of API services that are provided by OmniVista Cirrus portal system.

Protocol

REST interface is used for sending/receiving API messages. HTTP requests (GET/POST/PATCH/PUT/DELETE) are used with standard responses for data or error status. OmniVista Cirrus operates in a stateless model, with no session management, allowing independent requests.. JSON is used as a main format for data encoding in message body part. Each request is started with the following pattern /api/{version}/{resource} where {version} is the API version number and {resource} is the name of the resource object to address.

Security considerations

Each request must include credential information for authentication, using standard HTTP basic/bearer authentication and JSON Web Token (JWT). JWTs have an expiration controlled by OmniVista Cirrus. Application tokens are also used and provided in the HTTP Authorization header. The server verifies the token and responds with a 403 Not Allowed if invalid. TLS is used for secure communication between OmniVista Cirrus and the application.

Special Character Encoding

The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the following "ASCII Encoding Reference" table before putting them into the URL path. Examples:

 => The value of the query parameter "name" is encoded from the string "Name 01".

 => The value of the query parameter "name" is encoded from the string "@Name#02".

Character Encoded
space %20
# %23
? %3F
& %26
+ %2B
, %2C
. %2E
: %3A
; %3B
= %3D
$ %24
@ %40
! %21
~ %7E
{ %7B
} %7D
[ %5B
] %5D
( %28
) %29
' %27
" %22
` %60
^ %5E
| %7C
< %3C
> %3E
\ %5C
/ %2F

User

Get user's authentication policy

Check if user is required to update account security (Two-factor Authenticator or password) .

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get user's profile

Get user's profile for the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update user's profile

Update user's profile for the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
firstname
string

Firstname of the user.

lastname
string

Lastname of the user.

country
string

Country address of the user.

lastLoginDate
string

Last login date of the user (in ISO 8601 format).

verified
boolean

Indicates if the user account has been verified by the user.

companyName
string

Company Name of the user.

closestRegion
string

Country address of the company.

address
string

Address of the company.

zipCode
string

Zip code of the company.

city
string

City of the company.

phoneNumber
string

Phone number of the user.

email
string

Email address of the user.

preferredLanguage
string

Preferred language of the user.

isTwoFAEnabled
boolean

Indicate if Two factor authentication is activated.

faMethod
string
Enum: "EMAIL" "GOOGLE_AUTHENTICATOR"

Two factor authentication method.

isSuperAdmin
boolean

Indicate if the user is a super admin user.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get user's msp level permission

Get permission for an unique MSP of the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all msp permissions.

Response samples

Content type
application/json
{
}

Get user's organization level permission

Get permission for the organizations of the user. The user doesn't have acces to the not included organizations

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all organization permissions.

Response samples

Content type
application/json
{
}

Get user's site level permission

Get permission for the sites of the user. The user doesn't have acces to the not included sites

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all site permissions.

Response samples

Content type
application/json
{
}

Device

Get all devices

Fetch all devices declared in one site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all devices.

Response samples

Content type
application/json
{
}

Create a device

Register a new device in a given organization, site, building and floor.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The user-configured device name.

ipAddress
string

The IP v4 address of the device.

ipAddressV6
string

The IP v6 address of the device.

macAddress
string

The MAC address of the device.

serialNumber
required
string

The serial number of the device.

type
string

The type of the device.

version
string

The version of the device.

deviceLocationLldp
boolean

The option to get device location from LLDP or not if the device is a Stellar AP.

physicalLocation
string

The physical location of the device, with a maximum of 50 characters allowed.

description
string

The description of the device.

geoLocation
string

The geoLocation of the device.

systemContact
string

The systemContact of the device.

location
object

The location of the device.

floorElevation
string

The floorElevation of the device.

groupId
string

The group of the device.

deviceFamily
string
Enum: "AP" "AOS"

The family name of the device (default value is AP).

provisioningTemplate
string

The Initial Provisioning template if the device is a Switch.

valueMappingTemplate
string

The Value Mapping of Provisioning template if the device is a Switch.

mgmtUsersTemplate
string

The Management User Template if the device is a Switch.

saveAndCertify
boolean

The option allows to save configuration of the Running directory and copy to Certify.

deviceLabelIds
Array of strings

The ID array of Device Labels will be attached to the device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create a remote AP.

Create a remote AP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumber
required
string

The serial number of the device.

description
string

The description of the device.

vpnSettingName
required
string

The name of the VPN setting that will be applied for the remote AP.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Mass import devices

Mass import devices (if MAC Address of the device exists then this device is updated otherwise it's created).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of devices to be created.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update multiple devices group

Update multiple devices group (site, group).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
siteId
required
string

The updated site identifier.

groupId
required
string

The updated group identifier.

devicesIds
required
Array of strings

The array of unique identifiers of updated devices

serialNumber
string

The serial number of the device. It is required when the length of 'devicesIds' is 1, other cases are forbidden.

rfProfile
required
string

The name of RF Profile. It is required when the length of 'devicesIds' is 1, other cases are forbidden.

deviceCountryCode
string

The country code of the device. It is required when the length of 'devicesIds' is 1, other cases are forbidden.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing all the updated devices .

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update multiple devices location

Update multiple devices location (site, building, floor).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
buildingId
string

The updated building identifier.

floorId
string

The updated floor identifier.

siteId
required
string

The updated site identifier.

devicesIds
required
Array of strings

The array of unique identifiers of updated devices

groupId
string

The updated group identifier. It is required when the devices are Stellar AP(s). For the Switch devices, it is forbidden.

rfProfile
string

The name of the RF Profile is required if the device is a Stellar AP. It is mandatory when the 'groupId' is valid, and the length of 'devicesIds' is 1; otherwise, it is forbidden.

deviceCountryCode
string

The device country code is required if the device is a Stellar AP. It is mandatory when the 'groupId' is valid, and the length of 'devicesIds' is 1; otherwise, it is forbidden.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing all the updated devices.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Upload files for OVAgent

Upload files for OVAgent.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data; boundary=

Request Body schema: multipart/form-data
required
object

OVAgent request containing form data for uploading configuration file

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array associated to the response.

Response samples

Content type
application/json
{
}

Upload package zip file for OVAgent

Upload package zip file for OVAgent.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data; boundary=

Request Body schema: multipart/form-data
required
object

OVAgent request containing form data for uploading agent package

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array associated to the response.

Response samples

Content type
application/json
{
}

Get all devices from organization

Fetch all devices from organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all devices of one organization

Response samples

Content type
application/json
{
}

Get a device

Fetch one device identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the device.

Response samples

Content type
application/json
{
}

Get all details device

Fetch all details of device identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the device.

Response samples

Content type
application/json
{
}

Update a device

Update one device identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The user-configured device name.

ipAddress
string

The IP v4 address of the device.

ipAddressV6
string

The IP v6 address of the device.

macAddress
string

The MAC address of the device.

serialNumber
required
string

The serial number of the device.

type
string

The type of the device.

version
string

The version of the device.

deviceLocationLldp
boolean

The option to get device location from LLDP or not if the device is a Stellar AP.

physicalLocation
string

The physical location of the device, with a maximum of 50 characters allowed.

description
string

The description of the device.

geoLocation
string

The geoLocation of the device.

systemContact
string

The systemContact of the device.

location
object

The location of the device.

floorElevation
string

The floorElevation of the device.

groupId
string

The group of the device.

deviceFamily
string
Enum: "AP" "AOS"

The family name of the device (default value is AP).

provisioningTemplate
string

The Initial Provisioning template if the device is a Switch.

valueMappingTemplate
string

The Value Mapping of Provisioning template if the device is a Switch.

mgmtUsersTemplate
string

The Management User Template if the device is a Switch.

saveAndCertify
boolean

The option allows to save configuration of the Running directory and copy to Certify.

deviceLabelIds
Array of strings

The ID array of Device Labels will be attached to the device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated device.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a device

Delete a device identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted device.

Response samples

Content type
application/json
{
}

Update a remote AP.

Update a remote AP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumber
required
string

The serial number of the device.

description
string

The description of the device.

vpnSettingName
required
string

The name of the VPN setting that will be applied for the remote AP.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update LED Mode

Update LED mode for multiple devices

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
devicesIds
required
Array of strings

The array of unique identifiers of devices.

object
object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Ping Device

Ping one device identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Radio Configuration

Update radio configuration on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reset Action

Reset action on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
devicesIds
required
Array of strings

The array of unique identifiers of updated devices

object
object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update IOT Radio Config

Update iot radio config of one device identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated device.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Save to Running

Save to running action on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
devicesIds
required
Array of strings

The array of unique identifiers of updated devices

object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reboot

Reboot action on the device catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Copy Working/Running To Certified

Copy Working/Running To Certified action on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceMacAddresses
required
Array of strings

The array of MAC Addresses of the switches.

meta
object

The JSON metadata of the Copy Working/Running To Certified Action.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Copy Certified To Working/Running

Copy Certified To Working/Running action on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceMacAddresses
required
Array of strings

The array of MAC Addresses of the switches.

meta
object

The JSON metadata of the Copy Certified To Working/Running Action.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Rediscover

Rediscover the devices on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceMacAddresses
required
Array of strings

The array of MAC Addresses of the switches.

meta
object

The JSON metadata of the Rediscover Action.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update IP mode

Update ip mode of one device identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update multiple location device

This API allows the update of multiple location devices.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects of the updated device(s).

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get wired ports for each device.

Get wired ports for each device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string
Enum: "org" "site" "building" "floor" "device_sn"

The scope that we want to get the resources from.

scopeId
required
Array of strings

The scopeId is an array of IDs corresponding to the selected scopes.

offset
required
integer <int32>

The start position of the records to fetch over the total number of records (Ex: 0). The offset value must be a non-negative integer.

limit
required
integer <int32>

The number of records to fetch from the total records (Ex: 10). Send the value -1 if you want to get all records that match the current filter/sort/search options.

object

The filters are applied to filter the value(s) of the specific object field(s) in the record. For example: "filters": { "portDesc": [{"condition": "ENDS_WITH","value": "SIS"},{ "joinOper": "OR", "condition": "NOT_EQUAL", "value": "SINGLE_dMARK"}]}

Array of objects

The array of sort order for each field of object in the record. For example: "sort": [{"portNumber": "DESC"}, {"portType": "ASC"}]

search
string

The search string is applied to filter all the fields in the object. The fields supported for searching are ["portNumber", "portDesc", "portType", "ifAlias", "specificType", "portPropsAsString", "unpName", "defaultVlan"].

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update wired ports for each device.

Update wired ports for each device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

The array of devices needs updated wired ports.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get multiple devices health thresholds.

Get multiple health thresholds of devices by their serial number.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumbers
Array of strings

The array of serial numbers of devices, default value is empty

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The list of AP health threshold by serial number.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update multiple devices health thresholds config with the same configuration.

Update multiple health thresholds config on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update multiple devices health thresholds config with the specified configuration.

Update multiple health thresholds config on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update multiple devices qoe&rtls status

Update multiple qoe&rtls status on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Qoe&Rtl value in device

Fetch Qoe&Rtls value following macAddress.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The objects data which updated in device(s).

Response samples

Content type
application/json
{
}

Get unsupported scale-up SSID devices

Get unsupported scale-up SSID devices from a group.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of unsupported scale-up SSID devices.

Response samples

Content type
application/json
{
}

Update multiple IOT status

Update multiple IOT status on devices catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects of the updated device(s).

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update device location

Update a device location

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
buildingId
string

The updated building identifier.

floorId
string

The updated floor identifier.

siteId
string

The updated site identifier.

object

The device map coordinates, in geojson format. Must contain the latitude and longitude of the device location. Check response samples for expected format.

floorElevation
string

The updated floor elevations

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated device.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete device location

Delete a device location

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted device location.

Response samples

Content type
application/json
{
}

Delete multiple devices

Delete mutiple devices identified by there ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of devices.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object of the deleted devices ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Mesh Configuration

Update Mesh Configuration of one device identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Mesh Network Configuration

Update Mesh Configurations of all devices.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
root_mac
required
string

The MAC address of the root device in mesh.

band
required
string

The band of the mesh network (2.4G/5G/6G). Select (6G) only if applicable for the AP model and country.

encryptionType
required
string
Enum: "BothWpaWpa2" "Wpa2Personal" "BothWpa2Wpa3" "Wpa3Personal"

The type of encryption to use for the connection between mesh/bridge APs. Default value of encryption type for 2.4G/5G is Wpa2Personal and Default value of encryption type for 6G is Wpa3Personal

ssid
required
string

The ssid of the mesh network.

passphrase
required
string

The passphrase of the mesh network.

repeaters
required
Array of strings

The array of MAC Addresses of the connected devices.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Status of device OVNG agent for single switch

Retrieve the status of the device OVNG Agent .

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumber
required
string

The serial number of the device.

agentType
required
string
Enum: "ALL" "CONFIG" "MONITORING"

Agent Type must be one of [ALL, CONFIG, MONITORING].

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Status of device OVNG agent for multiple switches

Retrieve the status of the device OVNG Agent for multiple switches.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

An array of multiple devices for ovng agent status.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Restart of device OVNG agent for single switch

Retrieve the status of the device OVNG Agent .

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumber
required
string

The serial number of the device.

agentType
required
string
Enum: "ALL" "CONFIG" "MONITORING"

Agent Type must be one of [ALL, CONFIG, MONITORING].

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Restart of device OVNG agent for multiple switches

Retrieve the status of the device OVNG Agent.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

An array of multiple devices for ovng agent restart.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Device counter based on stats

Count all devices based on field changes

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

Array of objects

A list of statistics.

Response samples

Content type
application/json
{
}

Get all of devices with naas licenses from organization.

Get all of devices with naas licenses from organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all devices of one organization

Response samples

Content type
application/json
{
}

Get all of devices with naas licenses from site.

Get all of devices with naas licenses from site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all devices of one organization

Response samples

Content type
application/json
{
}

Mass import remote aps

Mass import remote aps (if remote ap exists then this device is updated otherwise it's created).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of remote APs to be created.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Goldenconfig

Enable audit configuration for devices

Enable audit configuration for multiple devices

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumbers
required
Array of strings

The array of Master serial number if the device is in VC. Unless, it is the serial number of the device

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Disable audit configuration for devices

Disable audit configuration for multiple devices

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumbers
required
Array of strings

The array of Master serial number if the device is in VC. Unless, it is the serial number of the device

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Mark Golden Configuration for devices

Mark Golden configuration and schedule Audit of multiples switches

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumbers
required
Array of strings

The array of Master serial number if the device is in VC. Unless, it is the serial number of the device

isSaveConfig
required
boolean

Flag to save the running configuration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete audit configuration for devices

Delete audit configuration for multiple devices

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumbers
required
Array of strings

The array of Master serial number if the device is in VC. Unless, it is the serial number of the device

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (207)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the golden configuration of a device

Get the golden configuration of a device identified by its serial number.

query Parameters
serialNumber
required
string

The Master Serial Number of device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get all devices with configuration

Get all devices in the scope with configuration profile in organization.

query Parameters
scope
required
string

"scope" is the target: org, site, switch_sn.

scopeId[]
required
string

Array of id corresponding to the selected scope. If the switch is in a VC, it should be the serial number of the Master in switch's VC.

limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Request Instant Audit Configuration for devices

Request an instant audit of multiples switches

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumbers
required
Array of strings

The array of Master serial number if the device is in VC. Unless, it is the serial number of the device

isSaveConfig
required
boolean

Flag to save the running configuration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Topology

Get Topology configuration

Get all the topology configuration for a given site identified by its id.

query Parameters
scope
required
string

"scope" is the target: site, building, floor, mac or serial_number.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of topology configuration.

Response samples

Content type
application/json
{
}

Applicationvisibility

Get all Signature Profiles

Get all signature profiles within a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON object containing the signature profile information.

Response samples

Content type
application/json
{
}

Create Signature Profile

Create a new signature profile.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
apGroups
Array of strings

The list of AP groups assigned for the signature profile.

object

The application groups and applications assigned for the signature profile.

description
string

The description of the signature profile.

orgId
required
string

Unique organization identifier.

profileName
required
string

The name of the signature profile.

version
required
string

The selected kit version of the signature profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

A JSON object containing the newly created signature profile information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete All Signature Profiles

Delete all signature profiles within a given organization.

query Parameters
ids
required
Array of arrays

"ids" is an array of ids corresponding to the signature profiles.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing signature profile names.

Response samples

Content type
application/json
{
}

Get Category list with Applications

Get the list of categories with applications for given kit version.

query Parameters
kitVersion
required
integer

The version of the signature kit.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the application groups and applications.

Response samples

Content type
application/json
{
}

Create Custom Category

Create a custom category for the kit.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
appGroup
required
string

The name of the custom application group.

required
Array of objects

The list of the applications. Either application group or application must be present.

description
string

The description of the signature profile.

orgId
required
string

Unique organization identifier.

kitVersion
required
string

The version of the signature kit.

signatureKit
required
string

The name of the signature kit.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

A JSON object containing the newly created custom category information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Custom Category by name

Get the custom category by its name.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the custom category information.

Response samples

Content type
application/json
{
}

Update Custom Category by name

Update the custom category by its name.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
appGroup
required
string

The name of the custom application group.

required
Array of objects

The list of the applications. Either application group or application must be present.

description
string

The description of the signature profile.

orgId
required
string

Unique organization identifier.

kitVersion
required
string

The version of the signature kit.

signatureKit
required
string

The name of the signature kit.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the updated custom category information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Retry device configuration

Reapply the device configuration.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

The device information to retry configuration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON object containing the device information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Status of the device

Get the latest status of the device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON object containing the device information.

Response samples

Content type
application/json
{
}

Get Signature Profile by ID

Get the signature profile by its ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the signature profile information.

Response samples

Content type
application/json
{
}

Update Signature Profile by ID

Update the signature profile by its ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
apGroups
Array of strings

The list of AP groups assigned for the signature profile.

object

The application groups and applications assigned for the signature profile.

description
string

The description of the signature profile.

orgId
required
string

Unique organization identifier.

profileName
required
string

The name of the signature profile.

version
required
string

The selected kit version of the signature profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the updated signature profile information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Signature Profile by ID

Delete the signature profile by its ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing signature profile names.

Response samples

Content type
application/json
{
}

Get Categories

Fetch categories based on applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

topN
required
string

"topN" is the number of top categories to be fetched.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array containing the list of top categories.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Applications

Fetch applications based on applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

topN
required
string

"topN" is the number of top categories to be fetched.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array containing the list of top applications.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Applications List

Fetch application list based on applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the application list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Top Users per Application

Fetch top users per application based on the applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

topN
required
string

"topN" is the number of top categories to be fetched.

application
string

"application" is the application name.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array containing the list of top users.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get User List

Fetch user list based on the applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the user list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Top Applications per User

Fetch top applications per user based on the applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

topN
required
string

"topN" is the number of top categories to be fetched.

user
string

"user" is the IP address of the user.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array containing the list of top applications.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Categories detailed information

Fetch categories detailed information based on the applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

categoryList
Array of strings

"categoryList" is an array of category name. Ex: ["category1", "category2"]

others
boolean

'others' is a boolean value to fetch other categories information. Ex others: true then it will fetch categories info apart from the categories in categoryList.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing top categories info.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Applications detailed information

Fetch applications detailed information based on the applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

applicationList
Array of strings

"applicationList" is an array of application name. Ex: ["application1", "application2"]

others
boolean

'others' is a boolean value to fetch other applications information. Ex others: true then it will fetch applications info apart from the applications in applicationList.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing top applications info.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Top Users per Application detailed information

Fetch top users per application detailed information based on the applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

topN
required
string

"topN" is the number of top categories to be fetched.

application
string

"application" is the application name.

user
string

"user" is the IP address of the user.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing top users info.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Top Applications per User detailed information

Fetch top Applications per user detailed information based on the applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

topN
required
string

"topN" is the number of top categories to be fetched.

user
string

"user" is the IP address of the user.

application
string

"application" is the application name.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing top applications info.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Bandwidth Utilization

Fetch bandwidth utilization based on the applied filters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

orgId
required
string

Unique organization identifier.

devices
Array of strings

"devices" is an array of devices MAC Address. Ex: ["DC:08:56:AE:20:E0", "DC:08:56:36:07:C0"]

profiles
Array of strings

"profiles" is an array of Signature Profile name. Ex: ["profile1", "profile2"]

period
required
string

"period" is the time period of the bandwidth usage that will be grouped, ex: None, 5 minutes, 15 minutes, 1 hour, 24 hour.

object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An JSON object containing the list of bandwidth usage info.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Discoverymanagerentries

Get the Discovery Manager Entry(s)

Get the Discovery Manager Entry(s) of devices.

query Parameters
macAddresses
string

The list of Mac Addresses. Example macAddresses=DC:08:56:54:24:E1,DC:08:56:54:24:E3

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing a description of Discovery Manager Entry.

Response samples

Content type
application/json
{
}

Edit the Discovery Manager Entry

Edit the Discovery Manager Entry on device catalog.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the Updating Discovery Manager Entry.

meta
object

The JSON metadata of the Updating Discovery Manager Entry.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of the updated Discovery Manager Entry data.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Networkconfig

Reset Mesh Configuration

Reset Mesh Configuration of individual AP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
macAddress
required
string

The MAC address of the device.

isRoot
required
boolean

To Configure device as root or repeater.

apModel
required
string

The access point model type.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reset Mesh Network Configuration

Reset Mesh Network Configuration.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
root_mac
required
string

The MAC address of the root device in mesh.

repeaters
required
Array of strings

The array of MAC Addresses of the connected devices.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get clients in the blocklist

Fetch all clients in the blocklist of a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing clients in a blocklist.

Response samples

Content type
application/json
{
}

Add a client to the blocklist.

Add a client to the blocklist.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
clientMac
required
Array of strings

The array of unique MAC Address of client.

agingTime
required
integer <int32>

The amount of time the client will remain on the Blocklist (in hours). The value in range [1..8760]. Once this time expires, the client is removed from the Blocklist and allowed to be associated to the valid network.

reason
string

The reason the client was added to the Blocklist.

object

Data of the selected scope.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing clients in a blocklist.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple clients in the blockist by a list of ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of client.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
Array of arrays

An array of JSON objects containing clients.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a client in the blocklist

Fetch one client in the blocklist identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the client in a blocklist.

Response samples

Content type
application/json
{
}

Update a client in the blocklist

Update one client in the blocklist identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
agingTime
integer <int32>

The amount of time the client will remain on the Blocklist (in hours). The value in range [1..8760]. Once this time expires, the client is removed from the Blocklist and allowed to be associated to the valid network.

reason
string

The reason the client was added to the Blocklist.

object

Data of the selected scope.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the client in a blocklist.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all event configurations

Get all event configurations.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all event configuration data.

Response samples

Content type
application/json
{
}

Create an event configuration

Create an event configuration.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

An event configuration name.

description
string

The description of the event configuration.

orgId
required
string

An id of an organization.

Array of objects

A JSON array containing sites is required only for deviceType 'AP'.

Array of objects

A JSON array containing apGroups is required only for deviceType 'AP'.

Array of objects

A JSON array containing devices.

deviceType
required
string

Device type (AP or AOS 8X).

protocol
string
Enum: "SNMPv2" "SNMPv3"

Protocol option will be available for switch configuration

trapSubscriptionState
boolean

Trap subscription state for switch configuration.

required
Array of objects

A JSON array containing events.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all event configuration data.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple event configurations

Delete multiple event configurations identified by its ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

"ids" is an array of ids corresponding to the multiple event configuration ids.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing event configuration id.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update an event configuration

Update an event configuration within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

An event configuration name.

description
string

The description of the event configuration.

orgId
required
string

An id of an organization.

Array of objects

A JSON array containing sites is required only for deviceType 'AP'.

Array of objects

A JSON array containing apGroups is required only for deviceType 'AP'.

Array of objects

A JSON array containing devices.

deviceType
required
string

Device type (AP or AOS 8X).

protocol
string
Enum: "SNMPv2" "SNMPv3"

Protocol option will be available for switch configuration

trapSubscriptionState
boolean

Trap subscription state for switch configuration.

required
Array of objects

A JSON array containing events.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all event configuration data.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete event configuration by id

Delete event configuration identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing event configuration id.

Response samples

Content type
application/json
{
}

Delete all event configurations

Delete all event configurations.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing all deleted event configuration ids.

Response samples

Content type
application/json
{
}

Get mesh topology

Get the mesh topology of Access Points.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing mesh information of a macAddress.

Response samples

Content type
application/json
{
}

Debugfileserver

Get all user files

Fetch all user files of given organization id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing descriptions of all user files.

Response samples

Content type
application/json
{
}

Move user file

Move user file of given organization id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
subDirectory
required
string

The current path of the file.

fileName
required
string

The name of the file.

destination
required
string

The new path of the file.

forceToOverride
boolean

This attribute helps us to overwrite the file. If we want to override, the value is true. Otherwise, the value is false.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object containing descriptions of moved user file.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete user files

Delete user files of given organization id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
downloadDirectory
required
string

The path of the file.

fileName
required
string

The name of the file.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing descriptions of deleted user files.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Devicemodule

Get all Device Modules

Get all Device Modules by MAC addresses for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
data
Array of strings

The array of MAC addresses to get the modules.

offset
integer <int32>

The start position of the records to fetch over the total number of records (Ex: 0). When the limit is different from -1, this field is required and the value must be a non-negative integer.

limit
required
integer <int32>

The number of records to fetch from the total records (Ex: 10). Send the value -1 if you want to get all records that match the current filter/sort/search options.

object

The filters are applied to filter the value(s) of the specific object field(s) in the record. For example: "filters": {"moduleType": [{"condition": "ENDS_WITH", "value": "SIS"}, {"joinOper": "OR", "condition": "NOT_EQUAL", "value": "SINGLE_dMARK"}], "ubootMinibootVersion": [{"condition": "LESS_THAN", "value": "05"}, {"joinOper": "OR", "condition": "CONTAINS", "value": "77"}]}

Array of objects

The array of sort order for each field of object in the record. For example: "sort": [{"ubootMinibootVersion": "DESC"}, {"moduleType": "ASC"}]

search
string

The search string is applied to filter all the fields in the object. The fields supported for searching are [moduleType, moduleName, description, serialNumber, partNumber, macAddress, osVersion, ubootMinibootVersion, hardwareRevision, manufacturerName, slot].

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Neighborap

Get all Neighbor APs of an AP

Get all Neighbor APs of an AP for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
macAddress
required
string

The MAC address of the AP from which to retrieve the Neighbor APs.

meta
object

The JSON metadata for getting Neighbor APs.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Neighbor APs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Neighbor APs of an AP

Update Neighbor APs of an AP for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
apMac
required
string

The MAC address of the AP from which to update the Neighbor APs.

required
Array of objects

The APs will be added to the Neighbor list of the current AP. Can only add the new Neighbor AP with the type of 'Static'.

required
Array of objects

The APs will be removed from the Neighbor list of the current AP. Only the Neighbor AP with the type of 'Static' can be removed.

meta
object

The JSON metadata for getting Neighbor APs.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Ipinterface

Get all IP addresses of IP Interfaces

Get all IP addresses of IP Interfaces by the MAC address for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
data
string

The MAC address to get the IP addresses of IP interfaces from.

meta
object

The JSON metadata for getting all IP addresses of IP interfaces.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
Array of strings

The array of the IP addresses of IP interfaces belongs to the specific MAC address.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Eventlog

Get all Activation Logs

Get all Activation Logs by the device serial number for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumber
required
string

The serial number of the device to get the Activation Logs from.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of the Activation Logs belongs to the specific device serial number.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Devicelabel

Get all Device Labels

Get all Device Labels within a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Device Label.

Response samples

Content type
application/json
{
}

Create a Device Label

Create a new Device Label within a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the Device Label. The name must be unique within an organization and have a maximum length of 16 characters.

color
required
string

The color of the Device Label. The value of this field must be a hexadecimal color code, for example: #f1f1f4.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Device Label.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update a Device Label

Update a Device Label by ID within a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the Device Label. The name must be unique within an organization and have a maximum length of 16 characters.

color
required
string

The color of the Device Label. The value of this field must be a hexadecimal color code, for example: #f1f1f4.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Device Label.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a Device Label

Delete a Device Label by ID within a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Device Label.

Response samples

Content type
application/json
{
}

Attach Device Labels

Attach Device Labels to devices within a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceIds
required
Array of strings

The ID array of devices to which we will attach labels.

deviceLabelIds
required
Array of strings

The ID array of Device Labels will be attached to devices. If one or more Device Labels in this array are already attached to any specific device, we will ignore it for that device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of devices along with their newly attached Device Labels.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Detach Device Labels

Detach Device Labels from devices within a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceIds
required
Array of strings

The ID array of devices to which we will detach labels from.

deviceLabelIds
required
Array of strings

The ID array of Device Labels will be detached from devices. If one or more Device Labels in this array are not already attached to any specific device, we will ignore it for that device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of devices along with their newly detached Device Labels.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update the Device Label attachment

Update the Device Label attachment for the device within a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceLabelIds
required
Array of strings

The ID array of Device Labels. After the update, the device will only attach exactly to these Device Labels.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the device along with their newly attached/detached Device Labels.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Application

Authenticate an application

This API will try to authenticate your application and in case of sucess will return a token that is mandatory for calling other APIs.

header Parameters
Content-Type
required
string

application/json

Request Body schema: application/json
required
email
required
string

The email address of the user

password
required
string <password>

The password associated to the user account

appId
required
string

The id of an application on the platform created and associated to the user

appSecret
required
string

The secret key of the application

Responses

Response Schema: application/json
access_token
string

The access token generated by the backend.

expires_in
integer

The period of validity of the access token, in seconds.

token_type
string

The type of the token.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get user applications

Fetch all applications created by the authenticated user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all user applications.

Response samples

Content type
application/json
{
}

Create an application

Create a new application.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the application

target
required
string
Enum: "WEB_APPLICATION" "ADMIN_APPLICATION" "BOT_APPLICATION" "DESKTOP_APPLICATION" "IOT_APPLICATION" "SERVER_APPLICATION" "MOBILE_APPLICATION"

The target of the application.

description
string

The description of the application.

isInProduction
boolean

Indicates if the user application is in production.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete user applications

Delete many applications belong to user identified by an array ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of application

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing an array of the deleted applications IDlimitedOrganizations.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a user application

Fetch one application identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the user application.

Response samples

Content type
application/json
{
}

Update a user application

Update one application identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the application

target
required
string
Enum: "WEB_APPLICATION" "ADMIN_APPLICATION" "BOT_APPLICATION" "DESKTOP_APPLICATION" "IOT_APPLICATION" "SERVER_APPLICATION" "MOBILE_APPLICATION"

The target of the application.

description
string

The description of the application.

isInProduction
boolean

Indicates if the user application is in production.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a user application

Delete a user application identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted application.

Response samples

Content type
application/json
{
}

Update application state

This API update the application state identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
isInProduction
required
boolean

Indicates if the user application is in production.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Msp

Get user's MSP

Get retrieve the unique managed service provider (MSP) data for a given user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get a MSP

Get an existing managed service provider (MSP) identified by its mspId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of unique MSP.

Response samples

Content type
application/json
{
}

Update a MSP

Update an existing managed service provider (MSP)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the msp.

enforceStrongPassword
required
boolean

The option allows to enforce strong password in the msp.

enforceStrongPasswordNotifyType
required
string
Enum: "SHOW_MESSAGE_AFTER_LOGIN" "NO_WARNING"

The option allows configuring the notification if the user's password violates the enforcement password policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated MSP.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all MSP Level user and Organization Level user inside a MSP

Fetch all users inside a MSP, as well as Organization level user and their Two-factor Authentication status

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all Users.

Response samples

Content type
application/json
{
}

Update the requirement of 2FA Configuration of user inside MSP

Set the obligation of Two-factor authentication for a group of users inside a MSP

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
activeAuthenticatorIds
required
Array of strings

The array of the unique MSP Id, or the Organizations Id in where you want to force the Two-factor authentication

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
Array of strings

An array of entity where user is forced to activate Two-factor authentification.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a verified user of a MSP

Find a verified user of the managed service provider (MSP) by its ID

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON objects containing a user.

Response samples

Content type
application/json
{
}

Update the user's role in MSP

Update the Msp level access role of a verified user in a MSP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
role
required
string
Enum: "MSP_ADMIN" "MSP_VIEWER" "MSP_LIMITED"

The Msp-level role of user

Array of objects

The selected organizations and its corresponding permission for user

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The updated access role of user in Msp-level

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Revoke user access to a MSP

Remove access of a user to a managed service provider and all its organizations and sites. (MSP)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The revoked access role of user in Msp-level

Response samples

Content type
application/json
{
}

Get all users in msp level

Get all verified users of a managed service provider (MSP) identified by mspId parameter

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all Users.

Response samples

Content type
application/json
{
}

Revoke access of multiple users to a MSP

Remove access of many users by Id to a managed service provider (MSP) and all its organizations and sites.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique user identifier, whose access you want to revoke from this MSP.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object of the revoked user ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Invitee

Get all pending invitations of a MSP

Get all pending invitations of the identified managed service provider (MSP) identified by mspId parameter

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Invite User to a MSP

Create an invitation for a user to join a managed service provider (MSP) with specific role

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of invitation to MSP.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Resend multiple invitation emails of a MSP

Resend invitation email to many users in a MSP

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

The id of invitee to resend invitation email

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing an array of the resent email invitee ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple invitation of a MSP

Delete multiple invitation in a MSP

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of deleted invitees

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The deleted invitee object.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a pending invitation of a MSP

Find a pending invitation of the managed service provider (MSP) by its ID

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The invitee object.

Response samples

Content type
application/json
{
}

Update an invitation of a MSP

Update an invitation and resend invitation in a MSP. For resending without update: set the body an empty JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
message
string

The invitation message.

role
string
Enum: "MSP_ADMIN" "MSP_VIEWER" "MSP_LIMITED"

The Msp-level role of user

object

The accessible organization, it is required when the role is MSP_LIMITED

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The invitee object.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete an invitation

Delete an existing invitation identified by inviteeId in managed service provider. (MSP)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array containing The deleted invitee object.

Response samples

Content type
application/json
{
}

Accept an invitation to a Msp

Accept an invitation to a MSP for a user who has already signed up and who should not be attached to any entity

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The accepted invitation object.

Response samples

Content type
application/json
{
}

Get all pending invitations of an Organization

Get all pending invitations of the identified organization by orgId parameter

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Invite User to an Organization

Create an invitation for a user to join an organization with specific role

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of invitation to organization.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Resend multiple invitation emails of an Organization

Resend invitation email to many users in an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

The id of invitee to resend invitation email

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing an array of the resent email invitee ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple invitation of an Organization

Delete multiple invitation in an Organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of deleted invitees

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The deleted invitee object.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a pending invitation of an Organization

Find a pending invitation of the organization by its ID

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The invitee object.

Response samples

Content type
application/json
{
}

Update an invitation of an Organization

Update an invitation and resend invitation in an Organization. For resending without update: set the body an empty JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
message
string

The invitation message.

role
string
Enum: "ORGANIZATION_ADMIN" "ORGANIZATION_VIEWER" "ORGANIZATION_LIMITED"

The Organization-level role of user

Array of objects

The selected site and its corresponding permission for the ORGANIZATION_LIMITED role

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The invitee object.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete an invitation of an Organization

Delete an existing invitation identified by inviteeId in an Organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The unique identifier of the deleted invitee

Response samples

Content type
application/json
{
}

Accept an invitation to an Organization

Accept an invitation to an organization for an exist user, who has already signed up.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The accepted invitation object.

Response samples

Content type
application/json
{
}

Organization

Get all user organizations

Fetch all user organizations.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all organizations.

Response samples

Content type
application/json
{
}

Create an organization

Create a new organization in an MSP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the organization.

imageUrl
string

The image location name where the organization image has been uploaded. Ex: 423c45b9-7396-4c09-8945-c7b3a8ed4940.png

mspId
string

The id of MSP which the organization belongs.

countryCode
required
string

The organization ISO 3166 alpha-2 country code.

timezone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" … 291 more

The organization timezone (ex: America/New_York).

idleTimeout
integer <int32>

The number of seconds, that a client session can be idle before disconnecting the user, or 0 to disable.

isInMsp
boolean

Include or not the new organization in MSP. If not, only the creator has access to this organization. Required when mspId is presented.

auditHour
integer <int32>

The hour in day in timestamp format for the Audit Configuration scheduler. Ex: with value 130; hour = 130 divide by 60 (= 2 hour); minute = the remainder of 130 divide by 60 (= 10 minute); therefore scheduled hour is 2:10.

enforceStrongPassword
required
boolean

The option allows to enforce strong password in the organization.

enforceStrongPasswordNotifyType
required
string
Enum: "SHOW_MESSAGE_AFTER_LOGIN" "NO_WARNING"

The option allows configuring the notification if the user's password violates the enforcement password policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all organizations of MSP

Fetch all organizations of specific MSP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all organizations of MSP.

Response samples

Content type
application/json
{
}

Get all organizations of MSP Summary

Fetch all organizations summaries of a specific MSP .

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all organizations of MSP summaries .

Response samples

Content type
application/json
{
}

Get an organization with settings

Fetch one organization identified by its id with its settings.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the organization.

Response samples

Content type
application/json
{
}

Get an organization

Fetch one organization identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the organization.

Response samples

Content type
application/json
{
}

Update an organization

Update one organization identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the organization.

imageUrl
string

The image location name where the organization image has been uploaded. Ex: 423c45b9-7396-4c09-8945-c7b3a8ed4940.png

mspId
required
string

The id of MSP which the organization belongs.

countryCode
required
string

The organization ISO 3166 alpha-2 country code.

timezone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" … 291 more

The organization timezone (ex: America/New_York).

idleTimeout
integer <int32>

The number of seconds, that a client session can be idle before disconnecting the user, or 0 to disable.

auditHour
integer <int32>

The hour in day in timestamp format for the Audit Configuration scheduler. Ex: with value 130; hour = 130 divide by 60 (= 2 hour); minute = the remainder of 130 divide by 60 (= 10 minute); therefore scheduled hour is 2:10.

upamAuthRecords
integer <int32>

The maximum number of days where UPAM records data are kept in the system.

events
integer <int32>

The maximum number of days where Events Traps data are kept in the system.

alerts
integer <int32>

The maximum number of days where Alert data are kept in the system.

wifiRtls
integer <int32>

The maximum number of days where Heatmap, client location data are kept in the system.

networkAnalytics
integer <int32>

The maximum number of days where Network analytics data are kept in the system.

clientSessions
integer <int32>

The maximum number of days where Client session data are kept in the system.

clientAnalytics
integer <int32>

The maximum number of days where Client analytics data are kept in the system.

auditLogs
integer <int32>

The maximum number of days where Audit logs data are kept in the system.

loginAttemps
integer <int32>

The maximum number of days where Organization User Login Attemps data are kept in the system.

iotData
integer <int32>

The maximum number of days where IoT data are kept in the system.

collectInfo
integer <int32>

The maximum number of days where collect support info file are kept in the system.

backupPerDevice
integer <int32>

The maximum number of backups retaining per device in the system.

configurationBackup
integer <int32>

The maximum number of days where configuration backups are kept in the system.

qoe
integer <int32>

The maximum number of days where QoE Analytics data are kept in the system.

enforceStrongPassword
required
boolean

The option allows to enforce strong password in the organization.

enforceStrongPasswordNotifyType
required
string
Enum: "SHOW_MESSAGE_AFTER_LOGIN" "NO_WARNING"

The option allows configuring the notification if the user's password violates the enforcement password policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated organization.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete an organization

Delete an organization identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted organization.

Response samples

Content type
application/json
{
}

Get the enforcement password setting of an Organization

Get the enforcement password setting of an Organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON objects containing an Enforcement Password Setting.

Response samples

Content type
application/json
{
}

Update the enforcement password setting of an Organization

Update enforcement password setting of an Organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
enforceStrongPassword
required
boolean

The option allows to enforce strong password in the organization.

enforceStrongPasswordNotifyType
required
string
Enum: "SHOW_MESSAGE_AFTER_LOGIN" "NO_WARNING"

The option allows configuring the notification if the user's password violates the enforcement password policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON objects containing an Enforcement Password Setting.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a verified user of an Organization

Find a verified user of the organization by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON objects containing a user.

Response samples

Content type
application/json
{
}

Update the user's role in Organization

Update the organization level access role of a verified user in an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
role
required
string
Enum: "ORGANIZATION_ADMIN" "ORGANIZATION_VIEWER" "ORGANIZATION_LIMITED"

The Organization-level role of user

Array of objects

The selected site and its corresponding permission for user

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The updated access role of user in Organization-level

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Revoke access user to an organization

Remove access of a user to an organization and all its sites.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The revoked access role of user in Organization-level to orgId

Response samples

Content type
application/json
{
}

Get Two-factor Authentication status of users

Fetch the Two-factor authentication configuration of the organization-level users in this organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of all organization-level Users JSON with the Two-Factor Authentication status.

Response samples

Content type
application/json
{
}

Update the Two-factor Authentication in Organization

Impose or not the Two-factor Authentication for organization-level users in this Organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
is2FARequired
required
boolean

The Two-Factor authentication for Organization-level users in the organization

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated organization.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all users in organization level

Get all verified users of an organization identified by orgId parameter.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all organization-level Users.

Response samples

Content type
application/json
{
}

Revoke access of multiple users to an Organization

Remove access of many users by Id to an Organization and all its sites.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique user Id to revoke access

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the user ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Site

Get organization sites

Fetch all sites of a given organization by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all organization sites.

Response samples

Content type
application/json
{
}

Create a site

Create a new site in an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the site. Ex: ALE Brest

timezone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" … 291 more

Timezone of the site.

zoom
required
integer <int32>

Zoom value for the location of the site, minimum 17.

address
required
string

The address of the site. Ex: 5 Av. Anatole France

countryCode
string

The code of country where the site is located. Ex: FR

isDefault
boolean

True if the site is default of this organization.

object

The location of the site, in geoJson format.

imageUrl
string

The image location name where the site image has been uploaded. Ex: 423c45b9-7396-4c09-8945-c7b3a8ed4940.png

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get organization sites, buildings and floors

Fetch all sites (including their their buildings and floors) of a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all organization sites with all there buildings and floors informations.

Response samples

Content type
application/json
{
}

Get a site

Fetch one site identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the organization site.

Response samples

Content type
application/json
{
}

Update a site

Update one site identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the site. Ex: ALE Brest

timezone
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" … 291 more

Timezone of the site.

address
string

The address of the site. Ex: 5 Av. Anatole France

zoom
integer <int32>

Zoom value for the location of the site, minimum 17.

countryCode
string

The code of country where the site is located. Ex: FR

isDefault
boolean

True if the site is default of this organization.

object

The location of the site, in geoJson format.

imageUrl
string

The image location name where the site image has been uploaded. Ex: 423c45b9-7396-4c09-8945-c7b3a8ed4940.png

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated organization site.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a site

Delete one site identified by its id. All other objects linked to this site will be also deleted. (Floors, Buildings...)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted site.

Response samples

Content type
application/json
{
}

Smsprovider

Get SMS Provider Settings

Fetch the SMS Provider settings for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update SMS Provider Settings

Update the SMS Provider settings for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
smsProvider
required
string
Enum: "PLIVO" "TWILIO"

The current selected SMS Gateway Service that will be used to send SMS for this organization. Values can be only 'TWILIO' or 'PLIVO'.

twilio_accountSid
string

The account SID got from the Twilio web console. (When the smsProvider attribute is set to 'TWILIO', this attribute is required).

twilio_authToken
string

The authentication token got from the Twilio web console. (When the smsProvider attribute is set to 'TWILIO', this attribute is required).

twilio_numberFrom
string

The array of phone numbers updated. The phone numbers you bought on Twilio. Make sure to use E.164 format here. (https://www.twilio.com/docs/glossary/what-e164). (When the smsProvider attribute is set to 'TWILIO', this attribute is required).

plivo_authId
string

The auth id got from the Plivo web console. (When the smsProvider attribute is set to 'PLIVO', this attribute is required).

plivo_authToken
string

The authentication token got from the Plivo web console. (When the smsProvider attribute is set to 'PLIVO', this attribute is required).

plivo_numberFrom
string

The array of phone numbers updated. The phone numbers you bought on Plivo. (When the smsProvider attribute is set to 'PLIVO', this attribute is required).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Send SMS for test

Send an SMS for testing SMS Provider Settings.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
smsProvider
required
string
Enum: "PLIVO" "TWILIO"

The current selected SMS Gateway Service that will be used to send SMS for this organization. Values can be only 'TWILIO' or 'PLIVO'.

twilio_accountSid
string

The account SID got from the Twilio web console. (When the smsProvider attribute is set to 'TWILIO', this attribute is required).

twilio_authToken
string

The authentication token got from the Twilio web console. (When the smsProvider attribute is set to 'TWILIO', this attribute is required).

twilio_numberFrom
string

The array of phone numbers. The phone numbers you bought on Twilio. Make sure to use E.164 format here. (https://www.twilio.com/docs/glossary/what-e164). (When the smsProvider attribute is set to 'TWILIO', this attribute is required).

plivo_authId
string

The auth id got from the Plivo web console. (When the smsProvider attribute is set to 'PLIVO', this attribute is required).

plivo_authToken
string

The authentication token got from the Plivo web console. (When the smsProvider attribute is set to 'PLIVO', this attribute is required).

plivo_numberFrom
string

The array of phone numbers. The phone numbers you bought on Plivo. (When the smsProvider attribute is set to 'PLIVO', this attribute is required).

to
required
string

The phone number on which you want to receive the SMS. Make sure to use E.164 format here.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Group

Get all Group(s) belong to site

Fetch all groups of a given site by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all site groups.

Response samples

Content type
application/json
{
}

Create a group

Create a new group in an site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the group.

description
string

The description of the group.

provisioningTemplateName
required
string

The Provisioning Template of the group.

isExtendScale
required
boolean

Indicates whether or not the Group enables the Extended SSID Scale option.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete groups

This route is used to delete the multiple group identified by its groupIds belong to site siteId. All device linked to this group will be migrated to specific group or default group (if specific group is not exist)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of the groupIds which are removed

groupForDeviceMigration
string

The id of the group which is the destination for device migration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the deleted groups.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all Group(s) belong to organization

Fetch all groups of a given organization by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all groups in organization.

Response samples

Content type
application/json
{
}

Get Group by Id belong to site

Fetch group by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the group.

Response samples

Content type
application/json
{
}

Update a group

Update one group identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the group.

description
string

The description of the group.

provisioningTemplateName
required
string

The Provisioning Template of the group.

isExtendScale
required
boolean

Indicates whether or not the Group enables the Extended SSID Scale option.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated group.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a group

This route is used to delete the Group identified by its groupId belong to site siteId. All device linked to this group will be migrated to specific group or default group (if specific group is not exist)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
groupForDeviceMigration
string

The id of the group which is the destination for device migration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted group.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Alert

Get alert summary

Fetch all alert of given organization id.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

period
required
string

Merging of alerts to an entry for the selected period from group by window which has list of values. The group by window values are "None", "5 minutes", "15 minutes", "30 minutes", "1 hour", "3 hours", "6 hours", "9 hours", "12 hours", "24 hours", ex: period: 5 minutes.

limit
required
string

The number of records to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: alertType. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'alertType': 'Reassoc Failure'. ex: filter with object: {"alertType":{"contains":"Reassoc"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: siteName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"siteName":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "MAC".

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing alerts.

Response samples

Content type
application/json
{
}

Delete summary alerts

Delete summary alerts.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

limit
string

the number of record to fetch from the total records, ex: 10.

offset
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "alertType".

object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: alertType. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'alertType': 'Portal Auth Failure'. ex: filter with object: {"alertType":{"contains":"Portal"}}.

required
Array of objects

An array of alert summary.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of deleted alert ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get alert details

Get all alert details.

query Parameters
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: alertType. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'alertType': 'Portal Auth Failure'. ex: filter with object: {"alertType":{"contains":"Portal"}}.

limit
required
string

The number of records to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "alertType".

firstOccurrence
required
string

"firstOccurrence" is the first time alert occurred in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

lastOccurrence
required
string

"lastOccurrence" is the time alert occurred in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

alertType
required
string

Name of the alert type.

severity
required
string

Severity of the alert.

isAcknowledged
required
string

The acknowledge status of the alert.

siteId
required
string

Unique site identifier.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the alert details.

Response samples

Content type
application/json
{
}

Acknowledge all alerts

Acknowledge all alerts within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: alertType. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'alertType': 'Reassoc Failure'. ex: filter with object: {"alertType":{"contains":"Reassoc"}}.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing all acknowledged alert ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Acknowledge summary alerts

Acknowledge summary alerts within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

limit
string

the number of record to fetch from the total records, ex: 10.

offset
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "alertType".

object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: alertType. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'alertType': 'Portal Auth Failure'. ex: filter with object: {"alertType":{"contains":"Portal"}}.

required
Array of objects

An array of alert summary.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of acknowledged alert ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Acknowledge multiple alerts

Acknowledge multiple alerts by their ids within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of alerts.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing acknowledged alert ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Acknowledge an alert by id

Acknowledge an alert by id within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing acknowledged alert id.

Response samples

Content type
application/json
{
}

Delete an alert by id

Delete an alert identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing deleted alert id.

Response samples

Content type
application/json
{
}

Delete all alerts

Delete all alerts within an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: alertType. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'alertType': 'Portal Auth Failure'. ex: filter with object: {"alertType":{"contains":"Portal"}}.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing all deleted alert ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple alerts

Delete multiple alerts identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of alerts.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple deleted alert ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all alert definitions

Get all alert definitions.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all alert definitions

Response samples

Content type
application/json
{
}

Update multiple alert definitions

Update multiple alert definitions.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

An array of alert definitions.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing ids of reseted alert definitions

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update an alert definition

Update an alert definition.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
severity
required
string

Severity of alert definition.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the id of updated alert definition

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reset alert definitions

Reset alert definitions.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of alert definitions.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing ids of reseted alert definitions

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reset all alert definitions

Reset all alert definitions.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing all the ids of reseted alert definitions.

Response samples

Content type
application/json
{
}

Get alerts by client.

Get the related alerts to a specific client identified by providing the client mac address

query Parameters
staMac
required
string

This is the mac address of a client.

startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

limit
required
string

The number of records to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: siteName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"siteName":"ASC"}]

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing alerts.

Response samples

Content type
application/json
{
}

Alerttype

Get all alert types

Get all alert types.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Alert types with their id and activation status.

Response samples

Content type
application/json
{
}

Alerttemplate

Get all alert templates

Get all alert templates.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
message
string

Status message associated to the response.

status
integer

HTTP Status Code associated to the response. (200)

object

Get all alert templates

Response samples

Content type
application/json
{
}

Create an alert template

Create a new alert template.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the alert template.

organization
required
string

The unique identifier of organization.

Array of objects

An array of alertTypes to enable and disable.

siteScope
Array of strings

The array of unique identifiers of site ids.

scope
required
integer <int32>

Scope is 0 for organization and Scope is 1 for site .

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple alert templates

Delete mutiple alert templates identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of alert template

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Delete multiple alert templates

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update an alert template

Update an alert template within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the alert template.

organization
required
string

The unique identifier of organization.

Array of objects

An array of alertTypes to enable and disable.

siteScope
Array of strings

The array of unique identifiers of site ids.

scope
required
integer <int32>

Scope is 0 for organization and Scope is 1 for site .

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete an alert template

Delete an alert template identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Delete an alert template

Response samples

Content type
application/json
{
}

Iot

Get all categories

Get all categories.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing Categories details

Response samples

Content type
application/json
{
}

Create a Category

Create a new Category. Either macMapping(Mac based Category) or hierarchyMapping(Hierarchy based category) is mandatory.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the category.

path
string

The path of the category.

description
string

The description of the category.

hierarchyMapping
Array of strings

The array of hierarchial mapping names.

macMapping
Array of strings

The array of MAC addresses.

accessRoleProfile
string

The name of the access role profile

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple Categories

Delete mutiple categories identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of categories

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the ids of categories to be deleted grouped by the status of the operation

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all device hierarchies

Get all device hierarchies. Only those category hierarchies that have been detected and displayed on the Inventory Screen are fetched

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
message
string

Status message associated to the response.

status
integer

HTTP Status Code associated to the response. (200)

object

A Json object of all Hierarchy Categories

Response samples

Content type
application/json
{
}

Update a Category

Update a new Category. Either macMapping(Mac based Category) or hierarchyMapping(Hierarchy based category) is mandatory.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the category.

path
string

The path of the category.

description
string

The description of the category.

hierarchyMapping
Array of strings

The array of hierarchial mapping names.

macMapping
Array of strings

The array of MAC addresses.

accessRoleProfile
string

The name of the access role profile

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a category

Delete a category identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Delete a category by id

Response samples

Content type
application/json
{
}

Get Automatic Enforcement

Get automatic enforcement status.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
message
string

Status message associated to the response.

status
integer

HTTP Status Code associated to the response. (200)

object

An array of JSON objects containing all Auto Enforcement.

Response samples

Content type
application/json
{
}

Update Automatic Enforcement

Update automatic enforcement status.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
parameter
required
string

identifier for automatic enforcement parameter i.e. autoenforcement.

value
required
string

status of the auto enforcement Enable/Disable.

Responses

Response Schema: application/json
message
string

Status message associated to the response.

status
integer

HTTP Status Code associated to the response. (200)

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Manual Enforcement

This api allows manually enable/disable iot enforcement for specific categories

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
categoryName
required
Array of strings

The array of category names.

action
required
string

status of the manual enforcement i.e Enable/Disable.

Responses

Response Schema: application/json
message
string

Status message associated to the response.

status
integer

HTTP Status Code associated to the response. (200)

object

An array of JSON objects containing updated Auto Enforcement Satus.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Exception List

Get exception list.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
message
string

Status message associated to the response.

status
integer

HTTP Status Code associated to the response. (200)

object

An array of JSON objects containing all Exception lists.

Response samples

Content type
application/json
{
}

Update an Exception List

Update an Exception List.You can specify exceptions for specific devices by SSID, MAC address, AP Group. When a device matching one of these exceptions is categorized, it will not be subject to IoT enforcement configured for its category.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

A JSON array containing devices.

required
Array of objects

A JSON array containing apGroups.

required
Array of objects

A JSON array containing sites.

ssid
required
Array of strings

The array of ssid.

endpointMac
required
Array of strings

The array of endpointMac.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update an Access Role Profile

Update access role profile.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

A JSON array updating access role profile to category.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the name of category and the access role profile to be updated grouped by the status of the operation

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all Inventories

Get all inventories.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

latest
required
boolean

'true' to display only the latest session inventory details, 'false' to display all historic entries.

limit
required
string

the number of record to fetch from the total records, ex: 10.

offset
required
string

the start position of the records to fetch over the total number of record, , ex: 0

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: category_name. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'category_name': 'mobile'. ex: filter with object: {"category_name":{"contains":"mobile"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: endpoint_mac. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"endpoint_mac":"ASC"}

search
string

The search is applied to filter all the fields in the object , ex: search: "dc:08:56:04:39:ea".

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap" and "switch_sn".

serials[]
string

"serials" is an array of device serial numbers. This field is required when the scope is "switch_sn".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Inventory filtered data inside the total record.

Response samples

Content type
application/json
{
}

Assign category to device

Assign custom category to devices by their mac ids within an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
macs
required
Array of strings

The array of unique endpoint mac address of inventories.

categoryName
required
string

The name of the category.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing assign category to device mac imformation.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Vlanmanager

Get all VLANs

Get all VLANs

query Parameters
limit
required
string

The number of records to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: adminStatus. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'adminStatus': 'Enabled'. ex: filter with object: {"adminStatus":{"contains":"enabled"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: siteName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"vlanId":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "1".

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing VLANs.

Response samples

Content type
application/json
{
}

Create VLAN

Create VLAN(s).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

The Vlans contains objects which has information about VLAN

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The data of the created VLANs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete VLAN by ID.

Delete VLAN by ID

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
vlanId
string

Unique VLAN identifier.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The deleted data of the VLAN.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get VLAN device details by VLAN ID

VLAN device details by VLAN ID.

query Parameters
limit
required
string

The number of records to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: adminStatus. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'adminStatus': 'Enabled'. ex: filter with object: {"adminStatus":{"contains":"enabled"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: siteName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"vlanId":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "1".

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all VLAN Device for specificed scope

Response samples

Content type
application/json
{
}

Delete devices from VLAN by device mac.

Delete devices from VLAN by device mac

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceMac
Array of strings

The MAC address of the device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The deleted data of the VLANs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get VLAN port details by VLAN ID

VLAN port details by VLAN ID.

query Parameters
limit
required
integer

The number of records to fetch from the total records, ex: 10.

offset
required
integer

The start position of the records to fetch over the total number of records, ex: 0.

filters
required
object

The filter applied to filter the value of a specific object field in the record. The field name in the filter object corresponds to the field in one record, for example: adminStatus. If no filter is applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead of an object for this fieldName, ex: 'adminStatus': 'Enabled'. ex: filter with object: {"adminStatus":{"contains":"enabled"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: siteName. Its value is an enum of ASC, DESC (ascending or descending order). If no sorting is applied, send an empty array. ex: sort: [{"vlanId":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "1".

scope
required
string

"scope" is the target: org, site, building, floor, switch_sn for switch.

scopeId[]
Array of arrays

"scopeId" is an array of IDs corresponding to the selected scope. This field is required when the scope is "org".

serials[]
Array of arrays

"serials" is an array of device serial numbers. This field is required when the scope is "switch_sn".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The data associated to the response.

Response samples

Content type
application/json
{
}

Get VLAN link aggregate details by VLAN ID

VLAN link aggregate details by VLAN ID.

query Parameters
limit
required
string

The number of records to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: adminStatus. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'adminStatus': 'Enabled'. ex: filter with object: {"adminStatus":{"contains":"enabled"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: siteName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"vlanId":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "1".

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all link aggregates information for specificed scope

Response samples

Content type
application/json
{
}

Enable/disable VLAN admin status by VLAN ID

Enable/ disable VLAN admin status by VLAN ID

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
vlanId
required
string

Unique VLAN identifier.

adminStatus
boolean

The VLAN's administrative status of device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing administrative status of the specific VLAN.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Enable/ disable VLAN admin status by VLAN IDs

Enable/ disable VLAN admin status by VLAN IDs

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
vlanIds
required
Array of strings

Unique VLAN identifier.

adminStatus
boolean

The VLAN's administrative status of device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing administrative status of the specific VLANs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Enable/disable VLAN admin status by device MAC

Enable/ disable VLAN admin status by device MAC

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
vlanId
required
string

Unique VLAN identifier.

adminStatus
boolean

The VLAN's administrative status of device.

deviceMac
string

The MAC address of the device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing administrative status of the specific VLAN.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Enable/ disable VLAN admin status by device MACs

Enable/ disable VLAN admin status by device MACs

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
vlanId
required
string

Unique VLAN identifier.

adminStatus
boolean

The VLAN's administrative status of device.

deviceMacs
Array of strings

The MAC address of the device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing administrative status of the specific VLANs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete VLANs by IDs.

Delete VLANs by IDs

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
vlanIds
Array of strings

Unique VLAN identifier.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The deleted data of the VLANs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete device from VLAN by device mac.

Delete VLAN by ID

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceMac
string

The MAC address of the device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The deleted data of the VLANs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Edit VLAN

Edit VLAN.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
vlanId
string

Unique VLAN identifier.

object

An object containing a list of VLAN devices that have been added or modified. Each VLAN device includes the MAC address, description, admin status, and lists of ports and tagged ports with their respective details.

Array of objects

An array of objects representing devices or ports to be removed. Each object includes the MAC address to remove device or MAC address and a consolidated list of ports (including ports and taggedPorts) that has to be removed.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The data of the created VLANs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get VLAN device and port details by VLAN ID

Get VLAN device and port details by VLAN ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The data of the created VLANs.

Response samples

Content type
application/json
{
}

Get VLAN available ports details in device by VLAN ID

Get VLAN available ports details in device by VLAN ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The data of the created VLANs.

Response samples

Content type
application/json
{
}

Get STP Summary By VLAN ID

Get summary details of spanning tree protocol.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing STP summary.

Response samples

Content type
application/json
{
}

Get STP Bridge By VLAN ID

Get STP bridge details by VLAN ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing STP bridge.

Response samples

Content type
application/json
{
}

Get STP Ports By VLAN ID

Get STP ports details by VLAN ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing STP port.

Response samples

Content type
application/json
{
}

Update STP Port By VLAN ID

Update STP Port by VLAN ID within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceMac
required
string

The MAC address of the device.

portNumber
required
string

The port number on the device.

adminStatus
required
string

The bridge priority value for the VLAN. The value ranges from 0 to 65535

adminConnection
required
string

The Spanning Tree status for the port (Enabled/Disabled). If disabled, the port state is set to forwarding for the VLAN Spanning Tree instance.

priority
required
string

The port priority value for the VLAN. The lower the number, the higher the priority value. The value ranges from 0 to 15.

pathCost
required
string

The path cost value for the port. This value specifies the contribution of a port to the path cost towards the root bridge that includes the port. The value ranges from 1 to 30.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the spanning tree port information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update STP Bridge By VLAN ID

Update STP Bridge by VLAN ID within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceMac
required
string

The MAC address of the device.

protocol
required
string

The VLAN spanning tree algorithm protocol.

priority
required
string

The bridge priority value for the VLAN. The value ranges from 0 to 65535

bridgeMaxAge
required
string

The amount of time, in seconds, that spanning tree information learned from BPDUs received on VLAN ports is retained. The value ranges from 6 to 40. Default: 20

bridgeHelloTime
required
string

The Hello Time value for the root bridge. The value ranges from 1 to 10.

bridgeForwardDelay
required
string

The forward delay time value for the root bridge. The value ranges from 1 to 30.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the spanning tree bridge information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get IP interfaces

Fetch all IP interfaces of given organization id.

query Parameters
limit
required
string

The number of records to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: ipInterfaceDeviceType. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'ipInterfaceDeviceType': 'vlan'. ex: filter with object: {"ipInterfaceDeviceType":{"contains":"vlan"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: siteName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"siteName":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "ipInterfaceName".

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing ip interfaces.

Response samples

Content type
application/json
{
}

Create an IP interface

Create an IP interface.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ipInterfaceAddress
required
string

The IP address of the IP interface.

ipInterfaceAdminState
string
Value: "Enabled"

The administrative state of the interface (Enable/Disabled). (Default = Enabled).

ipInterfaceDeviceType
string

The type of device bound to the interface.

ipInterfaceEncap
string

The IP interface frame encapsulation value (Ethernet 2 or SNAP).

ipInterfaceIpForward
string
Value: "Disabled"

The interface forwarding status (Enabled/Disabled). (Default = Disabled).

ipInterfaceLocalProxyArp
string
Value: "Disabled"

Local Proxy ARP status (Enabled/Disabled). (Default = Disabled).

ipInterfaceMask
required
string

The IP interface subnet mask value. The default value for this field is based on which network class range the IP address falls within; Class A, B, or C. (255.0.0.0, 255.255.0.0, or 255.255.255.0).

ipInterfaceMtu
string

The Maximum Transmission Unit (MTU) size set for the interface. MTU field is editable only when the device type is set to VLAN; otherwise it defaults to a value of 1500

ipInterfaceName
required
string

The user-configured interface name.

ipInterfacePrimCfg
string
Value: "True"

If set to true, designates the IP interface as the primary interface for the VLAN. If set to false, the first interface bound to the VLAN becomes the primary by default. (Default = True).

ipInterfaceTunnelDstAddressType
string

Tunnel destination address type of the IP interface.

ipInterfaceTunnelDst
string

Tunnel destination address of the IP interface.

ipInterfaceTunnelSrcAddressType
string

Tunnel source address type of the IP interface.

ipInterfaceTunnelSrc
string

Tunnel source address of the IP interface.

ipInterfaceVlanID
string

VLAN ID is mandatory only if the device type is VLAN.

ipv6InterfaceAddressPrefixLength
string

Prefix Length is mandatory only for IPv6 Address.

ipv6InterfaceTunnelId
string

Tunnel ID is mandatory only for IPv6 Address.

macAddress
Array of strings

The macAddress of the ip interface.

vrfId
string

The VRF ID.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

A JSON object containing data of created IP interface.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get an IP Interface

Get an IP interface within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing ip interfaces.

Response samples

Content type
application/json
{
}

Update an IP Interface

Update an IP interface within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ipInterfaceAddress
required
string

The IP address of the IP interface.

ipInterfaceAdminState
string
Value: "Enabled"

The administrative state of the interface (Enable/Disabled). (Default = Enabled).

ipInterfaceDeviceType
string

The type of device bound to the interface.

ipInterfaceEncap
string

The IP interface frame encapsulation value (Ethernet 2 or SNAP).

ipInterfaceIpForward
string
Value: "Disabled"

The interface forwarding status (Enabled/Disabled). (Default = Disabled).

ipInterfaceLocalProxyArp
string
Value: "Disabled"

Local Proxy ARP status (Enabled/Disabled). (Default = Disabled).

ipInterfaceMask
required
string

The IP interface subnet mask value. The default value for this field is based on which network class range the IP address falls within; Class A, B, or C. (255.0.0.0, 255.255.0.0, or 255.255.255.0).

ipInterfaceMtu
string

The Maximum Transmission Unit (MTU) size set for the interface. MTU field is editable only when the device type is set to VLAN; otherwise it defaults to a value of 1500

ipInterfaceName
required
string

The user-configured interface name.

ipInterfacePrimCfg
string
Value: "True"

If set to true, designates the IP interface as the primary interface for the VLAN. If set to false, the first interface bound to the VLAN becomes the primary by default. (Default = True).

ipInterfaceTunnelDstAddressType
string

Tunnel destination address type of the IP interface.

ipInterfaceTunnelDst
string

Tunnel destination address of the IP interface.

ipInterfaceTunnelSrcAddressType
string

Tunnel source address type of the IP interface.

ipInterfaceTunnelSrc
string

Tunnel source address of the IP interface.

ipInterfaceVlanID
string

VLAN ID is mandatory only if the device type is VLAN.

ipv6InterfaceAddressPrefixLength
string

Prefix Length is mandatory only for IPv6 Address.

ipv6InterfaceTunnelId
string

Tunnel ID is mandatory only for IPv6 Address.

macAddress
Array of strings

The macAddress of the ip interface.

vrfId
string

The VRF ID.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing data of updated IP interface.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete IP interface by id

Delete IP interface identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing ip interface id.

Response samples

Content type
application/json
{
}

Delete multiple IP interfaces

Delete multiple IP interfaces identified by its ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

"ids" is an array of ids corresponding to the multiple ip interface ids.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple deleted ip interface ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get VLANs of device by serial number

Vlans of device by serial number.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
Array of numbers

An array containing the device's vlans information.

Response samples

Content type
application/json
{
}

Get the VLAN's Ip Router

Get the ip routers information of given vlan id.

query Parameters
limit
required
string

The number of records to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: ipInterfaceDeviceType. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'ipInterfaceDeviceType': 'vlan'. ex: filter with object: {"ipInterfaceDeviceType":{"contains":"vlan"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: siteName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"siteName":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "ipInterfaceName".

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the ip router information for given VLAN.

Response samples

Content type
application/json
{
}

Create a new IP Router

Create a new IP Router.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
routerIpAddress
required
string

The IP address of the router.

routerIpMask
required
string

The IP mask of the router.

ipv6AddressPrefixLength
string

Prefix Length is mandatory only for IPv6 Address.

ipEncapsulation
string

The IP interface frame encapsulation value (Ethernet 2 or SNAP).

ipForwarding
string

The interface forwarding status (Enabled/Disabled).

interfaceName
required
string

The user-configured interface name.

vrfId
string

The VRF ID.

macAddress
Array of strings

The macAddress of the devices.

vlanID
string

VLAN ID is mandatory only if the device type is VLAN.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

A JSON object containing the ip router information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Edit a IP Router

Edit a exisiting IP router.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
routerIpAddress
required
string

The IP address of the router.

routerIpMask
required
string

The IP mask of the router.

ipv6AddressPrefixLength
string

Prefix Length is mandatory only for IPv6 Address.

ipEncapsulation
string

The IP interface frame encapsulation value (Ethernet 2 or SNAP).

ipForwarding
string

The interface forwarding status (Enabled/Disabled).

interfaceName
required
string

The user-configured interface name.

vrfId
string

The VRF ID.

macAddress
Array of strings

The macAddress of the devices.

vlanID
string

VLAN ID is mandatory only if the device type is VLAN.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the ip router information.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a IP Router by id

Delete ip router identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing ip router id.

Response samples

Content type
application/json
{
}

Delete multiple ip Routers

Delete multiple ip routers identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
interfaceIds
required
Array of strings

"interfaceIds" is an array of ids corresponding to the multiple ip interface ids.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple ip router ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Networkevents

Get QoE event summary

Get QoE all events.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

period
required
string

Merging of events to an entry for the selected period from group by window which has list of values. The group by window values are "None", "5 minutes", "15 minutes", "30 minutes", "1 hour", "3 hours", "6 hours", "9 hours", "12 hours", "24 hours", ex: period: 5 minutes.

limit
required
string

the number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: eventName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"eventName":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all events.

Response samples

Content type
application/json
{
}

Acknowledge summary QoE events

Acknowledge summary QoE events within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

limit
string

the number of record to fetch from the total records, ex: 10.

offset
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

required
Array of objects

An array of event summary.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of acknowledged event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete QoE summary events

Delete summary QoE events.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

limit
string

the number of record to fetch from the total records, ex: 10.

offset
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

required
Array of objects

An array of event summary.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of deleted event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Traps event summary

Get Traps all events.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

period
required
string

Merging of events to an entry for the selected period from group by window which has list of values. The group by window values are "None", "5 minutes", "15 minutes", "30 minutes", "1 hour", "3 hours", "6 hours", "9 hours", "12 hours", "24 hours", ex: period: 5 minutes.

limit
required
string

the number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: eventName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"eventName":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all events.

Response samples

Content type
application/json
{
}

Acknowledge summary Traps events

Acknowledge summary Traps events within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

limit
string

the number of record to fetch from the total records, ex: 10.

offset
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

required
Array of objects

An array of event summary.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of acknowledged event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Traps summary events

Delete summary Traps events.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

limit
string

the number of record to fetch from the total records, ex: 10.

offset
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

required
Array of objects

An array of event summary.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of deleted event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Switch Traps summary

Get summary of all Switch Traps.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

period
required
string

Merging of events to an entry for the selected period from group by window which has list of values. The group by window values are "None", "5 minutes", "15 minutes", "30 minutes", "1 hour", "3 hours", "6 hours", "9 hours", "12 hours", "24 hours", ex: period: 5 minutes.

limit
required
string

the number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: eventName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"eventName":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

scope
required
string

"scope" is the target: org, site, building, floor, switch_sn for switch.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device serial numbers if scope is switch_sn.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all events.

Response samples

Content type
application/json
{
}

Acknowledge Switch Traps Summary

Acknowledge summary of Switch Traps within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

limit
string

the number of record to fetch from the total records, ex: 10.

offset
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

required
Array of objects

An array of event summary.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of acknowledged event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Switch Traps summary

Delete summary of Switch Traps.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

limit
string

the number of record to fetch from the total records, ex: 10.

offset
string

The start position of the records to fetch over the total number of record, ex: 0.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

required
Array of objects

An array of event summary.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of deleted event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get QoE event details

Get all QoE event details.

query Parameters
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

firstEventTime
required
string

"firstEventTime" is the first event time in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

lastEventTime
required
string

"lastEventTime" is the last event time in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

eventName
required
string

Name of the event.

severity
required
string

Severity of the event.

isAcknowledged
required
string

The acknowledge of event status.

siteId
required
string

Unique site identifier.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all events.

Response samples

Content type
application/json
{
}

Acknowledge QoE events

Acknowledge QoE events by their ids within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of events.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple acknowledged event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete QoE events

Delete QoE events identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of events.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple deleted event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Traps event details

Get all Traps event details.

query Parameters
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

firstEventTime
required
string

"firstEventTime" is the first event time in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

lastEventTime
required
string

"lastEventTime" is the last event time in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

eventName
required
string

Name of the event.

severity
required
string

Severity of the event.

isAcknowledged
required
string

The acknowledge of event status.

siteId
required
string

Unique site identifier.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all events.

Response samples

Content type
application/json
{
}

Acknowledge Traps events

Acknowledge Traps events by their ids within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of events.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple acknowledged event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Traps events

Delete Traps events identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of events.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple deleted event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Switch Traps details

Get all Switch Traps details.

query Parameters
scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

search
string

The search is applied to filter all the fields in the object, ex: search: "eventName".

firstEventTime
required
string

"firstEventTime" is the first event time in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

lastEventTime
required
string

"lastEventTime" is the last event time in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

eventName
required
string

Name of the event.

severity
required
string

Severity of the event.

isAcknowledged
required
string

The acknowledge of event status.

siteId
required
string

Unique site identifier.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all events.

Response samples

Content type
application/json
{
}

Acknowledge Switch Traps

Acknowledge Switch Traps by their ids within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of events.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple acknowledged event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Switch Traps

Delete Switch Traps identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of events.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple deleted event ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Acknowledge all QoE events

Acknowledge all QoE events within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Acknowledge all Traps events

Acknowledge all Traps events within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Acknowledge all Switch Traps

Acknowledge all Switch Traps within an organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete all QoE events

Delete all QoE events within an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete all Traps events

Delete all Traps events within an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete all Switch Traps

Delete all Switch Traps within an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

scope
required
string

"scope" is the target: org, site, building, floor, ap.

scopeId
required
Array of strings

An array of scopeId.

required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: eventName. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'eventName': 'QoEAssocRequest'. ex: filter with object: {"eventName":{"contains":"QoE"}}.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all event definitions

Get all event definitions.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all event definitions

Response samples

Content type
application/json
{
}

Update multiple event definitions

Update multiple event definitions.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

An array of event definitions.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the ids of updated event definitions.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update an event definition

Update an event definition.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
severity
required
string

Severity of event definition.

synopsis
required
string

Synopsis of event definition.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the id of updated event definition

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reset event definitions

Reset event definitions.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of event definitions.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the ids of reseted event definitions.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reset all event definitions

Reset all event definitions.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing all the ids of reseted event definitions.

Response samples

Content type
application/json
{
}

Get all event responder

Get all event responder.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all event responder data.

Response samples

Content type
application/json
{
}

Create an event responder

Create an event responder.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

A agent name that identifies the responder configuration.

description
string

The description of the event responder.

isEnabled
boolean

Event responder activation status. By default isEnabled parameter value is false.

required
Array of objects

A JSON array containing devices. If there are no devices to be send as a request, then send an empty array.

required
Array of objects

A JSON array containing apGroups. If there are no apGroups to be send as a request, then send an empty array.

required
Array of objects

A JSON array containing sites. If there are no sites to be send as a request, then send an empty array.

filterType
required
string
Enum: "Severity" "Custom"

Type of the filter

filterScope
string
Enum: "ANY" "ALL"

FilterScope allows to set the scope of whether all the selected filter should be applied on the event message for responder action or any one of the selected filter should suffice. The filterscope parameter should be used only when the filter type is 'Custom'.

Array of objects

A JSON array containing filters. This filters parameter should be used only when the filter type is 'Custom'.

severities
Array of strings

A JSON array containing severities. The severities parameter should be used only when the filter type is 'Severity'.

required
object

A JSON object containing the response action to be applied when the filter condition are satisfied by the event message.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all event responder data.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple event responder

Delete multiple event responder identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of event responder

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing multiple deleted event responder ids.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update an event responder

Update an event responder within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

A agent name that identifies the responder configuration.

description
string

The description of the event responder.

isEnabled
boolean

Event responder activation status. By default isEnabled parameter value is false.

required
Array of objects

A JSON array containing devices. If there are no devices to be send as a request, then send an empty array.

required
Array of objects

A JSON array containing apGroups. If there are no apGroups to be send as a request, then send an empty array.

required
Array of objects

A JSON array containing sites. If there are no sites to be send as a request, then send an empty array.

filterType
required
string
Enum: "Severity" "Custom"

Type of the filter

filterScope
string
Enum: "ANY" "ALL"

FilterScope allows to set the scope of whether all the selected filter should be applied on the event message for responder action or any one of the selected filter should suffice. The filterscope parameter should be used only when the filter type is 'Custom'.

Array of objects

A JSON array containing filters. This filters parameter should be used only when the filter type is 'Custom'.

severities
Array of strings

A JSON array containing severities. The severities parameter should be used only when the filter type is 'Severity'.

required
object

A JSON object containing the response action to be applied when the filter condition are satisfied by the event message.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all event responder data.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all event settings

Get all event settings.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all event settings

Response samples

Content type
application/json
{
}

Update an event setting

Update an event setting within an organization using JSON

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
event_absorption
string

Enable/disable event absorption.

absorption_period
string

The amount of time, in seconds, Omnivista will 'absorb' similar events.

days_before_purge
string

Number of days to keep the events before delete.

max_no_of_records
string

Maximum number of events to keep before delete.

responder_max_trap_limit
string

The number of received events that will trigger a event responder e-mail.Limit(0-10000)

responder_max_time_limit
string

The Maximum time period, in minutes, that can elapse before a event responder e-mail is trigged.Limit(0-60)

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing event settings update.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the wips policy

Get the wips policy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the data of the policy.

Response samples

Content type
application/json
{
}

Update wips policy

Update wips policy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
orgId
required
string

Id of the organization.

isSignalStrengthThresholdEnabled
required
boolean

The enable/disable status of the signal strength threshold. True for enable and false for dissable.

signalStrengthThreshold
required
integer <int32>

The value of the signal strength threshold. (Range = 50 - 95)

isDetectSSIDEnabled
required
boolean

The enable/disable status of the detect SSID. True for enable and false for dissable.

isRogueSSIDEnabled
required
boolean

The enable/disable status of the Rogue SSID. True for enable and false for dissable.

rogueSSID
required
Array of strings

The array of rogue SSID.

isRogueOUIEnabled
required
boolean

The enable/disable status of the Rogue OUI. True for enable and false for dissable.

rogueOUI
required
Array of strings

The array of rogue OUI. Ex:['aa:bb:cc']

isFriendlyAPEnabled
required
boolean

The enable/disable status of the friendly AP. True for enable and false for dissable.

friendlyMac
required
Array of strings

The array of friendly AP addresses. Ex:['aa:bb:cc','aa:bb:cc:dd','aa:bb:cc:dd:ee','aa:bb:cc:dd:ee:ff']

isPreventSwitchEnabled
required
boolean

The enable/disable status of the rogue AP containment. True for enable and false for dissable.

isDetectSwitchEnabled
required
boolean

The enable/disable status of the wireless detection. True for enable and false for dissable.

required
Array of objects

An array of wireless attack detection policies.

isDynamicClientBlocklistEnabled
required
boolean

The enable/disable status of the dynamic client blocklist. True for enable and false for dissable.

agingTimeValue
required
string

The value of the aging time.

agingTimeUnit
required
string

The units of the aging time.(Ex: Day or Hour)

maxAuthFailureTimes
required
string

The maximum value of the authentication failure.

maxAuthFailurePeriod
required
string

The maximum period of the authentication failure.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the data of the policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the ap attack details

Get the ap attack details.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of policy details.

Response samples

Content type
application/json
{
}

Get the client attack details

Get the client attack details.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of policy details.

Response samples

Content type
application/json
{
}

Get the aging time details.

Get the aging time details.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the data of the policy.

Response samples

Content type
application/json
{
}

Reset wips policy

Reset wips policy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the data of the policy.

Response samples

Content type
application/json
{
}

Get Interfering AP

Get Interfering AP details.

query Parameters
limit
required
string

The number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: SSID. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'SSID': 'BabbleNet-Free-Wifi'. ex: filter with object: {"SSID":{"contains":"BabbleNet"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: Interfering AP BSSID. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"Interfering AP BSSID":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "34:E7:0B:00:17:20".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all interferingAps.

Response samples

Content type
application/json
{
}

Get Friendly AP

Get Friendly AP details.

query Parameters
limit
required
string

The number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: SSID. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'SSID': 'BabbleNet-Free-Wifi'. ex: filter with object: {"SSID":{"contains":"Babble"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: Friendly AP BSSID. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"Friendly AP BSSID":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "34:E7:0B:00:17:20".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all friendlyAps.

Response samples

Content type
application/json
{
}

Get Rogue AP

Get Rogue AP details.

query Parameters
limit
required
string

The number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: SSID. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'SSID': 'BabbleNet-Free-Wifi'. ex: filter with object: {"SSID":{"contains":"Babble"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: Rogue AP BSSID. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"Rogue AP BSSID":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "34:E7:0B:00:17:20".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all friendlyAps.

Response samples

Content type
application/json
{
}

Get Client associated with Interfering AP

Get Client associated with Interfering AP details.

query Parameters
limit
required
string

The number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: SSID. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'SSID': 'OnePlus 6T'. ex: filter with object: {"SSID":{"contains":"OnePlus"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: Interfering Client Mac. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"Interfering Client Mac":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "22:33:44:56:78:99".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all friendlyAps.

Response samples

Content type
application/json
{
}

Get Client associated with Rogue AP

Get Client associated with Rogue AP details.

query Parameters
limit
required
string

The number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: SSID. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'SSID': 'redmi'. ex: filter with object: {"SSID":{"contains":"redmi"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: Rogue Client Mac. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"Rogue Client Mac":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "24:35:41:56:78:99".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all friendlyAps.

Response samples

Content type
application/json
{
}

Move Interfering/Rogue AP to Friendly AP

Move Interfering/Rogue AP to Friendly AP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
aps
required
Array of strings

Array of AP macAdress, to be added as friendly AP

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing all friendlyAps.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Wireless Attack Client

Get Wireless Attacks Client details.

query Parameters
limit
required
string

The number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: Client Attack Detection. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'Client Attack Detection': 'Detect DHCP Conflict'. ex: filter with object: {"Client Attack Detection":{"contains":"DHCP Conflict"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: Attack Client MAC. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"Attack Client MAC":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "34:E7:0B:00:17:20".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing the attack client.

Response samples

Content type
application/json
{
}

Get Wireless Attack AP

Get Wireless Attacks AP details.

query Parameters
limit
required
string

The number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

filters
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: AP Attack Detection. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'AP Attack Detection': 'Detect Long SSID'. ex: filter with object: {"AP Attack Detection":{"contains":"Detect"}}.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: AP Attack BSSID. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"AP Attack BSSID":"ASC"}]

search
string

The search is applied to filter all the fields in the object, ex: search: "34:E7:0B:00:17:20".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of JSON objects containing the attack AP.

Response samples

Content type
application/json
{
}

Get Client Blocklist

Get Blocklisted client data.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the blocklisted client data.

Response samples

Content type
application/json
{
}

Get Rogue AP and Clients

Get Rogue AP and Client Analytics.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the rogue data.

Response samples

Content type
application/json
{
}

Get Top Attacks

Get Top Attacks.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
object

List of top attacks.

Response samples

Content type
application/json
{
}

Get RogueAP Detected count

Get RogueAP Detected count.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Count of rogue ap detected.

Response samples

Content type
application/json
{
}

Get RogueAP Detected List

Get RogueAP Detected List.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

List of rogue ap detected.

Response samples

Content type
application/json
{
}

Get RogueAP Prevented count

Get RogueAP Prevented count.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Count of rogue ap prevented.

Response samples

Content type
application/json
{
}

Get RogueAP Prevented List

Get RogueAP Prevented List.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

List of rogue ap prevented.

Response samples

Content type
application/json
{
}

Get Rogue Client count

Get Rogue Client count.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Count of rogue client.

Response samples

Content type
application/json
{
}

Get Rogue Client List

Get Rogue Client List.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

List of rogue client.

Response samples

Content type
application/json
{
}

Get Block Client count

Get Block Client count.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Count of block client.

Response samples

Content type
application/json
{
}

Get Block Client List

Get Block Client List.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

List of block client.

Response samples

Content type
application/json
{
}

Get DeAuth Client count

Get DeAuth Client count.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Count of deauth client.

Response samples

Content type
application/json
{
}

Get DeAuth Client List

Get DeAuth Client List.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-10-22T04:30:00.000Z.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

List of deauth client.

Response samples

Content type
application/json
{
}

Get events by client.

Get the related events to a specific client identified by providing the client mac address

query Parameters
staMac
required
string

This is the mac address of a client.

startDate
required
string

"startDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

endDate
required
string

"endDate" is the start date of the period in ISO8601 format: YYYY-MM-DDTHH:mm:ss.sssZ, ex: 2021-09-22T04:30:00.000Z.

limit
required
string

the number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

sort
string

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: eventName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"eventName":"ASC"}]

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing events.

Response samples

Content type
application/json
{
}

Building

Get all site buildings

Fetch all buildings associated to a given organization and site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all site buildings.

Response samples

Content type
application/json
{
}

Create a Building

Register a new building in a given organization and site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the building.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a building

Fetch one building identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the site building.

Response samples

Content type
application/json
{
}

Update a building

Update one building identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the building.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated site building.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a building

Delete a building identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted site building.

Response samples

Content type
application/json
{
}

Get all buildings and theirs floors of a site

Fetch all buildings and the associated floors of a given site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all site buildings and their floors.

Response samples

Content type
application/json
{
}

Floor

Get all building floors

Fetch all floors associated to a given building.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all floors of the building.

Response samples

Content type
application/json
{
}

Create a Floor

Register a new floor in a given organization, site and building.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the floor. Ex: Basement

floorNumber
required
integer <int32>

The floor number.

floorPlanUrl
required
string

The image location name where the floor plan image has been uploaded. Ex: 423c45b9-7396-4c09-8945-c7b3a8ed4940.png

object

The floor map coordinates, in geojson format. Must contain the latitude and longitude of the four floor map corners. Check response samples for expected format.

relativeAltitude
required
string

The relative altitude of the floor. (in meters)

object

The lat/long coordinates of the area polygon, in geojson format.

area
required
string

The size of the area.

areaUnit
required
string
Enum: "squareMeters" "squareFeets"

The unit of the given area. Must be one of 'squareMeters', 'squareFeets'.

buildingId
required
string

The building id where the floor is located.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a floor

Fetch one floor identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the floor.

Response samples

Content type
application/json
{
}

Update a floor

Update one floor identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the floor. Ex: Basement

floorNumber
required
integer <int32>

The floor number.

floorPlanUrl
required
string

The image location name where the floor plan image has been uploaded. Ex: 423c45b9-7396-4c09-8945-c7b3a8ed4940.png

object

The floor map coordinates, in geojson format. Must contain the latitude and longitude of the four floor map corners. Check response samples for expected format.

relativeAltitude
required
string

The relative altitude of the floor. (in meters)

object

The lat/long coordinates of the area polygon, in geojson format.

area
required
string

The size of the area.

areaUnit
required
string
Enum: "squareMeters" "squareFeets"

The unit of the given area. Must be one of 'squareMeters', 'squareFeets'.

buildingId
required
string

The building id where the floor is located.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated floor.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a floor

Delete a floor identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted floor.

Response samples

Content type
application/json
{
}

Loginhistory

Get user login history

Get login history for the logged user.

query Parameters
limit
integer

The numbers of items to return

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing user's login history.

Response samples

Content type
application/json
{
}

Usersettings

Get user's settings

Get user's settings for the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update user's settings

Update user's settings for the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
isLoginHistoryEnabled
boolean

Indicates if the user login's history is stored in database.

theme
string
Enum: "DEFAULT" "ALE"

Selected theme assigned to the user profile.

chartColorScheme
string
Enum: "GENERIC" "BLUEGRADIENT"

Preferred color for the display of chart, graph and bar.

tableDisplayMode
string
Enum: "MEDIUM" "SMALL"

The preferred mode for the display of table.

preferredDeviceNaming
string
Enum: "IP_ADDRESS" "SYSTEM_NAME" "IP_ADDRESS_AND_SYSTEM_NAME" "SYSTEM_NAME_AND_IP_ADDRESS" "IPV6_ADDRESS_AND_SYSTEM_NAME" "SYSTEM_NAME_AND_IPV6_ADDRESS" "MAC_ADDRESS" "MESH_LABEL_AND_IP_ADDRESS" "MESH_LABEL_AND_IPV6_ADDRESS"

The preferred way for the display of the device name.

gridDisplayMode
string
Enum: "CARD" "LIST"

The preferred display mode of list items in the page in table or in card list.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Qoe

Get WLAN thresholds for a given site.

Get WLAN thresholds for a given site. Those thresholds are taken into account in the calculation of the WLAN Analytics data.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update WLAN thresholds for a given site.

Update WLAN thresholds values for a given site. Those thresholds are then taken into account in the calculation of the WLAN Analytics data. Each threshold can be updated independently.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
timeToConnectThreshold
string

Time to to connect thereshold.

coverageThreshold
string

Coverage threshold.

roamingThreshold
string

Roaming Threshold.

cpuAPThreshold
integer <int32>

CPU Usaged threshold for Access Point.

memoryAPThreshold
integer <int32>

Memory Usaged threshold for Access Point.

flashAPThreshold
integer <int32>

Flash memory Usaged threshold for Access Point.

availableCapacityThreshold
string

Available Capacity threshold in percentage for Access Point.

clientHealth2_4GThreshold
string

Client Health (2.4 GHz) threshold.

clientHealth5GThreshold
string

Client Health (5 GHz) threshold.

clientHealth6GThreshold
string

Client Health (6 GHz) threshold.

clientSNR2_4GThreshold
string

Client SNR (2.4 GHz) threshold.

clientSNR5GThreshold
string

Client SNR (5 GHz) threshold.

clientSNR6GThreshold
string

Client SNR (6 GHz) threshold.

radioNoise2_4GThreshold
string

Radio noise (2.4 GHz) threshold.

radioNoise5GThreshold
string

Radio noise (5 GHz) threshold.

radioNoise6GThreshold
string

Radio noise (6 GHz) threshold.

radioUtilization2_4GThreshold
string

Radio utilization (2.4 GHz) threshold.

radioUtilization5GThreshold
string

Radio utilization (5 GHz) threshold.

radioUtilization6GThreshold
string

Radio utilization (6 GHz) threshold.

radioInterference2_4GThreshold
string

Radio interference (2.4 GHz) threshold.

radioInterference5GThreshold
string

Radio interference (5 GHz) threshold.

radioInterference6GThreshold
string

Radio interference (6 GHz) threshold.

retransmissionThreshold
string

Retransmission threshold.

errorThreshold
string

Error threshold.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get QoE metrics for all organization sites

Get a summary of QoE metrics (Time-to-Connect, Coverage, Roaming, Successful Connects, Capacity) for each site that belongs to the specified organization. Those metrics are calculated based on the thresholds defined for each site.

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
number

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Get QoE Time To Connect data

Get the Time To Connect QoE attribute along with a split up of the times spent in Association, Authorization and DHCP applied to a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is ap. Note: when scope is ap, all the MAC Address shoud belong to the same site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the summary, chronology and classifier failures reasons of the Time To Connect attribute.

Response samples

Content type
application/json
{
}

Get QoE Time To Connect classifiers data

Get the Time To Connect Classifiers QoE attribute along with a split up of the times spent in Association, Authorization and DHCP applied to a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is ap. Note: when scope is ap, all the MAC Address shoud belong to the same site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the classifier failures reasons of the Time To Connect attribute and consolidated data for each classifier

Response samples

Content type
application/json
{
}

Get QoE Successful Connects data

Get the number of Successful Connects and the classified failure reasons applied to a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the summary, chronology and classifier failures reasons of the QoE Successful connects attribute.

Response samples

Content type
application/json
{
}

Get QoE Successful Connections Classifiers data

Get the Successful Connections Classifiers QoE attribute along with a split up of the times spent in Association, Authorization and DHCP applied to a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the classifiers, consolidatedData and the request object of the successful connections classifiers.

Response samples

Content type
application/json
{
}

Get QoE Coverage data

Get the Coverage RSSI signal and the classified failures reasons applied to a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is ap. Note: when scope is ap, all the MAC Address shoud belong to the same site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the summary, chronology and classifier failures of the QoE Coverage attribute.

Response samples

Content type
application/json
{
}

Get QoE Available Capacity data

Get QoE Available Capacity of Access Points presented in a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is ap. Note: when scope is ap, all the MAC Address shoud belong to the same site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the summary, chronology and classifier failures of the QoE Available Capacity attribute.

Response samples

Content type
application/json
{
}

Get QoE Available Capacity Classifiers data

Get the Available Capacity Classifiers QoE of AP devices and clients in an identified scope during a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is ap. Note: when scope is ap, all the MAC Address shoud belong to the same site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the classifiers, consolidatedData and the request object of the Available Capacity classifiers.

Response samples

Content type
application/json
{
}

Get QoE Roaming data

Get QoE Roaming data applied to a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is ap. Note: when scope is ap, all the MAC Address shoud belong to the same site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the summary, chronology and classifier failures of the QoE Roaming attribute.

Response samples

Content type
application/json
{
}

Get QoE Coverage Classifiers data

Get the Coverage Classifiers to a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is ap. Note: when scope is ap, all the MAC Address shoud belong to the same site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the classifiers of the QoE Coverage attribute.

Response samples

Content type
application/json
{
}

Get QoE Roaming Failed Classifiers data

Get QoE Roaming Classifiers data applied to a given scope in a specified period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is ap. Note: when scope is ap, all the MAC Address shoud belong to the same site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON objects containing the classifiers, consolidatedData and the request object of the QoE Roaming classifiers.

Response samples

Content type
application/json
{
}

Retrieve AP Link uptime/downtime

Get the Link uptime/downtime of Access Points.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

devType
required
string

"devType" is the target: ap, switch_sn or all.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all the details about the Uptime of the Devices that belongs to the selected scope.

Response samples

Content type
application/json
{
}

Subscription

Get the subscription attached to a given organization.

Get the subscription attached to a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Request subscription for given organization

Request the activation of a susbcription for a given organization. Once the application has been submitted, it will be processed and approved or rejected. You will receive an e-mail when your request has been processed.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
aleRepresentativeNames
required
Array of arrays

An array of ALE representative names. At least one is required.

aleRepresentativeEmails
required
Array of arrays

An array of ALE representative e-mail addresses. At least one is required.

startDate
required
string

The start date expected of the subscription. (In format: YYYY-MM-DD , eg 2021-07-03).

expectedDuration
required
integer <int32>

The expected duration of the subscription (Between 90 and 360 days). 90 days is the default value. In you want to request more, you will have to specific a business argument.

partnerCRDID
string

The CRD ID of the partner. (If known)

partnerName
string

The name of the partner. (If known)

partnerContactName
string

The contact name of the partner. (If known)

partnerContactEmail
string

The contact email of the partner. (If known)

allowedDevices
required
string

The requested number of devices allowed to be managed inside the subscription (Between 20 and 10 000). 20 days is the default value. In you want to request more, you will have to specific a business argument.

businessArgument
string

A business argument. Mandatory if you change the default value of expectedDuration of allowedDevices properties.

isRAPRequested
boolean

The status to check the request allow organization is RAP or not

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Request update for an approved subscription

Request more device or request to extend the end date of an approved susbcription. Once the request has been sent, it will be processed and approved or rejected. You will receive an e-mail when your request has been processed.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
newEndDate
required
string

The new expected end date for the subscription, if you don't want to extend it, send its current end date. (In format: YYYY-MM-DD , eg 2021-07-03).

newAllowedDevices
required
integer <int32>

The new requested number of devices to be managed inside the subscription (Between the current number of allowedDevices and 10 000), if you don't want to extend it, send its current value.

businessArgument
required
string

A business argument, explaining why do you want more device or extend the end date.

isRAPRequested
boolean

The status to check the request allow organization is RAP or not

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Request update for an Expired subscription

Request more devices or to request to extend the end date of an expired susbcription. Once the request has been sent, it will be processed and approved or rejected. You will receive an e-mail when your request has been processed.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
newEndDate
required
string

The new expected end date for the subscription, if you don't want to extend it, send its current end date. (In format: YYYY-MM-DD , eg 2021-07-03).

newAllowedDevices
required
integer <int32>

The new requested number of devices to be managed inside the subscription (Between the current number of allowedDevices and 10 000), if you don't want to extend it, send its current value.

businessArgument
required
string

A business argument, explaining why do you want more device or extend the end date.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Useractivity

Export a user's activity

Export activities for a given user between two dates

query Parameters
startDate
required
string

"startDate" is the start date of the period in ISO8601 format.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Walltype

Get all wall types

Fetch all wall types available in the solution. (The wall type id is required to create a new wall)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all wall types.

Response samples

Content type
application/json
{
}

Wall

Get site walls

Fetch all walls associated to a given site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all site walls.

Response samples

Content type
application/json
{
}

Get building walls

Fetch all walls located in a given building.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all building walls.

Response samples

Content type
application/json
{
}

Get floor walls

Fetch all walls located in a given floor of a given building.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all floor walls.

Response samples

Content type
application/json
{
}

Create a wall

Cretae a new wall in a floor.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the wall.

wallTypeId
required
string

A unique Id of a walltype identifying the material and the color of the wall.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a wall

Fetch one wall identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the wall.

Response samples

Content type
application/json
{
}

Delete a wall

Delete a wall identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON Object containing the id of the deleted wall

Response samples

Content type
application/json
{
}

Update a wall

Update one wall identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the wall.

wallTypeId
required
string

A unique Id of a walltype identifying the material and the color of the wall.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated wall.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update a wall geometry

Update the geometry of one wall identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the wall.

wallTypeId
required
string

A unique Id of a walltype identifying the material and the color of the wall.

object

The lat/long coordinates of the line, in geojson format.

distance
required
integer <int32>

The distance value of the wall.

distanceUnit
required
string
Enum: "meters" "feets"

The distance unit.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated wall.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Wifirtls

Retrieve fingerprint heatmap

Get the fingerprint heatmap of a floor identified by its id, or a set of devices identified by their MAC address.

query Parameters
deviceMACs
string

The list of AP MAC address in this floor. If it is not provided, the fingerprint is calculated with all the AP in the floor, unless, the fingerprint only takes into account the heatmap of the provided APs.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The list of fingerprint point.

Response samples

Content type
application/json
{
}

Retrieve location of clients

Get the estimated location of clients on a given floor of a given site. This includes location for connected clients (Clients that were connected on one SSID of the network) and unconnected clients (Clients that have been detected on the floor but not connected to any SSID of the network).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Retrieve the proximity, loyalty and dwell time analytics

Get the proximity, loyalty and dwell time analytics of one polygon area in an identified floor.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
type
string
description
string
required
string
properties
string

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Retrieve the historic client heatmap

Get the client heatmap of an identified floor at a moment in the past.

query Parameters
time
required
string

The historic time where to calculate the client fingerprint, it is in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Retrieve the status of fingerprint generation

Get the status of the fingerprint generation process of an identified floor.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Request a new fingerprint

Send a demand to re-genreate the fingerprint heatmap of floor.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Wlananalytics

Retrieve distributed channel assignment

Get the distributed channel assignment

query Parameters
scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the distributed channels and bands.

Response samples

Content type
application/json
{
}

Retrieve the Device health summary

Get the Health usage of the devices in the selected scope.

query Parameters
scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

devType
string

"devType" is the target: ap, switch_sn or all.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

limit
required
string

the number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Retrieve the Access Point Power Details

Get the Power PoE Detail of an Access Point.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing client summary data.

Response samples

Content type
application/json
{
}

Retrieve the Access Point Rf Details

Get the Radio Frequency Detail of an Access Point.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing client summary data.

Response samples

Content type
application/json
{
}

Retrieve the Access Point Health

Get the CPU and Memory usage of AccessPoint in the selected scope.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

macAddress
required
string

This is the mac address of one device. When provided, the analytics data is calculated only for this device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the Access Point device information and usaged resources

Response samples

Content type
application/json
{
}

Retrieve channel utilization percentage

Get the channel utilization percentage.

query Parameters
scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An object containing channel utilization data for different bands.

Response samples

Content type
application/json
{
}

Retrieve Rogue/Interfering Access Points

Get Rogue/Interfering Access Points detected by all Access Points or by only one identified Access Points located in a floor.

query Parameters
apMac
string

This is the mac address of one access point in the floor. When provided, the analytics data is calculated only for this access point, unless it is calculated by all access points in the floor.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the rogue/interfering Access Points.

Response samples

Content type
application/json
{
}

Get connected clients

Get the list of connected clients in a given period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of client list.

Response samples

Content type
application/json
{
}

Retrieve History Wireless client Sessions

Get the list of historical client sessions in period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap, sta.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

search
object

The search applied to search only the value in a specific object field in record. The field name in search object corresponds to the field in one record, for example: clientIp. The search correspond to pair (key, value). The key is a field : "auth8021xName", "clientIp", "clientMac", "portalUsername", "username". The value is the string to search in record. (e.g. :search with object: {key: "clientIp", value: "192.156.54.5"} ).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the sessions of client.

Response samples

Content type
application/json
{
}

Retrieve History Wired clients Sessions

Get the list of historical wired client sessions in period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: site, building, floor, ap, sta.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

search
object

The search applied to search only the value in a specific object field in record. The field name in search object corresponds to the field in one record, for example: clientIp. The search correspond to pair (key, value). The key is a field : "auth8021xName", "clientIp", "clientMac", "portalUsername", "username". The value is the string to search in record. (e.g. :search with object: {key: "clientIp", value: "192.156.54.5"} ).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Retrieve Online Wireless clients

Get the list of Online Wireless client's sessions.

query Parameters
scope
required
string

"scope" is the target: site, building, floor, ap, sta.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap".

limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

search
object

The search applied to search only the value in a specific object field in record. The field name in search object corresponds to the field in one record, for example: clientIp. The search correspond to pair (key, value). The key is a field : "auth8021xName", "clientIp", "clientMac", "portalUsername", "username". The value is the string to search in record. (e.g. :search with object: {key: "clientIp", value: "192.156.54.5"} ).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the sessions of client.

Response samples

Content type
application/json
{
}

Retrieve client Wireless summary

Get the summary of a wireless client.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

staMac
required
string

This is the mac address of a client.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing client summary data.

Response samples

Content type
application/json
{
}

Retrieve client Wired summary

Get the summary of a wired client.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

staMac
required
string

This is the mac address of a client.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing client summary data.

Response samples

Content type
application/json
{
}

Retrieve throughput consumption (Rx/Tx)

Get the throughput consumption (Rx/Tx).

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing throughput consumption data.

Response samples

Content type
application/json
{
}

Retrieve TX Power history

Get TX power history of a given device by providing the device mac address.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

macAddress
required
string

This is the mac address of one device. When provided, the analytics data is calculated only for this device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of Tx Power

Response samples

Content type
application/json
{
}

Retrieve Channel Utilization of a given device.

Get the channel utilization of a given device by providing the device mac address.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

macAddress
required
string

This is the mac address of one device. When provided, the analytics data is calculated only for this device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of channel utilization

Response samples

Content type
application/json
{
}

Retrieve Channel In Used of a given device.

Get the channel in used of a given device by providing the device mac address.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

macAddress
required
string

This is the mac address of one device. When provided, the analytics data is calculated only for this device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of channel in used

Response samples

Content type
application/json
{
}

Retrieve RSSI values evolution of a given client.

Get the RSSI values evolution of a given client by providing the client mac address.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

staMac
required
string

This is the mac address of a client.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of client RSSI values evolution

Response samples

Content type
application/json
{
}

Retrieve Phy Rate values evolution of a given client.

Get the Physical Rate values evolution of a given client by providing the client mac address.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

staMac
required
string

This is the mac address of a client.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of client Phy Rate values evolution

Response samples

Content type
application/json
{
}

Retrieve throughput values evolution of a given client.

Get the throughput values evolution of a given client by his Mac address.

query Parameters
mode
required
string

Type of client. Can be 'wireless' or 'wired'

startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

staMac
required
string

This is the mac address of a client.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing summary of client Throughput values evolution

Response samples

Content type
application/json
{
}

Retrieve client distribution

Get the client distribution across Access Points.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all Access Points with clients number associated.

Response samples

Content type
application/json
{
}

Retrieve client categorization

Get the client categorization in a period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all the categorization of clients.

Response samples

Content type
application/json
{
}

Retrieve list session distribution

Get a distribution of sessions based on a given groupBy label.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

groupBy
required
string

groupBy is used to group data and calculate sum of fields.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON array containing list session distribution datas.

Response samples

Content type
application/json
{
}

The criteria trend by client

Get criteria trend by client

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

criteria
required
string

Criteria is client ranking to be returned.

client-mac[]
required
string

"client-mac" is an array of client mac addresses.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON array containing list session distribution datas.

Response samples

Content type
application/json
{
}

Retrieve wireless connected duration pagination

Get information about the wireless user's connected duration.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

limit
integer

The number of records to fetch from the total records.

offset
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

search
string

The search is applied to filter all the fields in the object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Retrieve wired connected duration pagination

Get information about the wired user's connected duration.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

limit
integer

The number of records to fetch from the total records.

offset
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

search
string

The search is applied to filter all the fields in the object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Retrieve Connected durations

Get information about the average duration of clients sessions.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the clients with their connection duration.

Response samples

Content type
application/json
{
}

Retrieve devices number per user

Get the number of devices used on average per user.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of devices used.

Response samples

Content type
application/json
{
}

Retrieve top N domain names and URLs

Get the top N Domain names and URLs accessed by clients.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

top
required
integer

"top" is the top number of records to retrieve.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing Top N URLs data.

Response samples

Content type
application/json
{
}

Retrieve Client Health

Know the percentage of time in which connected clients experienced poor Client Health, poor Client SNR, High Noise, High Radio Utilization and High Radio Interferences.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

band
required
string

"band" is the radio band frequency, accepts either "2_4G" or "5G" or "combined".

topN
required
string

topN is the number of N highest value for the orderBy value. topN and bottomN attributes cannot be provided in the same request. Please provide either topN or bottomN.

bottomN
required
string

bottomN is the number of N lowest value for the orderBy value. bottomN and topN attributes cannot be provided in the same request. Please provide either bottomN or topN.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing Client Health data.

Response samples

Content type
application/json
{
}

Retrieve SSID usage

Get the usage over time for a given SSID.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

ssidName
required
string

"ssid" is the SSID name of one access point. When provided, the search of SSID name will be done only of this AP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing ssid usages.

Response samples

Content type
application/json
{
}

Retrieve SSID clients

Get the number of clients connected to a given SSID over time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

ssidName
required
string

"ssid" is the SSID name of one access point. When provided, the search of SSID name will be done only of this AP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing ssid clients.

Response samples

Content type
application/json
{
}

Retrieve access points radios

Get access points radios in a given scope.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

band
required
string

"band" is the radio band frequency, accepts either "2_4G" or "5G" or "combined".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing ap radios information.

Response samples

Content type
application/json
{
}

Retrieve access points utilization ranking

Get access points ranking based on utilization

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

orderBy
required
string

The attribute to be sort in ranking. ENUM "maxClients", "avgUsage", "totalData", "uniqueClients"

topN
required
string

topN is the number of N highest value for the orderBy value. topN and bottomN attributes cannot be provided in the same request. Please provide either topN or bottomN.

bottomN
required
string

bottomN is the number of N lowest value for the orderBy value. bottomN and topN attributes cannot be provided in the same request. Please provide either bottomN or topN.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing ap radios information.

Response samples

Content type
application/json
{
}

Retrieve SSID usage detail

Get SSID usage detail

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

ssidName
required
string

"ssid" is the SSID name of one access point. When provided, the search of SSID name will be done only of this AP.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing SSID usage detail.

Response samples

Content type
application/json
{
}

Retrieve radios interferences

Get the radios interferences.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

band
required
string

the radio band frequency, accepts either 2_4G or 5G or combined.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Retrieve Client Session Distribution

Get Client session distribution

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

groupBy
required
string

The data is grouped by this attributes : ENUM "deviceType", "deviceOS", "band", "connectionMode", "apModel", "apVersion", "ssid", "channel", or "vlanId"

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing client session distribution data.

Response samples

Content type
application/json
{
}

Retrieve trend of # of radios with Low/High utilisation

Get trend of # of radios with Low/High utilisation

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

band
required
string

"band" is the radio band frequency, accepts either "2_4G" or "5G" or "combined".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON array containing radios utilisation.

Response samples

Content type
application/json
{
}

Retrieve trend of # of Radios with Low/High Noise

Get trend of # of Radios with Low/High Noise

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

band
required
string

"band" is the radio band frequency, accepts either "2_4G" or "5G" or "combined".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON array containing radios noise.

Response samples

Content type
application/json
{
}

Retrieve Access Points ranking by criteria.

Get Access Points ranking order by criteria.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

band
required
string

"band" is the radio band frequency, accepts either "2_4G" or "5G" or "combined".

orderBy
required
string

The attribute to be sort in ranking, ENUM “avgNoiseFloor”, “nbInterferingDevices”, “avgChannelUtilization”, “micErrors”, “crcErrors”, “rxPhyErrors”, “txPhyErrors”, “channelChanges”, “txPowerChanges”, “clientSpeed” or “maxClients”.

topN
required
string

topN is the number of N highest value for the orderBy value. topN and bottomN attributes cannot be provided in the same request. Please provide either topN or bottomN.

bottomN
required
string

bottomN is the number of N lowest value for the orderBy value. bottomN and topN attributes cannot be provided in the same request. Please provide either bottomN or topN.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing Access Points ranked by the given criteria.

Response samples

Content type
application/json
{
}

Retrieve Clients ranking by criteria.

Get clients list ranking order by criteria

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

orderBy
required
string

The attribute to be sort in ranking, ENUM "signal", "rxRate", "txRate", "rxBytes", "txBytes" or "rxError".

topN
required
string

topN is the number of N highest value for the orderBy value. topN and bottomN attributes cannot be provided in the same request. Please provide either topN or bottomN.

band
required
string

"band" is the radio band frequency, accepts either "2_4G" or "5G" or "combined".

bottomN
required
string

bottomN is the number of N lowest value for the orderBy value. bottomN and topN attributes cannot be provided in the same request. Please provide either bottomN or topN.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing clients ranked by the given criteria.

Response samples

Content type
application/json
{
}

Retrieve the top clients based on usage

Get the top clients based on usage

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

topN
required
string

topN is the number of N clients to be returned.

orderBy
required
string

The attribute to be sort in ranking, ENUM "bytesUsed", "avgRateUsage", "totalSessionsTime" or "nbSession".

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON array containing top clients by usage.

Response samples

Content type
application/json
{
}

Switchanalytics

Get summary of one switch

Get the summary of one switch.

query Parameters
serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Get Switch Port PoE

Get the PoE Status on switch ports.

query Parameters
serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing PoE information.

Response samples

Content type
application/json
{
}

Get Switch Port status

Get the Port information of a Switch.

query Parameters
serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Switch port information.

Response samples

Content type
application/json
{
}

Get Switch CMM Utilization Summary

Get the switch CMM utilization summary .

query Parameters
serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Retrieve switch health evolution

Get the CPU and Memory usage of a switch identified by its serial number.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

chassisId
required
string

This is the chassis Id of the switch. When provided, the analytics data is calculated only for this chassis.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Retrieve switch throughput evolution

Get the average of the rx & rxTx per day, minute and hour of a switch identified by its serial number.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

chassisId
string

This is the chassis Id of the switch. When provided, the analytics data is calculated only for this chassis.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Retrieve switch port vlan list

Get the vlan port list of a switch identified by its serial number.

query Parameters
serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated with the response. (200)

message
string

Status message associated with the response.

Array of objects

An array of JSON objects containing switch port interfaces.

Response samples

Content type
application/json
{
}

Retrieve switch port health evolution

Get the evolution of the port rx & rxTx of a switch identified by its mac.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

port
required
string

Port on the switch on which we want to display the information ("1/1/1", "1/1/2"...)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Retrieve switch ethernet port health evolution

Get the evolution of the ethernet port rx & rxTx of a switch identified by its mac.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

switchMac
required
string

This is the mac address of one switch. When provided, the analytics data is calculated only for this switch.

port
required
string

Port on the switch on which we want to display the information ("1/1/1", "1/1/2"...)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Retrieve Switch Interface port

Get the list of Interface port of Switch in the scope.

query Parameters
scope
string

"scope" is the target: site, building, floor, ap, sta.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

serials[]
string

"serials" is an array of device Serial Number if scope is switch_sn. It is required when scope is switch_sn

limit
integer

The number of records to fetch from the total records.

offset
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing port interface.

Response samples

Content type
application/json
{
}

Retrieve Session Summary of UNP

Get the summary of a UNP client.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

staMac
required
string

This is the mac address of a client.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response data.

Response samples

Content type
application/json
{
}

Retrieve Live UNP and Wired Clients

Get the list of current UNP and wired clients with an active session.

query Parameters
scope
required
string

"scope" is the target:org, site, building, floor, ap, sta, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap" or an array of client MAC Address if scope is "sta". It is required when scope is org, site, building, floor, ap or sta.

serials[]
string

"serials" is an array of device Serial Number if scope is switch_sn. It is required when scope is switch_sn

limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

search
object

The search applied to search only the value in a specific object field in record. The field name in search object corresponds to the field in one record, for example: clientIp. The search correspond to pair (key, value). The key is a field : "auth8021xName", "clientIp", "clientMac", "portalUsername", "username". The value is the string to search in record. (e.g. :search with object: {key: "clientIp", value: "192.156.54.5"} ).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response data.

Response samples

Content type
application/json
{
}

Retrieve History UNP and Wired clients Sessions

Get the list of historical UNP and wired client sessions in period of time.

query Parameters
startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

scope
required
string

"scope" is the target:org, site, building, floor, ap, sta, switch_sn.

scopeId[]
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap" or an array of client MAC Address if scope is "sta". It is required when scope is org, site, building, floor, ap or sta.

serials[]
string

"serials" is an array of device Serial Number if scope is switch_sn. It is required when scope is switch_sn

limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

search
object

The search applied to search only the value in a specific object field in record. The field name in search object corresponds to the field in one record, for example: clientIp. The search correspond to pair (key, value). The key is a field : "auth8021xName", "clientIp", "clientMac", "portalUsername", "username". The value is the string to search in record. (e.g. :search with object: {key: "clientIp", value: "192.156.54.5"} ).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response data.

Response samples

Content type
application/json
{
}

Get Lldp by Switch

Obtain LLDP data for a given switch identified by its serial number.

query Parameters
serialNumber
required
string

This is the serial number of one switch. When provided, the analytics data is calculated only for this switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the LLDP

Response samples

Content type
application/json
{
}

Reporting

Get report templates

Get all default report templates.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the default report templates.

Response samples

Content type
application/json
{
}

Get All Widgets

Get all widgets parameters.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response

object

An object containing arrays of regular and analytics widgets

Response samples

Content type
application/json
{
}

Get user's reports

Get the user's reports in an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Create organization report

Create .

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
dateRange
required
string
Enum: "lasthour" "last24hours" "yesterday" "last7days" "last30days" "lastweek" "lastmonth" "custom"

The time range filter for the widgets. The start and end date will be generated automatically, except for custom: the startDate and endDate are required to be specific the range.

scope
required
string
Enum: "org" "site" "building" "floor" "ap" "switch_sn"

The scope filter for the widgets.

scopeId
Array of strings

"scopeId" is an array of id corresponding to the scope, could be an array of device MAC Address if scope is "ap".

serials
Array of strings

"scopeId" is an array of device Serial Number if scope is "switch_sn".

startDate
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00. It is required if dateRange is custom.

endDate
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00. It is required if dateRange is custom.

timeZone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" … 291 more

Timezone of the user.

object

The search applied to search only the value in a specific object field in record. The field name in search object corresponds to the field in one record, for example: clientIp. The search correspond to pair (key, value). The key is a field : "auth8021xName", "clientIp", "clientMac", "portalUsername", "username". The value is the string to search in record. (e.g. :search with object: {key: "clientIp", value: "192.156.54.5"} ).

Array of objects

The widgets of Analytics data. At least 1 widget has to be presented here. We can paste the list of widgets in a default report template

fileType
string
Enum: "CSV" "PDF" "XLS"

The export file type for analytic single file report.

object

The widget data for export analytic file report, required when sending fileType.

object

By default, a report is an instant report, this scheduler is not required. If the scheduler is defined, the report will be generated and sent automatically starting from tomorrow based on the scheduler information.

name
required
string

The name of report, to be used in generated file's name

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

A JSON object of the report.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple reports

Delete multiples reports by a list of ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of report.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the deleted reports.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get report by Id

Get the user's reports in an organization by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the report.

Response samples

Content type
application/json
{
}

Update report

Update an user's report content or to set scheduled generation by report's id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
dateRange
required
string
Enum: "lasthour" "last24hours" "yesterday" "last7days" "last30days" "lastweek" "lastmonth" "custom"

The time range filter for the widgets. The start and end date will be generated automatically, except for custom: the startDate and endDate are required to be specific the range.

scope
required
string
Enum: "org" "site" "building" "floor" "ap" "switch_sn"

The scope filter for the widgets.

scopeId
Array of strings

"scopeId" is an array of id corresponding to the scope, could be an array of device MAC Address if scope is "ap".

serials
Array of strings

"scopeId" is an array of device Serial Number if scope is "switch_sn".

startDate
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00. It is required if dateRange is custom.

endDate
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00. It is required if dateRange is custom.

timeZone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" … 291 more

Timezone of the user.

object

The search applied to search only the value in a specific object field in record. The field name in search object corresponds to the field in one record, for example: clientIp. The search correspond to pair (key, value). The key is a field : "auth8021xName", "clientIp", "clientMac", "portalUsername", "username". The value is the string to search in record. (e.g. :search with object: {key: "clientIp", value: "192.156.54.5"} ).

Array of objects

The widgets of Analytics data. At least 1 widget has to be presented here. We can paste the list of widgets in a default report template

fileType
string
Enum: "CSV" "PDF" "XLS"

The export file type for analytic single file report.

object

The widget data for export analytic file report, required when sending fileType.

object

Send null for the scheduler to remove the scheduled generation. If the scheduler is defined, the report will be generated and sent automatically starting from tomorrow based on the scheduler information.

name
string

The name of report, to be used in generated file's name

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the report.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete report

Delete a user'report by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

A JSON object of the report.

Response samples

Content type
application/json
{
}

Send report

Send an user's report to the list of email and to update the receiver's emails list in report.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the report.

Response samples

Content type
application/json
{
}

Ssid

Get all SSIDs

Get all SSIDs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Create SSID

Create a new SSID for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

A JSON object of the SSID.

object

The Config Assignment of SSID.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update SSID

Update an SSID for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

A JSON object of the SSID.

Array of objects

The Config Assignment of SSID.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the number of SSIDs by group

Get the number of SSIDs by group for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

data
number

The number of SSIDs in the group.

Response samples

Content type
application/json
{
}

Get SSID by name

Get SSID by name for a given organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple SSIDs by names

Delete multiple ssid by names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The array of the names which are removed.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Externalcaptiveportal

Get all External Captive Portals

Get all External Captive Portals for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the External CP.

Response samples

Content type
application/json
{
}

Create External Captive Portal

Get create External Captive Portals for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: multipart/form-data
required
name
required
string

The name of the profile.

description
required
string

The description of the profile.

file
required
string

The file of the profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the External CP.

Response samples

Content type
application/json
{
}

Update External Captive Portal

Get update External Captive Portals for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
id
required
integer <int32>

The id of the profile.

name
required
string

The name of the profile.

description
string

The description of the profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the External CP.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple External Captive Portal

Get delete multiple External Captive Portals for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The names of the profiles.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get only names External Captive Portals

Get only names External Captive Portals for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the External CP.

Response samples

Content type
application/json
{
}

Get External Captive Portal By Id

Get External Captive Portal by id for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the External CP.

Response samples

Content type
application/json
{
}

Sync External Captive Portal to all aps

Get only names External Captive Portals for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
Array of arrays

The JSON array ids associated to the response.

Response samples

Content type
application/json
{
}

Download External Captive Portals

Download External Captive Portals for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The names of the profiles.

Responses

Response Schema: application/json
data
object

The file download of the external captive portal.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Arp

Get all ARPs

Get all ARPs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the ARP

Response samples

Content type
application/json
{
}

Create an ARP

Create a new ARP for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The attribute of the ARP.

object

The Config Assignment of ARP.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the ARP

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update an ARP

Update ARPs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The attribute of the ARP.

Array of objects

The Config Assignment of ARP.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the ARP

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple ARPs by organization

Delete multiple ARPs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The array of the names of the ARP

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the ARP

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the ARP by name

Get the ARP by name for a given organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the ARP

Response samples

Content type
application/json
{
}

Get the ARP by Id

Get the ARP by Id for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the ARP

Response samples

Content type
application/json
{
}

Arpdeviceconfig

Get all ARP Device Configs

Get all ARP Device Configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of ARP Device Configs of the organization.

Response samples

Content type
application/json
{
}

Get all ARP Device Configs By Ids

Get all ARP Device Configs by device config ids for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of numbers

The ids of the device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An array of ARP Device Configs of the organization.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update ARP Device Configs

Update ARP Device Configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The data associated to ARP device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of ARP Device Configs of the organization.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete ARP Device Configs

Delete ARP Device Configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of numbers

The ids of the device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of ARP Device Configs of the organization.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Client802_1xcertificate

Get all Client 802.1X Certificates

Get all client 802.1X certificates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the client 802.1X certificate.

Response samples

Content type
application/json
{
}

Create Client 802.1X Certificate

Create client 802.1X certificate for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data

Request Body schema: multipart/form-data
required
name
required
string

The name of the client 802.1X certificate.

apCertificate
required
object

The CA file of the client 802.1X certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

privateKey
required
object

The private key file of the client 802.1X certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

keyPassword
string

The key password of the client 802.1X certificate.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the client 802.1X certificate.

Response samples

Content type
application/json
{
}

Delete multiple Client 802.1X Certificates

Delete multiple client 802.1X certificates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

A list of client 802.1X certificate names to delete.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.(200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all Client 802.1X Certificate names

Get all client 802.1X certificate names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the client 802.1X certificate.

Response samples

Content type
application/json
{
}

Download Client 802.1X Certificate

Download client 802.1X certificate for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The client 802.1X certificate name needs to download.

Responses

Request samples

Content type
application/json
{
}

Stellarblecertificate

Get all Stellar BLE Certificates

Get all Stellar BLE Certificates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Stellar BLE Certificate.

Response samples

Content type
application/json
{
}

Create Stellar BLE Certificate

Create Stellar BLE Certificate for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: multipart/form-data
required
name
required
string

The name of the Stellar BLE Certificate.

caFile
required
object

The CA file of the Stellar BLE Certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

serverFile
required
object

The server file of the Stellar BLE Certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

keyFile
required
object

The key file of the Stellar BLE Certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

keyPasswd
string

The key password of the Stellar BLE Certificate.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Stellar BLE Certificate.

Response samples

Content type
application/json
{
}

Delete multiple Stellar BLE Certificates

Delete multiple Stellar BLE Certificates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

A list of Stellar Ble Certificate names to delete.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.(200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Stellar BLE Certificate by id

Get Stellar BLE Certificate by id for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Stellar BLE Certificate.

Response samples

Content type
application/json
{
}

Get all Stellar BLE Certificate names

Get all Stellar BLE certificate names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Stellar BLE Certificate.

Response samples

Content type
application/json
{
}

Download Stellar BLE Certificate

Download Stellar BLE Certificate for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The Stellar BLE Certificate name needs to download.

Responses

Request samples

Content type
application/json
{
}

Stellarwifirtlscertificate

Get all Stellar WIFI RTLS Certificates

Get all Stellar WIFI RTLS Certificates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Stellar WIFI RTLS Certificate.

Response samples

Content type
application/json
{
}

Create Stellar WIFI RTLS Certificate

Create Stellar WIFI RTLS Certificate for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: multipart/form-data
required
name
required
string

The name of the Stellar WIFI RTLS Certificate.

caFile
required
object

The CA file of the Stellar WIFI RTLS Certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

serverFile
required
object

The server file of the Stellar WIFI RTLS Certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

keyFile
required
object

The key file of the Stellar WIFI RTLS Certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

keyPasswd
string

The key password of the Stellar WIFI RTLS Certificate.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Stellar WIFI RTLS Certificate.

Response samples

Content type
application/json
{
}

Delete multiple Stellar WIFI RTLS Certificates

Delete multiple Stellar WIFI RTLS Certificates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

A list of Stellar WIFI RTLS Certificate names to delete.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.(200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Stellar WIFI RTLS Certificate by id

Get Stellar WIFI RTLS Certificate by id for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Stellar WIFI RTLS Certificate.

Response samples

Content type
application/json
{
}

Get all Stellar WIFI RTLS Certificate names

Get all Stellar WIFI RTLS certificate names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Stellar WIFI RTLS Certificate.

Response samples

Content type
application/json
{
}

Download Stellar WIFI RTLS Certificate

Download Stellar WIFI RTLS Certificate for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The Stellar WIFI RTLS Certificate name needs to download.

Responses

Request samples

Content type
application/json
{
}

Syslogovertlscertificate

Get all Syslog Over TLS Certificates

Get all Syslog Over TLS Certificates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Syslog Over TLS Certificate.

Response samples

Content type
application/json
{
}

Create Syslog Over TLS Certificate

Create Syslog Over TLS Certificate for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data

Request Body schema: multipart/form-data
required
name
required
string

The name of the Syslog Over TLS Certificate.

caFile
required
object

The CA file of the Syslog Over TLS Certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Syslog Over TLS Certificate.

Response samples

Content type
application/json
{
}

Delete multiple Syslog Over TLS Certificates

Delete multiple Syslog Over TLS Certificates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
names
required
Array of strings

A list of Syslog Over TLS Certificate names to delete.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.(200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Syslog Over TLS Certificate by ID

Get Syslog Over TLS Certificate by ID for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Syslog Over TLS Certificate.

Response samples

Content type
application/json
{
}

Get all Syslog Over TLS Certificate names

Get all Syslog Over TLS certificate names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Syslog Over TLS Certificate.

Response samples

Content type
application/json
{
}

Download Syslog Over TLS Certificate

Download Syslog Over TLS Certificate for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The Syslog Over TLS Certificate name needs to download.

Responses

Request samples

Content type
application/json
{
}

Rftemplate

Get all RF Templates

Get all RF Templates for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all RF Templates.

Response samples

Content type
application/json
{
}

Create an RF Template

Create RF Template for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the RF Template. Size: 1 - 32 characters.

description
string

The description of the RF Template. Size: 1 - 255 characters

countryCode
required
string

The code of country where the site is located. Ex: VN

bandSteering
required
boolean

An optimization option which can automatically steer clients connecting to a wireless network to the best frequency band available and supported

bandSteeringForce5g
required
boolean

Force clients connecting to 5G band

bandSteeringForce6g
boolean

Force clients connecting to 6G band

excludeMacOUILists
string

List of MAC OUIs which are excluded by the band steering option. EX: 11:22:33

associationRSSIThreshold2
required
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

associationRSSIThreshold5A
required
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

associationRSSIThreshold5L
required
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

associationRSSIThreshold5H
required
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

associationRSSIThreshold6
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

roamingRSSIThreshold2
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

roamingRSSIThreshold5A
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

roamingRSSIThreshold5H
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

roamingRSSIThreshold5L
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

roamingRSSIThreshold6
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

dynamicLoadBalance
required
boolean

Enable or disable the Dynamic Load Balance

backgroundScanning
required
boolean

Enable/Disable background scanning ability

scanningInterval
required
integer <int32>

Configure the interval for scanning. Its value should be in [5 - 10800]

scanningDuration
required
integer <int32>

The duration in each scanning time. Its value should be in [50 - 110]

scanningChannel
required
string
Enum: "workChannel" "allChannels"

Performance optimization option. This is to enable/disable airtime fairness for 2.4G and 5G bands

voiceAndVideoAwareness
required
boolean

Enable or disable voice/video awareness

defaultSetting
required
boolean

Disable to set custom bandwidth settings. Enable to reset bandwidth settings to default values.

band2
required
boolean

Configure the working radio for the AP. True if 2.4G band radio is activated

band5A
required
boolean

Configure the working radio for the AP. True if 5G band radio will be activated. It is used to set the full band 5G radio on other AP series.

band5H
required
boolean

Configure the working radio for the AP. True if 5.8G band radio will be activated. It is used to set the 5.8G radio on OAW AP-123x.

band5L
required
boolean

Configure the working radio for the AP. True if 5.2G band radio will be activated. It is used to set the 5.2G radio on OAW AP-123x

band6
required
boolean

Configure the working radio for the AP.

channelSetting2
required
string

The working channel of the radio. This field must be in values as AUTO, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13.

channelSetting5A
required
string

The working channel of the radio. This field must be in list's values: (5G Low + 5G High)

channelSetting5H
required
string

The working channel of the radio. This field must be in values as AUTO, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165

channelSetting5L
required
string

The working channel of the radio. This field must be in values as AUTO, 36, 40, 44, 48, 52, 56, 60, 64

channelSetting6
required
string

The working channel of the radio.

channelWidth2
required
string

Configures the channel width. This field must be in values as 0, 20

channelWidth5A
required
string

Configures the channel width. This field must be in values as 0, 20, 40, 80

channelWidth5H
required
string

Configures the channel width. This field must be in values as EX: 0, 20, 40, 80

channelWidth5L
required
string

Configures the channel width. This field must be in values as 0, 20, 40, 80

channelWidth6
string

The 6G Channel Width setting for the profile.

powerSetting2
required
string

Configures the transmit power of the wireless radio. The PowerSetting in range 3..40 OR AUTO string value

powerSetting5A
required
string

Configures the transmit power of the wireless radio. The PowerSetting in range 3..40 OR AUTO string value

powerSetting5H
required
string

Configures the transmit power of the wireless radio. The PowerSetting in range 3..40 OR AUTO string value

powerSetting5L
required
string

Configures the transmit power of the wireless radio. The PowerSetting in range 3..40 OR AUTO string value

powerSetting6
string

The 6G Power setting for the profile.

channelList5A
required
string

If enabled, the available channel(s) that can be selected by DRM. This field must be in values as empty, 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165

channelList5H
required
string

If enabled, the available channel(s) that can be selected by DRM. This field must be in values as empty, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165

channelList5L
required
string

If enabled, the available channel(s) that can be selected by DRM. This field must be in values as empty, 36, 40, 44, 48, 52, 56, 60, 64

channelList6
string

The 6G Channel List for the profile.

channelDRM5A
required
boolean

The Channel DRM administrative status (On/Off)

channelDRM5H
required
boolean

The Channel DRM administrative status (On/Off)

channelDRM5L
required
boolean

The Channel DRM administrative status (On/Off)

channelDRM6
boolean

The channel DRM of RF Profile.

shortGuardInterval2
required
boolean

Enables/Disables Short Guard Interval for 2.4G radio

shortGuardInterval5A
required
boolean

Enables/Disables Short Guard Interval for 5G radio

shortGuardInterval5L
required
boolean

Enables/Disables Short Guard Interval for 5.2G radio

shortGuardInterval5H
required
boolean

Enables/Disables Short Guard Interval for 5.8G radio

shortGuardInterval6
boolean

The short guard interval 6 of tha profile.

minTXPower2
required
string

Specify the minimum transmit power for auto power setting. The value in range 3..40 or empty.

minTXPower5A
required
string

Specify the minimum transmit power for auto power setting. The value in range 3..40 or empty.

minTXPower5L
required
string

Specify the minimum transmit power for auto power setting. The value in range 3..40 or empty.

minTXPower5H
required
string

Specify the minimum transmit power for auto power setting. The value in range 3..40 or empty.

minTXPower6
string

The minimum transmit power for auto power setting, if configured.

maxTXPower2
required
string

Specify the maximum transmit power for auto power setting. The value in range 3..40 or empty.

maxTXPower5A
required
string

Specify the maximum transmit power for auto power setting. The value in range 3..40 or empty.

maxTXPower5L
required
string

Specify the maximum transmit power for auto power setting. The value in range 3..40 or empty.

maxTXPower5H
required
string

Specify the maximum transmit power for auto power setting. The value in range 3..40 or empty.

maxTXPower6
string

The maximum transmit power for auto power setting, if configured.

airtimeFairness2G
required
boolean

The administrative status of the Airtime Fairness feature for 2G band radio (On/Off)

airtimeFairness5G
required
boolean

The administrative status of the Airtime Fairness feature for 5G band radio (On/Off)

externalAntennasGain2
required
string

The gain value of 2.4G band for the external antennas used by the APs mapping to this RF profile. The value in range [1d..16d]

externalAntennasGain5A
required
string

The gain value of 2.4G band for the external antennas used by the APs mapping to this RF profile. The value in range [1d..16d]

externalAntennasGain5L
required
string

The gain value of 2.4G band for the external antennas used by the APs mapping to this RF profile. The value in range [1d..16d]

externalAntennasGain5H
required
string

The gain value of 2.4G band for the external antennas used by the APs mapping to this RF profile. The value in range [1d..16d]

externalAntennasGain6
string

Configure the gain value of 6G band for the external antennas used by the APs mapping to this RF profile.

clientAwareness2
required
boolean

Client Aware Feature administrative status (On/Off)

clientAwareness5A
required
boolean

Client Aware Feature administrative status (On/Off)

clientAwareness5H
required
boolean

Client Aware Feature administrative status (On/Off)

clientAwareness5L
required
boolean

Client Aware Feature administrative status (On/Off)

clientAwareness6
required
boolean

Client Aware Feature administrative status (On/Off)

muMimo2
required
boolean

The administrative status of the MU-MIMO feature for 2.4G radio

muMimo5H
required
boolean

The administrative status of the MU-MIMO feature for 2.4G radio

muMimo5A
required
boolean

The administrative status of the MU-MIMO feature for 2.4G radio

muMimo5L
required
boolean

The administrative status of the MU-MIMO feature for 2.4G radio

muMimo6
boolean

The administrative status of the MU-MIMO feature for 6G radio.

highEfficiency2
required
boolean

The administrative status of the 'High Efficiency' feature for 2.4G radio

highEfficiency5L
required
boolean

The administrative status of the 'High Efficiency' feature for 5.2G radio

highEfficiency5H
required
boolean

The administrative status of the 'High Efficiency' feature for 5.8G radio

highEfficiency5A
required
boolean

The administrative status of the 'High Efficiency' feature for 5G radio

highEfficiency6
required
boolean

The administrative status of the 'High Efficiency' feature for 6G radio. This field value is always 'true' because this is enabled by default and cannot be disabled for the 6GHz band.

beaconInterval2
required
integer <int32>

The 2.4G radio Beacon Interval. The value in range [60..500]

beaconInterval5A
required
integer <int32>

The 5G radio Beacon Interval. The value in range [60..500]

beaconInterval5L
required
integer <int32>

The 5.2G radio Beacon Interval. The value in range [60..500]

beaconInterval5H
required
integer <int32>

The 5.8G radio Beacon Interval. The value in range [60..500]

beaconInterval6
integer <int32>

The 6G radio Beacon Interval.

csa2
boolean

The CSA 2 of the profile.

csa5A
boolean

The CSA 5A of the profile.

csa5H
boolean

The CSA 5H of the profile.

csa5L
boolean

The CSA 5L of the profile.

csa6
boolean

The CSA 6 of the profile.

csaCount2
integer <int32>

The CSA count 2 of the profile.

csaCount5L
integer <int32>

The CSA count 5L of the profile.

csaCount5H
integer <int32>

The CSA count 5H of the profile.

csaCount5A
integer <int32>

The CSA count 5A of the profile.

csaCount6
integer <int32>

The CSA count 6 of the profile.

drmInterval
required
string

The DRM interval (in hours) for the channel reassignment (Range: 0.5 - 12). This field only accepts one decimal place.

drmStartTime
required
string

The DRM start time for the channel reassignment. Format data is hh:mm (hh should be a full hour from 00 to 23 and mm should be a full minute from 00 to 59).

drmTimeControl
required
boolean

Enable/disable the DRM Time Control function.

Array of objects

The array of Radio Settings for the specific AP models.

extremelyHighThroughput2
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 2.4G radio.

extremelyHighThroughput5A
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 5G radio.

extremelyHighThroughput5H
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 5.8G radio.

extremelyHighThroughput5L
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 5.2G radio.

extremelyHighThroughput6
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 6G radio.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update RF Template

Update RF Template for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the RF Template. Size: 1 - 32 characters.

description
string

The description of the RF Template. Size: 1 - 255 characters

countryCode
required
string

The code of country where the site is located. Ex: VN

bandSteering
required
boolean

An optimization option which can automatically steer clients connecting to a wireless network to the best frequency band available and supported

bandSteeringForce5g
required
boolean

Force clients connecting to 5G band

bandSteeringForce6g
boolean

Force clients connecting to 6G band

excludeMacOUILists
string

List of MAC OUIs which are excluded by the band steering option. EX: 11:22:33

associationRSSIThreshold2
required
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

associationRSSIThreshold5A
required
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

associationRSSIThreshold5L
required
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

associationRSSIThreshold5H
required
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

associationRSSIThreshold6
integer <int32>

RSSI - Received Signal Strength Indicator. If the RSSI of the association request is lower than the threshold, it will be disassociated. Value in 0 - 100

roamingRSSIThreshold2
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

roamingRSSIThreshold5A
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

roamingRSSIThreshold5H
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

roamingRSSIThreshold5L
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

roamingRSSIThreshold6
required
integer <int32>

if the RSSI of the client is lower than the threshold, it will be roamed. Value in 0 - 100.

dynamicLoadBalance
required
boolean

Enable or disable the Dynamic Load Balance

backgroundScanning
required
boolean

Enable/Disable background scanning ability

scanningInterval
required
integer <int32>

Configure the interval for scanning. Its value should be in [5 - 10800]

scanningDuration
required
integer <int32>

The duration in each scanning time. Its value should be in [50 - 110]

scanningChannel
required
string
Enum: "workChannel" "allChannels"

Performance optimization option. This is to enable/disable airtime fairness for 2.4G and 5G bands

voiceAndVideoAwareness
required
boolean

Enable or disable voice/video awareness

defaultSetting
required
boolean

Disable to set custom bandwidth settings. Enable to reset bandwidth settings to default values.

band2
required
boolean

Configure the working radio for the AP. True if 2.4G band radio is activated

band5A
required
boolean

Configure the working radio for the AP. True if 5G band radio will be activated. It is used to set the full band 5G radio on other AP series.

band5H
required
boolean

Configure the working radio for the AP. True if 5.8G band radio will be activated. It is used to set the 5.8G radio on OAW AP-123x.

band5L
required
boolean

Configure the working radio for the AP. True if 5.2G band radio will be activated. It is used to set the 5.2G radio on OAW AP-123x

band6
required
boolean

Configure the working radio for the AP.

channelSetting2
required
string

The working channel of the radio. This field must be in values as AUTO, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13.

channelSetting5A
required
string

The working channel of the radio. This field must be in list's values: (5G Low + 5G High)

channelSetting5H
required
string

The working channel of the radio. This field must be in values as AUTO, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165

channelSetting5L
required
string

The working channel of the radio. This field must be in values as AUTO, 36, 40, 44, 48, 52, 56, 60, 64

channelSetting6
required
string

The working channel of the radio.

channelWidth2
required
string

Configures the channel width. This field must be in values as 0, 20

channelWidth5A
required
string

Configures the channel width. This field must be in values as 0, 20, 40, 80

channelWidth5H
required
string

Configures the channel width. This field must be in values as EX: 0, 20, 40, 80

channelWidth5L
required
string

Configures the channel width. This field must be in values as 0, 20, 40, 80

channelWidth6
string

The 6G Channel Width setting for the profile.

powerSetting2
required
string

Configures the transmit power of the wireless radio. The PowerSetting in range 3..40 OR AUTO string value

powerSetting5A
required
string

Configures the transmit power of the wireless radio. The PowerSetting in range 3..40 OR AUTO string value

powerSetting5H
required
string

Configures the transmit power of the wireless radio. The PowerSetting in range 3..40 OR AUTO string value

powerSetting5L
required
string

Configures the transmit power of the wireless radio. The PowerSetting in range 3..40 OR AUTO string value

powerSetting6
string

The 6G Power setting for the profile.

channelList5A
required
string

If enabled, the available channel(s) that can be selected by DRM. This field must be in values as empty, 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165

channelList5H
required
string

If enabled, the available channel(s) that can be selected by DRM. This field must be in values as empty, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165

channelList5L
required
string

If enabled, the available channel(s) that can be selected by DRM. This field must be in values as empty, 36, 40, 44, 48, 52, 56, 60, 64

channelList6
string

The 6G Channel List for the profile.

channelDRM5A
required
boolean

The Channel DRM administrative status (On/Off)

channelDRM5H
required
boolean

The Channel DRM administrative status (On/Off)

channelDRM5L
required
boolean

The Channel DRM administrative status (On/Off)

channelDRM6
boolean

The channel DRM of RF Profile.

shortGuardInterval2
required
boolean

Enables/Disables Short Guard Interval for 2.4G radio

shortGuardInterval5A
required
boolean

Enables/Disables Short Guard Interval for 5G radio

shortGuardInterval5L
required
boolean

Enables/Disables Short Guard Interval for 5.2G radio

shortGuardInterval5H
required
boolean

Enables/Disables Short Guard Interval for 5.8G radio

shortGuardInterval6
boolean

The short guard interval 6 of tha profile.

minTXPower2
required
string

Specify the minimum transmit power for auto power setting. The value in range 3..40 or empty.

minTXPower5A
required
string

Specify the minimum transmit power for auto power setting. The value in range 3..40 or empty.

minTXPower5L
required
string

Specify the minimum transmit power for auto power setting. The value in range 3..40 or empty.

minTXPower5H
required
string

Specify the minimum transmit power for auto power setting. The value in range 3..40 or empty.

minTXPower6
string

The minimum transmit power for auto power setting, if configured.

maxTXPower2
required
string

Specify the maximum transmit power for auto power setting. The value in range 3..40 or empty.

maxTXPower5A
required
string

Specify the maximum transmit power for auto power setting. The value in range 3..40 or empty.

maxTXPower5L
required
string

Specify the maximum transmit power for auto power setting. The value in range 3..40 or empty.

maxTXPower5H
required
string

Specify the maximum transmit power for auto power setting. The value in range 3..40 or empty.

maxTXPower6
string

The maximum transmit power for auto power setting, if configured.

airtimeFairness2G
required
boolean

The administrative status of the Airtime Fairness feature for 2G band radio (On/Off)

airtimeFairness5G
required
boolean

The administrative status of the Airtime Fairness feature for 5G band radio (On/Off)

externalAntennasGain2
required
string

The gain value of 2.4G band for the external antennas used by the APs mapping to this RF profile. The value in range [1d..16d]

externalAntennasGain5A
required
string

The gain value of 2.4G band for the external antennas used by the APs mapping to this RF profile. The value in range [1d..16d]

externalAntennasGain5L
required
string

The gain value of 2.4G band for the external antennas used by the APs mapping to this RF profile. The value in range [1d..16d]

externalAntennasGain5H
required
string

The gain value of 2.4G band for the external antennas used by the APs mapping to this RF profile. The value in range [1d..16d]

externalAntennasGain6
string

Configure the gain value of 6G band for the external antennas used by the APs mapping to this RF profile.

clientAwareness2
required
boolean

Client Aware Feature administrative status (On/Off)

clientAwareness5A
required
boolean

Client Aware Feature administrative status (On/Off)

clientAwareness5H
required
boolean

Client Aware Feature administrative status (On/Off)

clientAwareness5L
required
boolean

Client Aware Feature administrative status (On/Off)

clientAwareness6
required
boolean

Client Aware Feature administrative status (On/Off)

muMimo2
required
boolean

The administrative status of the MU-MIMO feature for 2.4G radio

muMimo5H
required
boolean

The administrative status of the MU-MIMO feature for 2.4G radio

muMimo5A
required
boolean

The administrative status of the MU-MIMO feature for 2.4G radio

muMimo5L
required
boolean

The administrative status of the MU-MIMO feature for 2.4G radio

muMimo6
boolean

The administrative status of the MU-MIMO feature for 6G radio.

highEfficiency2
required
boolean

The administrative status of the 'High Efficiency' feature for 2.4G radio

highEfficiency5L
required
boolean

The administrative status of the 'High Efficiency' feature for 5.2G radio

highEfficiency5H
required
boolean

The administrative status of the 'High Efficiency' feature for 5.8G radio

highEfficiency5A
required
boolean

The administrative status of the 'High Efficiency' feature for 5G radio

highEfficiency6
required
boolean

The administrative status of the 'High Efficiency' feature for 6G radio. This field value is always 'true' because this is enabled by default and cannot be disabled for the 6GHz band.

beaconInterval2
required
integer <int32>

The 2.4G radio Beacon Interval. The value in range [60..500]

beaconInterval5A
required
integer <int32>

The 5G radio Beacon Interval. The value in range [60..500]

beaconInterval5L
required
integer <int32>

The 5.2G radio Beacon Interval. The value in range [60..500]

beaconInterval5H
required
integer <int32>

The 5.8G radio Beacon Interval. The value in range [60..500]

beaconInterval6
integer <int32>

The 6G radio Beacon Interval.

csa2
boolean

The CSA 2 of the profile.

csa5A
boolean

The CSA 5A of the profile.

csa5H
boolean

The CSA 5H of the profile.

csa5L
boolean

The CSA 5L of the profile.

csa6
boolean

The CSA 6 of the profile.

csaCount2
integer <int32>

The CSA count 2 of the profile.

csaCount5L
integer <int32>

The CSA count 5L of the profile.

csaCount5H
integer <int32>

The CSA count 5H of the profile.

csaCount5A
integer <int32>

The CSA count 5A of the profile.

csaCount6
integer <int32>

The CSA count 6 of the profile.

drmInterval
required
string

The DRM interval (in hours) for the channel reassignment (Range: 0.5 - 12). This field only accepts one decimal place.

drmStartTime
required
string

The DRM start time for the channel reassignment. Format data is hh:mm (hh should be a full hour from 00 to 23 and mm should be a full minute from 00 to 59).

drmTimeControl
required
boolean

Enable/disable the DRM Time Control function.

Array of objects

The array of Radio Settings for the specific AP models.

extremelyHighThroughput2
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 2.4G radio.

extremelyHighThroughput5A
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 5G radio.

extremelyHighThroughput5H
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 5.8G radio.

extremelyHighThroughput5L
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 5.2G radio.

extremelyHighThroughput6
required
boolean

The administrative status of the Wi-Fi 7 Extremely High Throughput feature for 6G radio.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove RF Templates By Names

Remove RF Template by names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The array of RF Template Names which are removed.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of the deleted RF Template(s)

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all RF Templates and Assignments

Get all RF Templates and Assignments for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all RF Templates.

Response samples

Content type
application/json
{
}

Get all RF Templates (name only)

Get all RF Template (name only) for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of RF Template Names

Response samples

Content type
application/json
{
}

Get RF Template by Name

Get an RF Template by name for a given organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the RF Template.

Response samples

Content type
application/json
{
}

Locationpolicy

Get all Location Policy

Get all location policy for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of location policy.

Response samples

Content type
application/json
{
}

Create Location Policy

Create a new location policy for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The object of the location policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the location policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Location Policy

Update location policy for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The object of the location policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the location policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove Location Policy By Names

Remove location policy by names for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The names of Location Policies.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the location policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Location Policy by name

Get location policy by name for organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of location policy.

Response samples

Content type
application/json
{
}

Remove Location Policy by name

Remove location policy by name for organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The object of the location policy.

Response samples

Content type
application/json
{
}

Tunnel

Get all Tunnels

Get all Tunnel for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of Tunnel.

Response samples

Content type
application/json
{
}

Create a Tunnel

Create a Tunnel for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON object of the tunnel.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

The JSON object of the tunnel.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Tunnel

Update Tunnel for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON object of the tunnel.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

The JSON object of the tunnel.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple Tunnels by names

Delete multiple Tunnel by names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

An array names of the tunnel.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Tunnel by name

Get a Tunnel by name for a given organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the tunnel.

Response samples

Content type
application/json
{
}

Certificate

Get all certificates

Get all certificate for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the response.

Response samples

Content type
application/json
{
}

Create certificate

Create certificate for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: multipart/form-data
required
file
required
object

The Pem file. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

password
required
string

The Private Key Password to use when generating the key file.

description
string

Enter a description for the certificate file.

name
required
string

The name of the certificate file.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the certificate.

Response samples

Content type
application/json
{
}

Update certificate

Update certificate for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the certificate

description
string

The description of the certificate.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the certificate.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple certificates by names

Delete multiple certificates by names for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The array of names of the certificates.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Download certificate

Download certificate for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the certificate.

Responses

Request samples

Content type
application/json
{
}

Get certificate by name

Get certificate by name for organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the certificate.

Response samples

Content type
application/json
{
}

Accessauthprofile

Get all Access Auth Profile

Get all access auth profile for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of the Access Auth Profile

Response samples

Content type
application/json
{
}

Create Access Auth Profile

Create access auth profile for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON object of access auth profile.

object

The Config Assignment of Access Auth Profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The objects of the Access Auth Profile

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Access Auth Profile

Update access auth profile for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON object of access auth profile.

Array of objects

The Config Assignment of Access Auth Profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The objects of the Access Auth Profile

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple Access Auth Profile

Delete multiple access auth profile for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of integers

The JSON array of the ids in Access auth profile

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of the Access Auth Profile

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Access Auth Profile by id

Get access auth profile by id for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The objects of the Access Auth Profile

Response samples

Content type
application/json
{
}

Accessauthprofiledeviceconfig

Get all Access Auth Profile Device Config.

Get all access auth profile device config.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An object of the Access Auth Profile Device Config.

Response samples

Content type
application/json
{
}

Get Access Auth Profle Device Config By Device Config Ids.

Get device config access auth profile by device config ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of numbers

The ids of the device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An object of the Access Auth Profile Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Access Auth Profile Device Config.

Update access auth profile device config.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The information related to the device configs access auth profile needs to be updated

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of the Access Auth Profile Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Access Auth Profile Device Config

Delete access auth profile device config.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of numbers

The ids of the device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An object of the Access Auth Profile Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Customerdomain

Get all Customer Domains.

Get all customer domains.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the customer domain.

Response samples

Content type
application/json
{
}

Get all Customer Domain Device Configs.

Get all customer domain device configs.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
macAddress
required
string

The MAC address of the device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the customer domain.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Iotlocationserverprofile

Get all IOTLocationServerProfile

Get all IOTLocationServerProfile for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the IOT location.

Response samples

Content type
application/json
{
}

Create IOT Location Server Profile

Create IOT Location Server Profile for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
engineType
required
string

The engine type of the iot location.

description
string

An optional description for the Location Service Profile or IoT Profile.

host
string

The IP address or Host Name of the Location Engine, or IoT Zigbee Assa Abloy Server (Assa Abloy Visionline Zigbee Server). Default FQDN for Stellar Engine is kafka.omniaccess-stellar-asset-tracking.com.

vendorPort
integer <int32>

The AP Listen Port (Range = 0 - 65535, Default = 1144).

port
integer <int32>

The server port number (Range = 0 - 65535, Default = 9093 for Stellar/OmniVista Cirrus WiFi RTLS/OmniVista Cirrus 10.1 and above, 443 for Assa Abloy).

minimalReportingInterval
integer <int32>

The interval (in seconds) for APs to report wireless scanning data to the Location Engine for location calculation (Default 30).

unassociatedClientInfo
boolean

If enabled (checked), when a client report is started, unassociated client information will be sent to the Location Engine. If disabled (unchecked), only associated client information will be sent.

uploadAdvType
Array of strings

The upload adv type of the iot location.

rssiFormat
string

The rssi format of the IOT location.

name
required
string

The name of the Location Service Profile or IoT Profile.

Array of objects

The Qoe events of the Iot location.

reportingInterval
integer <int32>

The reporting interval of the Iot location.

tlsSwitch
boolean

Enable/Disable the TLS. Required when creating/updating the IoT/Location Server Profile with the engine type: Stellar Asset Tracking or OmniVista Cirrus WiFi RTLS.

certificate
string

The name of the certificate used by the Iot location.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the IOT location.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update IOT Location Server Profile

Update IOT Location Server Profile for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
engineType
required
string

The engine type of the iot location.

description
string

An optional description for the Location Service Profile or IoT Profile.

host
string

The IP address or Host Name of the Location Engine, or IoT Zigbee Assa Abloy Server (Assa Abloy Visionline Zigbee Server). Default FQDN for Stellar Engine is kafka.omniaccess-stellar-asset-tracking.com.

vendorPort
integer <int32>

The AP Listen Port (Range = 0 - 65535, Default = 1144).

port
integer <int32>

The server port number (Range = 0 - 65535, Default = 9093 for Stellar/OmniVista Cirrus WiFi RTLS/OmniVista Cirrus 10.1 and above, 443 for Assa Abloy).

minimalReportingInterval
integer <int32>

The interval (in seconds) for APs to report wireless scanning data to the Location Engine for location calculation (Default 30).

unassociatedClientInfo
boolean

If enabled (checked), when a client report is started, unassociated client information will be sent to the Location Engine. If disabled (unchecked), only associated client information will be sent.

uploadAdvType
Array of strings

The upload adv type of the iot location.

rssiFormat
string

The rssi format of the IOT location.

name
required
string

The name of the Location Service Profile or IoT Profile.

Array of objects

The Qoe events of the Iot location.

reportingInterval
integer <int32>

The reporting interval of the Iot location.

tlsSwitch
boolean

Enable/Disable the TLS. Required when creating/updating the IoT/Location Server Profile with the engine type: Stellar Asset Tracking or OmniVista Cirrus WiFi RTLS.

certificate
string

The name of the certificate used by the Iot location.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the IOT location.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple IOT Location Server Profile By Names

Delete multiple IOT Location Server Profile by names for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The list names of the Iot location.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the IOT location.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get IOT Location Server Profile By Name

Get all IOT Location Server Profile by name for organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the IOT location.

Response samples

Content type
application/json
{
}

Get Kafka serverip/host and port

Get Kafka serverip/host and port for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Ldap

Get all LDAP certificates

Get all ldap certificates for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Ldaps.

Response samples

Content type
application/json
{
}

Create LDAP certificate

Create ldap certificate for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data

Request Body schema: multipart/form-data
required
ca-file
required
object

The CA file of the certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

server-file
required
object

The Server file of the certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

key-file
required
object

The Key file of the certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

keyPasswd
required
string

Enter a description for the certificate file.

name
required
string

The name of the certificate file.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Ldaps.

Response samples

Content type
application/json
{
}

Delete multiple LDAP certificates By Names

Delete multiple ldap certificates by names for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
names
required
Array of strings

The array of names of the certificates.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Ldaps.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Download LDAP certificate

Download ldap certificate for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the certificate.

Responses

Request samples

Content type
application/json
{
}

Get LDAP certificate by name

Get ldap certificate by name for organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Ldaps.

Response samples

Content type
application/json
{
}

Localradseccertificate

Get all Local RadSec certificates

Get all Local RadSec certificates for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Local RadSec certificates.

Response samples

Content type
application/json
{
}

Create Local RadSec certificate

Create Local RadSec certificate for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: multipart/form-data
required
ca-file
required
string

The CA file of the Local RadSec certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

client-file
required
string

The Client file of the Local RadSec certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

key-file
required
string

The Key file of the Local RadSec certificate. When using REST API tools to send the request (Ex: Postman,...), we need to select a file for this field.

keyPasswd
required
string

The key password of the Local RadSec certificate.

name
required
string

The name of the Local RadSec certificate.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Local RadSec certificate.

Response samples

Content type
application/json
{
}

Delete multiple Local RadSec certificates By Names

Delete multiple Local RadSec certificates by names for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The array of names of the certificates.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Local RadSec certificates.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Download Local RadSec Certificate

Download Local RadSec certificate for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the certificate.

Responses

Request samples

Content type
application/json
{
}

Vpnsetting

Get all VPN Setting

Get all VPN Setting.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing vpn settings.

Response samples

Content type
application/json
{
}

Create a VPN Setting.

Create a VPN Setting.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

Name for the vpn setting attribute.

manageRapVpnServer
string

The RAP Server IP for IPv4. It is required when the IP type is IPv4.

manageRapVpnServerPort
string

The RAP VPN port for IPv4. It is required when the IP type is IPv4.

dataVpnServerIP
required
string

RAP VPN IP.

ovEnterpriseServerIP
required
string

OmniVista Enterprise Server IP.

tcpmss
required
string

This TCPMSS attribute can be used to control the maximum size of packets going out through a connection.

ipAddressPoolOption
required
string
Enum: "shorthandMask" "ipRange"

Client VPN IP Address Pool Option.

networkIPAddress
string

Network IP. It is required when the ipAddressPoolOption is shorthandMask

networkIPLength
string

Number of Network IP. It is required when the ipAddressPoolOption is shorthandMask

startIPRange
string

Start Network IP range. It is required when the ipAddressPoolOption is ipRange

endIPRange
string

End Network IP range. It is required when the ipAddressPoolOption is ipRange

subnetMask
string

Subnet Mask. It is required when the ipAddressPoolOption is ipRange

currentSelectedIpType
required
string
Enum: "ipv4" "ipv6"

IP type of the vpn setting.

manageRapVpnServerIpv6
string

The RAP VPN server IP for IPv6. It is required when the IP type is IPv6.

manageRapVpnServerPortIpv6
string

The RAP VPN server port for IPv6. It is required when the IP type is IPv6.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete VPN Settings

Delete VPN Settings.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of numbers

The array of unique identifiers of roles mapping.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array contains 1 successful response after removing a VPN setting.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a VPN Setting

Get a VPN Setting.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the vpn setting.

Response samples

Content type
application/json
{
}

Update a VPN Setting.

Update a VPN Setting.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

Name for the vpn setting attribute.

manageRapVpnServer
string

The RAP Server IP for IPv4. It is required when the IP type is IPv4.

manageRapVpnServerPort
string

The RAP VPN port for IPv4. It is required when the IP type is IPv4.

dataVpnServerIP
required
string

RAP VPN IP.

ovEnterpriseServerIP
required
string

OmniVista Enterprise Server IP.

tcpmss
required
string

This TCPMSS attribute can be used to control the maximum size of packets going out through a connection.

ipAddressPoolOption
required
string
Enum: "shorthandMask" "ipRange"

Client VPN IP Address Pool Option.

networkIPAddress
string

Network IP. It is required when the ipAddressPoolOption is shorthandMask

networkIPLength
string

Number of Network IP. It is required when the ipAddressPoolOption is shorthandMask

startIPRange
string

Start Network IP range. It is required when the ipAddressPoolOption is ipRange

endIPRange
string

End Network IP range. It is required when the ipAddressPoolOption is ipRange

subnetMask
string

Subnet Mask. It is required when the ipAddressPoolOption is ipRange

currentSelectedIpType
required
string
Enum: "ipv4" "ipv6"

IP type of the vpn setting.

manageRapVpnServerIpv6
string

The RAP VPN server IP for IPv6. It is required when the IP type is IPv6.

manageRapVpnServerPortIpv6
string

The RAP VPN server port for IPv6. It is required when the IP type is IPv6.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Export a VPN Setting

Export a VPN Setting.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Vpnserver

Get all VPN Servers

Get all VPN Servers for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

The Status message associated to the response.

Array of objects

The JSON array associated to the response.

Response samples

Content type
application/json
{
}

Create a VPN Server

Create VPN Server for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the profile.

autoPrivateKey
boolean

The Automatically Generate Server's Private Key of the profile.

autoPublicKey
boolean

The Automatically Generate Server's Public Key of the profile.

description
string

The description of the profile.

endIp
string

The End IP of the profile.

maskInt
string

The IP Range option of the profile. Value in 1 - 30.

maskString
string

The Shorthand Mask Option of the profile.

maskType
string
Enum: "maskStr" "maskInt"

The Mask Type of the profile.

serverPrivateKey
string

The Data VPN Server's private key used for secure communication between Data VPN Server and the client.

serverPublicIp
string

The server public IP of the profile. This field is required when the user does not configure the server VPN IPv6 of the profile.

serverPublicKey
string

The Data VPN Server's public key used for secure communication between the Data VPN Server and the client.

serverPublicPort
string

The server public port of the profile (value in 1 - 65535). This field is required when the user configures the server public IP of the profile.

serverVpnIp
required
string

The server VPN IP of the profile.

startIp
required
string

The start IP of the profile.

tcpMss
string

The TCPMSS of the profile. Value in 500 - 1460.

serverPublicIpV6
string

The server public IPv6 of the profile. This field is required when the user does not configure the server VPN IP of the profile.

serverPublicPortV6
string

The server public IPv6 port of the profile (value in 1 - 65535). This field is required when the user configures the server public IPv6 of the profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

The Status message associated to the response.

object

The JSON object associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update a VPN Server

Update VPN Server for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
id
required
string

The id of the profile.

name
required
string

The name of the profile.

autoPrivateKey
boolean

The Automatically Generate Server's Private Key of the profile.

autoPublicKey
boolean

The Automatically Generate Server's Public Key of the profile.

description
string

The description of the profile.

endIp
string

The End IP of the profile.

maskInt
string

The IP Range option of the profile. Value in 1 - 30.

maskString
string

The Shorthand Mask Option of the profile.

maskType
string
Enum: "maskStr" "maskInt"

The Mask Type of the profile.

serverPrivateKey
string

The Data VPN Server's private key used for secure communication between Data VPN Server and the client.

serverPublicIp
string

The server public IP of the profile. This field is required when the user does not configure the server VPN IPv6 of the profile.

serverPublicKey
string

The Data VPN Server's public key used for secure communication between the Data VPN Server and the client.

serverPublicPort
string

The server public port of the profile (value in 1 - 65535). This field is required when the user configures the server public IP of the profile.

serverVpnIp
required
string

The server VPN IP of the profile.

startIp
required
string

The start IP of the profile.

tcpMss
string

The TCPMSS of the profile. Value in 500 - 1460.

serverPublicIpV6
string

The server public IPv6 of the profile. This field is required when the user does not configure the server VPN IP of the profile.

serverPublicPortV6
string

The server public IPv6 port of the profile (value in 1 - 65535). This field is required when the user configures the server public IPv6 of the profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

The Status message associated to the response.

object

The JSON object associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple VPN Servers by ids

Delete multiple VPN Servers by ids for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of numbers

A JSON array of ids of the profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

The Status message associated to the response.

object

The JSON object associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Export VPN Server by id

Export VPN Server by id for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
data
object

The file export of the external captive portal.

Response samples

Content type
application/json
{
}

Get VPN Server by id

Get VPN Server by id for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

The Status message associated to the response.

object

The JSON object associated to the response.

Response samples

Content type
application/json
{
}

Get the details VPN Server by id

Get the details VPN Server by id for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

The Status message associated to the response.

object

The JSON object associated to the response.

Response samples

Content type
application/json
{
}

Get all VPN Servers by groups

Get all VPN Servers by groups for organization.

Responses

Response Schema: application/json
Array of objects

The JSON arrays Data VPN Servers of the group.

Response samples

Content type
application/json
{
}

Switchconfigtemplate

Get all Switch Config Template(s) by Organization

Get all Templates from organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array JSON object of the template.

Response samples

Content type
application/json
{
}

Create Template.

Create Template in a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the template.

meta
object

The JSON metadata of the template.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the template.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove Templates By Names

Remove Templates by names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
names
required
Array of strings

An array of names of the template.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create assign Incremental Configuration

Assign Incremental Configuration in a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the template.

meta
object

The JSON metadata of the template.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The result data of the assigned incremental configuration.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Template by name

Get Template by name for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the template.

Response samples

Content type
application/json
{
}

Update Switch Config Template.

Update Template for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the template.

meta
object

The JSON metadata of the template.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the template.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Valuemapping

Get all Value Mapping(s) by Organization

Get all Value Mapping from organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array JSON object of the Value Mapping.

Response samples

Content type
application/json
{
}

Create Value Mapping

Create a new Value Mapping in a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the Value Mapping.

meta
object

The JSON metadata of the Value Mapping.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Value Mapping.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove Value Mapping By Names

Remove Value Mapping by names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
names
required
Array of strings

An array names of the Value Mappings.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Value Mapping by name

Get Value Mapping by name for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Value Mapping.

Response samples

Content type
application/json
{
}

Update Value Mapping.

Update Value Mapping for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
meta
object

The JSON metadata of the Value Mapping.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Value Mapping.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Value Mappings by template name

Get all Value Mapping from organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array JSON object of the Value Mapping.

Response samples

Content type
application/json
{
}

Managementusertemplate

Get All Management User Template(s) by Organization

Get all Management User Template(s) from organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array JSON object of the Management User Template.

Response samples

Content type
application/json
{
}

Create Management User Template

Create a new Management User Template in a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the Management User Template.

meta
object

The JSON metadata of the Management User Template.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object or object

The JSON object of the the Management User Template.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove Management User Template(s)

Remove Management User Template(s) by names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
Array of strings

An array name of the Management User Templates.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of the deleted Management User Template(s).

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Management User Template by name

Get a Management User Template by name for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object or object

The JSON object of the Management User Template.

Response samples

Content type
application/json
{
}

Update Management User Template

Update a Management User Template for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the Management User Template.

meta
object

The JSON metadata of the Management User Template.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object or object

The JSON object of the Management User Template.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Resultsprovisioning

Get Provisioning Results.

Get Provisioning Results for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing a description of all results of provisioning.

Response samples

Content type
application/json
{
}

Force Provisioning Configuration.

Push a Provisioning Rule configuration to a matching switch the next time the switch contacts on the OmniVista Cirrus Server.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the Force Provisioning.

meta
object

The JSON metadata of the Force Provisioning.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of the updated data Force Provisioning.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Latest Provisioning configuration file.

Get the latest Provisioning Configuration File contents was sent to the switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON data of the getting Details Provisioning Configuration file.

meta
object

The JSON metadata of the getting Details Provisioning Configuration file.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
string

The data from the latest provisioning configuration file.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Preprovisioningsetting

Get Pre Provisioning Setting.

Get the Pre Provisioning Setting for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Pre Provisioning Setting.

Response samples

Content type
application/json
{
}

Update Pre Provisioning Setting.

Update the Pre Provisioning Setting for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The JSON data of the Pre Provisioning Setting.

meta
object

The JSON metadata of the Pre Provisioning Setting.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Pre Provisioning Setting.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Provisioningtemplate

Get all Provisioning Templates by Org

Get all Provisioning Templates from organization.

query Parameters
onlyDefault
required
boolean

True if you want to get only the default provisioning templates.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing a description of all Provisioning Configurations.

Response samples

Content type
application/json
{
}

Get Default Redirect Server Host by Org

Get Default redirect server host for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
string

The data of the Default Redirect Host Server.

Response samples

Content type
application/json
{
}

Get all Provisioning Templates by Site

Get all Provisioning Templates declared in one site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing a description of all Provisioning Configurations.

Response samples

Content type
application/json
{
}

Create Provisioning Template

Create a new Provisioning Template in a given organization, site

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON of Provisioning Configuration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Provisioning Configuration.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Provisioning Template

Update Provisioning Template in a given organization, site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON of Provisioning Configuration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Provisioning Configuration.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all Provisioning Templates (name only) by Site

Get all Provisioning Template Names in a given organization, site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all Provisioning Configurations.

Response samples

Content type
application/json
{
}

Get Provisioning Template by Name

Get the Provisioning Template by Name for the site.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Provisioning Configuration.

Response samples

Content type
application/json
{
}

Create Provisioning Template Default

Create a new Provisioning Template Default for the site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
required
object

The JSON of Provisioning Configuration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the Provisioning Configuration.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create Assign Provisioning Template for AP Group

Assign Provisioning Template for AP Group identified by deviceGroupId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
required
object

The JSON of Provisioning Configuration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple Provisioning Templates by ids

Deletion of multiple Provisioning Templates by ids in a given organization or site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
ids
required
Array of numbers

The JSON array ids of Provisioning Configuration.

sites
required
Array of strings

An array id of sites

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Unifiedpolicylist

Get all Unified Policies List And Assignments

Get all unified policy list and assignments for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the policy list.

Response samples

Content type
application/json
{
}

Get all Unified Policies List

Get all unified policy list for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the policy list.

Response samples

Content type
application/json
{
}

Create Unified Policy List

Create unified policy list for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The Config Assignment of policy.

required
object

The JSON object of policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the policy list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Unified Policies List

Update unified policies list for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

The config assignments of the unified policies list.

required
object

The JSON object of policy list.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the policy list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove Unified Policy List

Remove unified policy list for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The ids of unified policy list

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the policy list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Unified Policy List by name

Get unified policy list by name for a given organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the policy list.

Response samples

Content type
application/json
{
}

Get Unified Policy List by Id

Get unified policy list by Id for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the policy list.

Response samples

Content type
application/json
{
}

Unifiedpolicylistdeviceconfig

Get all Unified Policy List Device Configs

Get all unified policy list device config for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An object of the Unified Policy List Device Config.

Response samples

Content type
application/json
{
}

Get Unified Policy List Device Configs By Device Config Ids

Get all unified policy list device config by device config ids for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of numbers

The ids of the device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An object of the Unified Policy List Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Unified Policy List Device Configs

Update unified policy list device configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The data of the unified policy list device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of the Unified Policy List Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Unified Policy List Device Configs

Delete unified policy list device configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of numbers

The ids of the device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of the Unified List Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Policyservice

Get all policy services

Get all policy services.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Create policy service

Create policy service.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the policy service.

protocol
string
Enum: "UCP" "TCP"

The protocol of the policy service.

object

The information of the destination service port.

object

The information of the source service port.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update policy service

Update policy service.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the policy service.

protocol
string
Enum: "UCP" "TCP"

The protocol of the policy service.

object

The information of the destination service port.

object

The information of the source service port.

id
string

The id of the policy service.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete policy services

Delele policy services.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

The ids of the policy service.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get policy service assignments by id

Get policy service assignments by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Get policy service by id

Get policy service by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Unifiedpolicy

Get all Unified Policies And Assignments

Get all unified policies and assignments for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the policy.

Response samples

Content type
application/json
{
}

Get all Unified Policies

Get all unified policies for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the policy.

Response samples

Content type
application/json
{
}

Create Unified Policy

Create a unified policy for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON object of policy

object

The Config Assignment of policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Unified Policy

Update unified policy for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON object of policy

Array of objects

The config assignments of the unified policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple Unified Policy by ids

Delete multiple unified policy by ids for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of numbers

An array ids of the unified policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON object of the policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Unified Policy By Name

Get unified policy by name for organization.

query Parameters
name
required
string

This is a custom param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the policy.

Response samples

Content type
application/json
{
}

Get Unified Policy By Id

Get unified policy by id for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the policy.

Response samples

Content type
application/json
{
}

Unifiedpolicydeviceconfig

Get All Unified Policy Device Config

Get all unified policy device config for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An object of the Unified Policy Device Config.

Response samples

Content type
application/json
{
}

Get All Unified Policy Device Config By Device Config Ids

Get all unified policy device config by device config ids for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of numbers

The ids of the device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

An object of the Unified Policy Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Unified Policy Device Config

Update unified policy device config for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The data of the unified policy device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of the Unified Policy Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Unified Policy Device Config

Delete unified policy device config for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of numbers

The ids of the device config.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of the Unified Policy Device Config.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Servicegroup

Get all service groups

Get all service groups.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Create service group

Create service group.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the service group.

Array of objects

An array associated with policy service.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update service group

Update service group.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the service group.

Array of objects

An array associated with policy service.

id
string

The id of the service group.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete service group

Delete service group.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

The ids of the service group.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get service group assignments by id

Get service group assignments by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Get service group by name

Get service group by name.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Ssidschedule

Get SSID Schedule by SSID ID

Get SSID Schedule by SSID Id for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The data associated to the response.

Response samples

Content type
application/json
{
}

Create SSID Schedules

Create SSID Schedules for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ssidName
string

The name of the ssid.

Array of objects

The schedule config of the profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

The data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete SSID Schedules

Delete SSID Schedules for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ssidName
required
string

The name of the ssid.

schedules
required
Array of strings

A list of schedules needs to be deleted from the SSID.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

Array of objects

The data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Periodpolicy

Get all Period Policy

Get all period policy for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Period policy.

Response samples

Content type
application/json
{
}

Create Period Policy

Create period policy for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON object of Period policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Period policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Period Policy

Update period policy for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON object of Period policy.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Period policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove Period Policy by names

Remove period policy by names for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

An array of policy names.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the Period policy.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Period Policy by name

Get period policy by name for organization.

query Parameters
name
required
string

The name of the period policy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Period policy.

Response samples

Content type
application/json
{
}

Get Period Policy by Id

Get period policy by id for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Period policy.

Response samples

Content type
application/json
{
}

Remove Period Policy by id

Remove period policy by id for organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the Period policy.

Response samples

Content type
application/json
{
}

Configurationgroup

Get all IP groups

Get all IP groups.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Create IP group

Create IP group.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the MAC group.

ips
Array of strings

An array of the IPs

type
string
Enum: "NETWORK" "MULTICAST"

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update IP group

Update IP group.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the MAC group.

ips
Array of strings

An array of the IPs

type
string
Enum: "NETWORK" "MULTICAST"

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete IP groups

Delete IP groups.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of arrays

The ids of the IP group.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get IP group assignments by id

Get IP group assignments by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of assignments.

Response samples

Content type
application/json
{
}

Get IP group by name

Get IP group by name.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get all MAC groups

Get all MAC groups.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Create MAC group

Create MAC group.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the MAC group.

macs
Array of strings

An array of the MACs

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update MAC group

Update MAC group.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
string

The name of the MAC group.

macs
Array of strings

An array of the MACs

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete MAC groups

Delete MAC groups.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of arrays

The ids of the MAC group.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get MAC group assignments by id

Get MAC group assignments by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of assignments.

Response samples

Content type
application/json
{
}

Get MAC group by name

Get MAC group by name.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response.

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Aaaprofile

Get all AAA Profiles

Get all AAA Profiles for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the AAA Profile.

Response samples

Content type
application/json
{
}

Create AAA Profile

Create an AAA Profile for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON object of the AAA Profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the AAA Profile.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update AAA Profile

Update an AAA Profile for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The JSON object of the AAA Profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the AAA Profile.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple AAA Profiles by names

Delete multiple AAA Profiles by names from a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
names
required
Array of strings

The names of the AAA Profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get AAA Profile assignments by ID

Get AAA Profile assignments by ID for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of AAA Profile assignments.

Response samples

Content type
application/json
{
}

Get AAA Profile by id

Get an AAA Profile by id for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the AAA Profile.

Response samples

Content type
application/json
{
}

Aaaprofiledeviceconfig

Get all AAA Profile Device Configs

Get all AAA Profile Device Configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The information of the AAA Profile Template and its Device Configs.

Response samples

Content type
application/json
{
}

Get AAA Profile Device Configs by IDs

Get AAA Profile Device Configs by IDs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of integers

The IDs array of the AAA Profile Device Config that needs to be retrieved.

meta
object

The JSON metadata for getting AAA Profile Device Configs.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The information of the AAA Profile Template and its Device Configs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update AAA Profile Device Configs

Update AAA Profile Device Configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The AAA Profile Device Config template information.

required
Array of objects

The device array of the AAA Profile Device Configs needs to be updated.

meta
object

The JSON metadata for updating AAA Profile Device Configs.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove AAA Profile Device Configs by IDs

Remove AAA Profile Device Configs by IDs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of integers

The IDs array of the AAA Profile Device Config that needs to be deleted.

meta
object

The JSON metadata for deleting AAA Profile Device Configs.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Aaaserver

Get all AAA Servers

Get all AAA Servers for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the AAA Server.

object

The JSON metadata of the AAA Servers.

Response samples

Content type
application/json
{
}

Create AAA Server

Create an AAA Server for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The data of the AAA Server will be created.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the AAA Server.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update AAA Server

Update the AAA Server for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

The data of the AAA Server will be updated.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the AAA Server.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove AAA Servers by names

Remove AAA Server by names from a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
names
required
Array of strings

The array of AAA Server's name.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get AAA Servers by Type

Get AAA Servers by type for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the AAA Server.

Response samples

Content type
application/json
{
}

Get Invalid AAA Servers

Get Invalid AAA Servers by the AAA Profile for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
aaaProfileName
required
string

The name of the AAA Profile that we want to get Invalid AAA Servers from. If the AAA Profile name does not exist, an empty array will be returned .

meta
object

The JSON metadata for getting Invalid AAA Servers by the AAA Profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
Array of strings

The JSON array of Invalid AAA Servers names.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get AAA Server assignments by ID

Get AAA Server assignments by ID for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of AAA Server assignments.

Response samples

Content type
application/json
{
}

Get AAA Server By Name

Get AAA Server by name for a given organization.

path Parameters
name
required
string

This is a path param for name. The URL path does not accept special characters so when using a 3rd party REST API tool (Ex: Postman,...), we need to encode special characters (if any) using the ASCII Encoding Reference table before putting them into the URL path (Ex: "@Name#01" will be encode to "%2540Name%252301").

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the AAA Server.

Response samples

Content type
application/json
{
}

Aaaserverdeviceconfig

Get all AAA Server Device Configs

Get all AAA Server Device Configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The information of the AAA Server Template and its Device Configs.

Response samples

Content type
application/json
{
}

Get AAA Server Device Configs by IDs

Get AAA Server Device Configs by IDs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of integers

The IDs array of the AAA Server Device Config that needs to be retrieved.

meta
object

The JSON metadata for getting AAA Server Device Configs.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The information of the AAA Server Template and its Device Configs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update AAA Server Device Configs

Update AAA Server Device Configs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The AAA Server Device Config template information.

required
Array of objects

The device array of the AAA Server Device Configs needs to be updated.

meta
object

The JSON metadata for updating AAA Server Device Configs.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove AAA Server Device Configs by IDs

Remove AAA Server Device Configs by IDs for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceConfigIds
required
Array of integers

The IDs array of the AAA Server Device Config that needs to be deleted.

meta
object

The JSON metadata for deleting AAA Server Device Configs.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Piirequest

Retrieve all PII Requests for an organization

Get all pii requests performed on organization level.

query Parameters
startDate
string

"startDate" is the start date of the period in ISO8601 format.

endDate
string

"endDate" is the end date of the period in ISO8601 format.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing all requested pii done in an organization.

Response samples

Content type
application/json
{
}

Activationserver

Get all schedule from organization

Fetch all schedule from organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all schedules of one organization

Response samples

Content type
application/json
{
}

Create a Schedule

Create Schedule to upgrade sofware Device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scheduleName
required
string

The user-configured schedule name.

cronExpression
required
string

The cron expression of the schedule.

duration
required
integer <int32>

The time window for upgrading the devices in the schedule. Minimum should be 3600000~1h (measure is miliseconds).

timezone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" … 291 more

The timezone of the schedule.

scheduleType
string
Enum: "PERIODICALLY" "NOW"

The type of the schedule.

siteId
required
string

The siteId of the devices and groups in the schedule. It is not required if 'scheduledDevices' and 'groups' are empty.

required
Array of objects

The devices will be upgrade version.

required
Array of objects

The devices in this groups will be upgrade version.

startDate
required
string

The start date of the schedule. (measure is miliseconds)

endDate
required
string

The end date of the schedule. (measure is miliseconds)

fromApp
required
string
Enum: "DEVICE" "SCHEDULE"

The name of app that create or update schedule upgrade

enable
boolean

If the schedule was disabled, set it to be enabled.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple schedules

Delete mutiple schedules identified by there ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of schedules.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of deleted schedules upgrades.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a schedule by id

Fetch one schedule identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the schedule.

Response samples

Content type
application/json
{
}

Update a schedule

Update one schedule identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
scheduleName
required
string

The user-configured schedule name.

cronExpression
required
string

The cron expression of the schedule.

duration
required
integer <int32>

The time window for upgrading the devices in the schedule. Minimum should be 3600000~1h (measure is miliseconds).

timezone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" … 291 more

The timezone of the schedule.

scheduleType
string
Enum: "PERIODICALLY" "NOW"

The type of the schedule.

siteId
required
string

The siteId of the devices and groups in the schedule. It is not required if 'scheduledDevices' and 'groups' are empty.

required
Array of objects

The devices will be upgrade version.

required
Array of objects

The devices in this groups will be upgrade version.

startDate
required
string

The start date of the schedule. (measure is miliseconds)

endDate
required
string

The end date of the schedule. (measure is miliseconds)

fromApp
required
string
Enum: "DEVICE" "SCHEDULE"

The name of app that create or update schedule upgrade

enable
boolean

If the schedule was disabled, set it to be enabled.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated schedule.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete a schedule by id

Delete a schedule identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the deleted schedule.

Response samples

Content type
application/json
{
}

Execute a schedule

Execute one schedule identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated schedule.

Response samples

Content type
application/json
{
}

Deactivate the schedule upgrades

Deactivate multiple schedule upgrades identified by there ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of numbers

The array of unique identifiers of schedules.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON Object of the deactivated schedule upgrades.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Activate the schedule upgrades

Deactivate multiple schedule upgrades identified by there ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of numbers

The array of unique identifiers of schedules.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON Object of the deactivated schedule upgrades.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Scheduled Devices of the Schedule

Update Scheduled Devices of the Schedule identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

The devices will be upgrade version.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of the devices.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update desired sw versions for schedule

Update desired sw versions for schedule.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

The devices will be upgrade version.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON objects containing description of the devices.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the schedules by groups

Fetch the schedules by groups.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

The array of unique identifiers of groups.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of the groups.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the schedules by devices

Fetch the schedules by devices.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

The array of unique identifiers of devices.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of the devices.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all settings of callhome interval global

Fetch alls setting of callhome interval global.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the global call-home interval settings.

Response samples

Content type
application/json
{
}

Update setting of callhome interval global

Update setting of callhome interval global.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

Settings for global call-home intervals.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the global call-home interval settings.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all settings of callhome interval

Fetch alls setting of callhome interval.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the call-home interval settings.

Response samples

Content type
application/json
{
}

Update setting of callhome interval

Update setting of callhome interval.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

Settings for call-home intervals.

useGlobalConfig
boolean

Indicates whether to use the global configuration.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing the call-home interval settings.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Retrieve networkId settings.

Get networkId settings.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Generate networkId settings.

Generate networkId settings.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
method
required
string

Method is used to generate networkId.

suppliedKey
string

Property is used when method=UserSupplied

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

data
string

value of networkId which created.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update strictMode in networkId setting

Update strictMode.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
strictMode
required
boolean

value of strictMode which need to update.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all assigned commands

Get all assigned commands in organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of all assigned commands

Response samples

Content type
application/json
{
}

Assign commands

Assign multiple troubleshooting commands in organization

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceSerialNumbers
required
Array of arrays

An array of serial number of devices.

commandTimeToNextCallHome
required
string

The time of command to next callhome.

object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all devices to assign commands

Get all devices to assign commands in organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of all troubleshooting devices.

Response samples

Content type
application/json
{
}

Get all troubleshooting commands

Get all troubleshooting commands from DataPond.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of all troubleshooting commands from Datapond

Response samples

Content type
application/json
{
}

License

Get all of licenses following orderId

Get all of licenses following orderId.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
orderId
required
string

The id of order which managed the licenses.

activationCode
required
string

The code is used to verify orderId.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get licenses in organization

Get all of licenses which imported organization.

query Parameters
status
string

"status" is the status of license, ex: "Unlicensed"

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Import licenses to organization

Link all of licenses following orderId to the organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
orderId
required
string

The id of order which managed the licenses.

activationCode
required
string

The code is used to verify orderId.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Order information with its imported licenses.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete expired licenses in organization

Delete expired licenses in organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

array of licensesids

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data of licenses after deleted.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Bindings license to device

Binding licenses to devices.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

Array of pair contain licenseId and serialNumber.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

statusCode
string

Status code associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Unbindings license to device

Unbinding licenses to devices.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumbers
required
Array of strings

serialNumber of device

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the licenses.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Swap devices between 2 licenses

Swap devices between 2 licenses

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data of devices associated to two licenses.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reassign device to new license.

Reassign device to new license.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
string

Data of device associated to the license.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reassign license to new device

Reassign licenses to devices.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object
object

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
string

Data of license associated to the device.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the licenseMode

Get the license mode which is used to auto-binding.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Organization Setting information that includes the license mode.

Response samples

Content type
application/json
{
}

Get the association between licenses and devices

Get association between licenses and devices.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
mode
required
string
Enum: "MANUAL_SELECTION" "AUTO_SELECTION"

The mode in which the user wants the system auto-bind licenses.

serialNumbers
required
Array of strings

The array of serialNumbers. If mode = AUTO_SELECTION, the array is empty.

licenseMode
required
string
Enum: "EXPIRE_LAST" "EXPIRE_FIRST"

The priority about duration which the user wants system auto-bind licenses.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The array of associations between licenses and devices.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get the expired licenses from organization.

Get all of expired licenses from organization.

query Parameters
limit
integer

The numbers of items to return

offset
required
string

The offset in paging return

startDate
required
string

"startDate" is the start date of the period in ISO8601 format.

endDate
required
string

"endDate" is the end date of the period in ISO8601 format.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Get the number of status in licenses from organization.

Get number of status in licenses from organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Number of licenses per status each license type.

Response samples

Content type
application/json
{
}

Get auto assign license from organization.

Get auto assign license from ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update auto assign license from organization.

Update auto assign license from ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
isAutoAssignLicenseForNewDevice
required
boolean

Unable if the user want to auto assign license for device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all subscription licenses from the organization.

Get all subsricption license from ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Import subscription licenses from the organization.

Import subsricption license from the ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
subscriptionId
required
string

The id of subscription license.

activationCode
required
string

The code is used to verify subscriptionId.

isAutoAssignLicenseForNewDevice
required
boolean

Indicates whether the user has agreed to the Terms and Conditions.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update license consumption for the devices.

Update subsricption license from the ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceIdsToAssignLicense
Array of strings

An array JSON of devices to assign licenses.

deviceIdsToReleaseLicense
Array of strings

An array JSON of devices to release licenses.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get subscription license expiration from the organization.

Get all subsricption license expiration from ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Reload subscription licenses from the organization.

Reload subsricption license from the ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Add on subscription licenses from the organization.

Add on subsricption license from the ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Renew subscription licenses from the organization.

Renew subsricption license from the ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get subscription licenses validation from the organization.

Get subsricption license validation from the ogranization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Response samples

Content type
application/json
{
}

Dynamicpgpskmodule

Get all Dynamic Private Group PSK profiles

Fetch all Dynamic Private Group PSK profiles inside a given Organization.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: profileName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"profileName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key profileName, to filter with the same value, use the object {"profileName":"pskProfile"}, to filter the records containing a value, use the object {"profileName":{"contains":"pskProfile"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create Dynamic Private Group PSK profile

Create Dynamic Private Group PSK profile.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
profileName
required
string

The Dynamic Private group PSK profile name.

persistencyDays
required
integer <int32>

The Number of Persistency days for the Dynamic Private group PSK profile (Range: 1 to 365).

required
Array of objects

An array of PSK entries for the profile.

ssid
required
string

The SSID of the Dynamic Private group PSK profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Multiple Dynamic Private Group PSK profiles by IDs

Delete multiple Dynamic Private Group PSK profiles by it's IDs.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

Ids of Dynamic Private group PSK profiles to delete

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of Dynamic Private group PSK profiles deleted.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Dynamic Private Group PSK profile by ID

Fetch Dynamic Private Group PSK profile by it's ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update Dynamic Private Group PSK profile by ID

Update the values of Dynamic Private Group PSK profile by ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
persistencyDays
required
integer <int32>

The Updated Number of Persistency days for the Dynamic Private group PSK profile (Range: 1 to 365).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update Dynamic Private Group PSK Items

Update the values of Dynamic Private Group PSK Items.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deleteExistingItems
Array of strings

The PSK entries to delete

Array of objects

The PSK entries to update

Array of objects

The addition of new PSK entries

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get PSK list under the Dynamic Private Group PSK profile

This API is responsible to get PSK list under the Dynamic Private Group PSK profiles declared inside a given Organization.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: profileName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"profileName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key profileName, to filter with the same value, use the object {"profileName":"pskProfile"}, to filter the records containing a value, use the object {"profileName":{"contains":"pskProfile"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get all Dynamic Private Group MACs

Fetch all Dynamic Private Group MACs inside a given Organization.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: profileName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"profileName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key profileName, to filter with the same value, use the object {"profileName":"pskProfile"}, to filter the records containing a value, use the object {"profileName":{"contains":"pskProfile"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete Multiple Dynamic Private Group MACs by IDs

Delete multiple Dynamic Private Group MACs by it's IDs.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

Ids of Dynamic Private group MAC profiles to delete

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of Dynamic Private group MAC profiles deleted.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Dynamic Private Group MAC by ID

Fetch Dynamic Private Group MAC by it's ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Employeeaccount

Get all employee accounts

Get all employee accounts within an organization.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: strategyName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"strategyName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key strategyName, to filter with the same value, use the object {"strategyName":"strategy"}, to filter the records containing a value, use the object {"strategyName":{"contains":"strategy"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create an employee account

Create an employee account.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
username
required
string

The user name for the employee account.

telephone
string

The optional telephone number of the employee.

email
string

The optional Email address of the employee.

password
required
string

The password for the employee account.

fullName
string

The full name of the employee.

department
string

The department of the employee.

position
string

The employee position in the company.

description
string

The description of this employee account.

arpName
string

The Access Role Profile that is bound to the employee account. It is prior to the Access Role Profile configured in Authentication Strategy.

plName
string

The Policy that is bound to the employee account. It is prior to the Policy configured in an Authentication Strategy..

Array of objects

An array of JSON objects containing other attributes.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple employee accounts

Delete multiple employee accounts by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of employee accounts.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing employee accounts.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get an employee account

Get an employee account by Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the employee account global.

Response samples

Content type
application/json
{
}

Update an employee account

Update an employee account by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
telephone
string

The optional telephone number of the employee.

email
string

The optional Email address of the employee.

password
string

The password for the employee account.

fullName
string

The full name of the employee.

department
string

The department of the employee.

position
string

The employee position in the company.

description
string

The description of this employee account.

arpName
string

The Access Role Profile that is bound to the employee account. It is prior to the Access Role Profile configured in Authentication Strategy.

plName
string

The Policy that is bound to the employee account. It is prior to the Policy configured in an Authentication Strategy..

Array of objects

An array of JSON objects containing other attributes.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Mass import employee accounts

Mass import employee accounts.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of employee accounts to be imported.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing employee accounts.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update status for multiple employee accounts

Update status for multiple employee accounts by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
status
string
Enum: "ENABLED" "DISABLED"

The employee account status.

ids
required
Array of strings

The array of unique identifiers of employee accounts.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing employee accounts.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get employee accounts global configuration

Get employee accounts global configuration for a given organisation.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the employee account global configuration.

Response samples

Content type
application/json
{
}

Update or set employee accounts global configuration

Update or set employee accounts global configuration for a given organisation.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
passwordEnforcement
string

This is the password policy. There are two choices: STRONG (for a strong password) or WEAK (for weak password).

usernamePolicy
string

The username policy has two choices: STRONG (for a strong usename) or WEAK (for a weak username).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Rolemapping

Get all roles mappings

Get all roles mappings.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a role mapping

Create a role mapping.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

User-configured name for the mapping rule.

priority
required
integer <int32>

Priority of the role mapping rule.

action
required
string
Enum: "accept" "reject"

Action for the mapping rule. Accept : Satisfy the condition to pass, reject：Satisfy the condition to reject directly.

mappingARPName
string

Access Role Profile applied to the user after matching the role mapping rule. It is prior to the Access Role Profile configured in Authentication Strategy.

mappingPLName
string

Policy List applied to the user after matching the role mapping rule. It is prior to the Policy configured in an Authentication Strategy..

Array of objects

An array of JSON objects containing conditions.

Array of objects

An array of JSON objects containing other attributes.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple roles mappings

Delete multiple roles mappings by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of roles mapping.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing role mappings.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a role mapping

Get a role mapping by Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the role mapping.

Response samples

Content type
application/json
{
}

Update a role mapping

Update a role mapping by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
priority
required
integer <int32>

Priority of the role mapping rule.

action
string
Enum: "accept" "reject"

Action for the mapping rule. Accept : Satisfy the condition to pass, reject：Satisfy the condition to reject directly.

mappingARPName
string

Access Role Profile applied to the user after matching the role mapping rule. It is prior to the Access Role Profile configured in Authentication Strategy.

mappingPLName
string

Policy List applied to the user after matching the role mapping rule. It is prior to the Policy configured in an Authentication Strategy..

Array of objects

An array of JSON objects containing conditions.

Array of objects

An array of JSON objects containing other attributes.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Radiusservercertificate

Get all the radius server certificates

Fetch all the radius server certificates.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a radius server certificate

Add a new radius server certificates.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data

Request Body schema: multipart/form-data
required
name
required
string

Identifier for the certificate in UPAM.

cafiles
required
string

The CA Certificate file.

certificateFileName
required
string

The certificate file in the RADIUS server. The Server File contains the contents of the Sever Certificate file and the Server Key file.

serverKeyFile
required
string

The server key file.

password
required
string

The password of the server key file.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple radius server certificates by their ids

Delete multiple radius server certificates.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The identifiers of the radius server certificates.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing external radius servers.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a radius server certificate by Id

Fetch a radius server certificate.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Activate a radius server certificate

Activate a radius server certificate.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Registrationprofile

Get all registration profiles.

Get all registration profiles.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing registration profiles.

Response samples

Content type
application/json
{
}

Add a new Registration Profile

Add a new Registration Profile.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
description
string

The description of this registration profile.

dataQuotaStatus
required
string
Enum: "ENABLED" "DISABLED"

Specifies whether the data quota is active or not.

timeQuotaStatus
required
string
Enum: "ENABLED" "DISABLED"

Specifies whether the time quota is active or not.

timeQuotaMode
string

Specify the time quota per day ('PERDAY') or the time quota for certain of hours ('BYHOUR') then block user for some hours.

hourQuotaPerDayAmount
integer <int32>

Quota of the number of hours during which access will be allowed per day.

hourQuotaBeforeBlocked
integer <int32>

Number of hours during which access will be allowed before data is blocked.

blockedHours
integer <int32>

Time in hours during which the data will be blocked before returning to normal.

maxRememberedDevice
integer <int32>

Max Device Number Per Account.

reducedUpBandwidth
integer <int32>

The reduced up bandwidth.

reducedDownBandwidth
integer <int32>

The reduced down bandwidth.

dataQuotaUrl
string

The redirect URL to which the accessing device will be guided after the user reaches their data quota limitation.

dataQuota
integer <int32>

Maximum data quota not to be exceeded.

periodUnit
string
Enum: "Day(s)" "Hour(s)" "Minute(s)"

The unit used for the Account Validity Period Attribute (Days, Hours, Minutes).

deviceRemember
required
string
Enum: "ENABLED" "DISABLED"

Specify whether to remember the device MAC address and make it valid after successful authentication (Enabled/Disabled). If the remembered device is valid, the MAC address check will be performed first and the device allowed access without re-authentication.

deviceValidityPeriod
integer <int32>

The length of time that the user device is valid. This value is entered based on the selected Period Unit. For example, if Days is selected, enter the number of days the user device is valid; if Hours is selected, enter the number of hours, etc. By default, Days = 30, Hours = 24, and Minutes = 60.

profileName
required
string

The name of this registration profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The objects of the Registration Profile

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple Registration Profiles by their ids

Delete multiple Registration Profiles.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of access policies.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing registration profiles.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get registration profile by id

Get registration profile by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the registration profile.

Response samples

Content type
application/json
{
}

Update Registration Profile by their id

Update a Registration Profile by its ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
description
string

The description of this registration profile.

dataQuotaStatus
required
string
Enum: "ENABLED" "DISABLED"

Specifies whether the data quota is active or not.

timeQuotaStatus
required
string
Enum: "ENABLED" "DISABLED"

Specifies whether the time quota is active or not.

timeQuotaMode
string

Specify the time quota per day ('PERDAY') or the time quota for certain of hours ('BYHOUR') then block user for some hours.

hourQuotaPerDayAmount
integer <int32>

Quota of the number of hours during which access will be allowed per day.

hourQuotaBeforeBlocked
integer <int32>

Number of hours during which access will be allowed before data is blocked.

blockedHours
integer <int32>

Time in hours during which the data will be blocked before returning to normal.

maxRememberedDevice
integer <int32>

Max Device Number Per Account.

reducedUpBandwidth
integer <int32>

The reduced up bandwidth.

reducedDownBandwidth
integer <int32>

The reduced down bandwidth.

dataQuotaUrl
string

The redirect URL to which the accessing device will be guided after the user reaches their data quota limitation.

dataQuota
integer <int32>

Maximum data quota not to be exceeded.

periodUnit
string
Enum: "Day(s)" "Hour(s)" "Minute(s)"

The unit used for the Account Validity Period Attribute (Days, Hours, Minutes).

deviceRemember
required
string
Enum: "ENABLED" "DISABLED"

Specify whether to remember the device MAC address and make it valid after successful authentication (Enabled/Disabled). If the remembered device is valid, the MAC address check will be performed first and the device allowed access without re-authentication.

deviceValidityPeriod
integer <int32>

The length of time that the user device is valid. This value is entered based on the selected Period Unit. For example, if Days is selected, enter the number of days the user device is valid; if Hours is selected, enter the number of hours, etc. By default, Days = 30, Hours = 24, and Minutes = 60.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The objects of the Registration Profile

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Externalradiusserver

Get external RADIUS Server by id

Get external RADIUS Server by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the external radius server.

Response samples

Content type
application/json
{
}

Update external RADIUS Server by their id

Update a external RADIUS Server by its ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
hostName
required
string

External Radius Server host name/IP address.

backupHostName
string

Back up external radius server host name/IP address.

retries
required
integer <int32>

Number of times UPAM will attempt to reconnect to the External Radius Server when the connection timeout occurs before concluding that the External Radius Server is unreachable.

timeout
required
integer <int32>

The amount of time, in seconds, that UPAM will attempt a connection to the External Radius Server before timing out.

isRadSecServer
required
boolean

Enable/Disable Security for the RADIUS server.

sharedSecret
string

Shared key that UPAM uses to communicate with External Radius Server.

confirmSecret
string

The shared secret key confirmation.

authenticationPort
integer <int32>

TCP/UDP port used to perform authentication. It is required when isRadSecServer false.

accountingPort
integer <int32>

TCP/UDP port used to perform accounting. It is required when isRadSecServer false.

isPreemptionEnabled
required
boolean

Enable/Disable Pre-emption.

preemptionTimeout
integer <int32>

The backup Server timeout in second. It is required when isPreemptionEnabled true.

radSecCertificateId
string

The RadSec certificate ID, it is required if the isRadSecServer is true.

radSecTrustCaId
string

The RadSec CA ID, it is required if the isRadSecServer is true.

tlsPort
integer <int32>

The TLS port, it is required if the isRadSecServer is true.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all external RADIUS Servers.

Get all external RADIUS Servers.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Add a new external RADIUS Server

Add a new external RADIUS Server.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serverName
required
string

External Radius Server name.

hostName
required
string

External Radius Server host name/IP address.

backupHostName
string

Back up external radius server host name/IP address.

retries
required
integer <int32>

Number of times UPAM will attempt to reconnect to the External Radius Server when the connection timeout occurs before concluding that the External Radius Server is unreachable.

timeout
required
integer <int32>

The amount of time, in seconds, that UPAM will attempt a connection to the External Radius Server before timing out.

isRadSecServer
required
boolean

Enable/Disable Security for the RADIUS server.

sharedSecret
string

Shared key that UPAM uses to communicate with External Radius Server.

confirmSecret
string

The shared secret key confirmation.

authenticationPort
integer <int32>

TCP/UDP port used to perform authentication. It is required when isRadSecServer false.

accountingPort
integer <int32>

TCP/UDP port used to perform accounting. It is required when isRadSecServer false.

isPreemptionEnabled
required
boolean

Enable/Disable Pre-emption.

preemptionTimeout
integer <int32>

The backup Server timeout in second. It is required when isPreemptionEnabled true.

radSecCertificateId
string

The RadSec certificate ID, it is required if the isRadSecServer is true.

radSecTrustCaId
string

The RadSec CA ID, it is required if the isRadSecServer is true.

tlsPort
integer <int32>

The TLS port, it is required if the isRadSecServer is true.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple external RADIUS Servers by their ids

Delete multiple external RADIUS Servers.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of external radius servers.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing external radius servers.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all RadSec Client certificates

Get all Radsec Client Certificate.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple RadSec Client certificates

Delete multiple RadSec Client certificates by providing in the body, a list of RadSec Client certificate ids

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The identifiers of the radsec client CA.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of deleting action of multiple radsec CA.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create a RadSec Client Certificate

Upload all the RadSec client certificate files

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data

Request Body schema: multipart/form-data
required
name
required
string

The name of radsec certificate.

certificateFileName
required
object

The serveur certificate file name.

caFiles
required
object

The certificate of the radius server.

password
required
string

The password of the radius server.

keyFile
required
object

The key file of the radius server.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Download a RadSec Client Certificate by Id

Download all the files (cAFiles, serverKeyFile , serverFile) of a certificate ziped.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Cloudidentity

Get Cloud Identity by id

Get Cloud Identity by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the Cloud Identity.

Response samples

Content type
application/json
{
}

Update a Cloud Identity by id

Update a Cloud Identity by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
identityName
string

Cloud Identity name.

identityProvider
required
string
Value: "Azure"

Cloud Identity provider.

identityClientId
required
string

Client ID of the provider.

identityClientSecret
required
string

Client Secret of the provider.

identityTenantId
required
string

Tenant ID of the provider.

identityUsernameSuffix
required
string

Username suffix of the provider.

description
string

Cloud Identity description.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all Cloud Identity

Fetch all Cloud Identity.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing Cloud Identity.

Response samples

Content type
application/json
{
}

Add a new Cloud Identity

Add a new Cloud Identity.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
identityName
required
string

Cloud Identity name.

identityProvider
required
string
Value: "Azure"

Cloud Identity provider.

identityClientId
required
string

Client ID of the provider.

identityClientSecret
required
string

Client Secret of the provider.

identityTenantId
required
string

Tenant ID of the provider.

identityUsernameSuffix
required
string

Username suffix of the provider.

description
string

Cloud Identity description.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple Cloud Identities by their ids

Delete multiple Cloud Identities.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of Cloud Identity.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing Cloud Identity.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Ldapattribute

Get all LDAP attributes

Get all LDAP attributes.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: strategyName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"strategyName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key strategyName, to filter with the same value, use the object {"strategyName":"strategy"}, to filter the records containing a value, use the object {"strategyName":{"contains":"strategy"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a LDAP attribute.

Create an LDAP attribute.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

Name for the ldap attribute.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple LDAP attributes

Delete multiple LDAP attribute by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of LDAP Attribute.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing ldap attributes.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create multiples LDAP attributes

Create many LDAP attributes by names.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
names
required
Array of strings

The array of unique name of LDAP Attribute.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing ldap attributes.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a LDAP attribute

Get an LDAP attribute by Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the ldap attribute.

Response samples

Content type
application/json
{
}

Guestaccount

Get all guest accounts

Get all guest accounts.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: strategyName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"strategyName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key strategyName, to filter with the same value, use the object {"strategyName":"strategy"}, to filter the records containing a value, use the object {"strategyName":{"contains":"strategy"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a guest account

Create a guest account.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
username
required
string

The guest account username.

password
required
string

The guest account password.

accountValidityPeriod
required
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

company
string

The guest account company.

description
string

The guest account description.

email
string

The guest account email.

fullName
string

The guest account full name.

telephone
string

The guest account phone number.

registrationProfile
string

The registration profile name. It is required when serviceLevel is not set.

serviceLevel
string

The guest account service level. It is required when registrationProfile is not set.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Mulitiple guest accounts

Delete multiple guest accounts.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

Ids of guest accounts to delete

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create guests account in batch mode

Create guest accounts in batch mode.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
accountPrefix
required
string

The guest account name prefix.

clientNumber
required
integer <int32>

The number of guest accounts to create.

registrationProfile
string

The registration profile name. It is required when serviceLevel is not set.

serviceLevel
string

The guest account service level name. It is required when registrationProfile is not set.

accountValidityPeriod
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

description
string

The guest account description.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Mass import of guest accounts

Mass import guest accounts.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

An array of guest accounts to be created.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a guest account by id

Get a guest account by id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update a guest account

Update a guest account by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
password
string

The guest account password.

company
string

The guest account company.

description
string

The guest account description.

email
string

The guest account email.

fullName
string

The guest account full name.

telephone
string

The guest account phone number.

registrationProfile
string

The registration profile name. It is required when serviceLevel is not set.

serviceLevel
string

The guest account service level. It is required when registrationProfile is not set.

accountValidityPeriod
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update status for multiple guest accounts

Update status for multiple guest accounts by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
status
string
Enum: "ENABLED" "DISABLED"

The guest account status.

ids
required
Array of strings

The array of unique identifiers of guest accounts.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing guest accounts.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Extend guests account

Extend guest accounts validity and data quota amount.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
idList
required
Array of strings

Ids of guest accounts to be extended

accountValidityPeriod
required
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Extend guest accounts for guest operators

Extend guest accounts validity and data quota amount for guest operators.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
idList
required
Array of strings

Ids of guest accounts to be extended

accountValidityPeriod
required
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get guest access global configuration

Get guest access global configuration.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update guest access global configuration

Update guest access global configuration.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
batchCreation
string

The guest access account batch creation mode

accountPrefix
string

The guest access account prefix

accountValidityPeriod
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

periodUnit
string
Enum: "Day(s)" "Hour(s)" "Minute(s)"

The period unit

deletePolicy
integer <int32>

The number of days after exipration before account should be deleted (-1=Never, 0=Account will be deleted immediately after expiration, 1-90=Number of days after expiration)

effectiveFirstLogin
string

The Values are DISABLED or ENABLED. DISABLED: Batch creation of GuestAccount/AccessCode is valid by default. ENABLED：Enabling batch creation of GuestAccount/AccessCode is valid for the first login.

accessCodeLength
integer <int32>

The length of accessCode used to create AccessCode in batches. the range is 6-16.

passwordEnforcement
string

This is the password policy. There are two choices: STRONG (for a strong password) or WEAK (for weak password).

usernamePolicy
string

The username policy has two choices: STRONG (for a strong usename) or WEAK (for a weak username).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all guest accounts

This API is used by guest operator to get all guest accounts.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: strategyName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"strategyName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key strategyName, to filter with the same value, use the object {"strategyName":"strategy"}, to filter the records containing a value, use the object {"strategyName":{"contains":"strategy"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a guest account for guest operator

This API is used by guest operator to create a guest account.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
username
required
string

The guest account username.

password
required
string

The guest account password.

accountValidityPeriod
required
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

company
string

The guest account company.

description
string

The guest account description.

email
string

The guest account email.

fullName
string

The guest account full name.

telephone
string

The guest account phone number.

registrationProfile
string

The registration profile name. It is required when serviceLevel is not set.

serviceLevel
string

The guest account service level. It is required when registrationProfile is not set.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Mulitiple guest accounts for guest operator

This API is used by guest operator to delete multiple guest accounts.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

Ids of guest accounts to delete

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a guest account by id for guest operator

This API is used by guest operator to get a guest account by id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update a guest account for guest operator

This API is used by guest operator to update a guest account by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
password
string

The guest account password.

company
string

The guest account company.

description
string

The guest account description.

email
string

The guest account email.

fullName
string

The guest account full name.

telephone
string

The guest account phone number.

registrationProfile
string

The registration profile name. It is required when serviceLevel is not set.

serviceLevel
string

The guest account service level. It is required when registrationProfile is not set.

accountValidityPeriod
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create guests account in batch mode for guest operator

This API is used by guest operator to create guest accounts in batch mode.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
accountPrefix
required
string

The guest account name prefix.

clientNumber
required
integer <int32>

The number of guest accounts to create.

registrationProfile
string

The registration profile name. It is required when serviceLevel is not set.

serviceLevel
string

The guest account service level name. It is required when registrationProfile is not set.

accountValidityPeriod
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

description
string

The guest account description.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Mass import of guest accounts for guest operator

This API is used by guest operator to mass import guest accounts.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

An array of guest accounts to be created.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all service levels

Get all service levels.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a service level

Create a service level.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
description
string

The service level description.

periodUnit
required
string
Enum: "Day(s)" "Hour(s)" "Minute(s)"

The period unit

accountValidityPeriod
required
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

deletePolicy
required
integer <int32>

The number of days after exipration before account should be deleted (-1=Never, 0=Account will be deleted immediately after expiration, 1-90=Number of days after expiration)

registrationProfile
required
string

The registration profile name.

arpName
string

Access Role Profile defined for the Service Level

plName
string

Policy List defined for the Service Level

Array of objects

An array of JSON objects containing other attributes.

serviceName
required
string

The service level name.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple service levels

Delete multiple service levels.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

Ids of service levels to delete

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (207)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get service level by id.

Get service level by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get service levels names.

Get service levels names.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update a service level

Update a service level by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
description
string

The service level description.

periodUnit
required
string
Enum: "Day(s)" "Hour(s)" "Minute(s)"

The period unit

accountValidityPeriod
required
integer <int32>

The guest account validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

deletePolicy
required
integer <int32>

The number of days after exipration before account should be deleted (-1=Never, 0=Account will be deleted immediately after expiration, 1-90=Number of days after expiration)

registrationProfile
string

The registration profile name.

arpName
string

Access Role Profile defined for the Service Level

plName
string

Policy List defined for the Service Level

Array of objects

An array of JSON objects containing other attributes.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Guestaccesscode

Get all guest access codes

Get all guest access codes.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: strategyName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"strategyName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key strategyName, to filter with the same value, use the object {"strategyName":"strategy"}, to filter the records containing a value, use the object {"strategyName":{"contains":"strategy"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a guest access code

Create a guest access code.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
accessCode
required
string

The guest access code.

accountValidityPeriod
required
integer <int32>

The guest access code validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

serviceLevel
string

The service level name. It is required if registrationProfile is not set.

registrationProfile
string

The registration profile name. It is required if serviceLevel in this section is not set.

description
string

The guest access code description.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple guest access codes

Delete multiple guest accounts.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

Ids of guest access codes to delete

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get guest access code by id

Get guest access code by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update a guest access code

Update a guest access code.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serviceLevel
string

The service level name. It is required if registrationProfile is not set.

registrationProfile
string

The registration profile name. It is required if serviceLevel in this section is not set.

description
string

The guest access code description.

accountValidityPeriod
integer <int32>

The guest access code validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Mass import of guest access codes

Mass import guest access codes.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

An array of guest access codes to be created.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create guest access codes in batch mode

Create guest access codes in batch mode.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serviceLevel
string

The service level name. It is required if registrationProfile is not set.

registrationProfile
string

The registration profile name. It is required if serviceLevel in this section is not set.

description
string

The guest access code description.

clientNumber
required
integer <int32>

Number of Access code to create.

accountValidityPeriod
integer <int32>

The guest access code validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update status for multiple guest access codes

Update status for multiple guest access codes by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
status
string
Enum: "ENABLED" "DISABLED"

The guest access code status.

ids
required
Array of strings

The array of unique identifiers of guest access code.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing guest access codes.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Extend guest access codes

Extend guest access codes validity period.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
idList
required
Array of strings

Ids of guest access codes to be extended

accountValidityPeriod
required
integer <int32>

The guest access code validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Extend guest access codes for guest operators

Extend guest access codes validity period.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
idList
required
Array of strings

Ids of guest access codes to be extended

accountValidityPeriod
required
integer <int32>

The guest access code validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all guest access codes for guest operator

This API is used by guest operator to get all guest access codes.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: strategyName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"strategyName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key strategyName, to filter with the same value, use the object {"strategyName":"strategy"}, to filter the records containing a value, use the object {"strategyName":{"contains":"strategy"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a guest access code for guest operator

This API is used by guest operator to get a guest access code by Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
accessCode
required
string

The guest access code.

accountValidityPeriod
required
integer <int32>

The guest access code validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

serviceLevel
string

The service level name. It is required if registrationProfile is not set.

registrationProfile
string

The registration profile name. It is required if serviceLevel in this section is not set.

description
string

The guest access code description.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple guest access codes for guest operator

This API is used by guest operator to delete multiple guest accounts.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

Ids of guest access codes to delete

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get guest access code by id for guest operator

This API is used by guest operator to get guest access code by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update a guest access code for guest operator

This API is used by guest operator to update a guest access code.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serviceLevel
string

The service level name. It is required if registrationProfile is not set.

registrationProfile
string

The registration profile name. It is required if serviceLevel in this section is not set.

description
string

The guest access code description.

accountValidityPeriod
integer <int32>

The guest access code validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Mass import of guest access codes for guest operator

This API is used by guest operator to mass import guest access codes.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
Array of objects

An array of guest access codes to be created.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create guest access codes in batch mode for guest operator

This API is used by guest operator to create guest access codes in batch mode.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serviceLevel
string

The service level name. It is required if registrationProfile is not set.

registrationProfile
string

The registration profile name. It is required if serviceLevel in this section is not set.

description
string

The guest access code description.

clientNumber
required
integer <int32>

Number of Access code to create.

accountValidityPeriod
integer <int32>

The guest access code validity period (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000).

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Guestconfiguration

Get guest ticket template configuration

Get guest ticket template configuration.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update guest ticket template configuration

Update guest ticket template configuration.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
header
string

The header text of the pdf ticket

footer
string

The footer text of the pdf ticket

logoUrl
string

The image location name where the logo of the pdf ticket has been uploaded. Ex: 423c45b9-7396-4c09-8945-c7b3a8ed4940.png

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Selfregistrationrequests

Get all guest access self registration requests

Get all guest access self registration requests.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: approver. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"approver":"ASC"}]

filters
Array of arrays

The filter applied to filter the value of specific object fields in records. The field name in filter object corresponds to the field in the record, for example: approver. If no filter applied, send an empty Array. The name of this query is an enum of: LIKE, EQUAL. ex: filter : [{"approver":{"LIKE":"jhone"}, "and":"true"}]

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete guest access self registration requests

Delete guest access self registration requests by ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of self registration requests.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the self registration request.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Approve or reject guest access self registration requests

Approve or reject guest access self registration requests by ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of self registration requests.

status
required
string
Enum: "APPROVED" "REJECTED"

The self registration request status.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing self registration requests.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get all guest access self registration requests for guest operator

This API is used by guest operator to get all guest access self registration requests.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: approver. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"approver":"ASC"}]

filters
Array of arrays

The filter applied to filter the value of specific object fields in records. The field name in filter object corresponds to the field in the record, for example: approver. If no filter applied, send an empty Array. The name of this query is an enum of: LIKE, EQUAL. ex: filter : [{"approver":{"LIKE":"jhone"}, "and":"true"}]

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete guest access self registration requests for guest operator

This API is used by guest operator to delete guest access self registration requests by ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of self registration requests.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the self registration request.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Approve or reject guest access self registration requests for guest operator

This API is used by guest operator to approve or reject guest access self registration requests by ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of self registration requests.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing self registration requests.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Collectsupportinfo

Retrieve Collect Support Info for AP/Switch

Retrieve collect support information for AP/Switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Create Collect Support Info for AP/Switch

Create collect support information for AP/Switch

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
macAddress
required
string

The MAC address of the device.

siteId
required
string

Unique site identifier.

type
required
string

Type of the device. It can be 'AP' or 'Switch'.

serialNumber
required
string

The serial number of the device.

object

A JSON object containing the details of a switch and this can be used only when collect support information is done for switch and it is not applicable for AP. Thereby, this JSON Object is required only for switch

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object containing status and message of created collect support info.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Collect Support Info for AP/Switch

Delete collect support information for AP/Switch.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
ids
required
Array of strings

"ids" is an array of ids corresponding to the collect support info ids to be deleted.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (207)

message
string

Status message associated to the response.

data
Array of arrays

An array of ID collect support info for AP/Switch to be deleted.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Accesspolicy

Get all access policies

Get all access policies.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create an access policy

Create an access policy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
strategyName
required
string

The access policy name.

authenticationAgainst
required
string
Enum: "None" "Local Database" "External Radius" "Cloud-Identity"

The source of the user profile (Account/Password). The user profile can reside on different servers and it is required to specify where so that UPAM is able to obtain the user profile for authentication.

serverName
string

The name of external RADIUS server. It is required if authenticationAgainst is External Radius or Cloud-Identity

priority
required
integer <int32>

Access Policy Priority. A user requesting authentication may match several access policies and the one with highest priority will take effect after passing the authentication.

required
Array of objects

An array of JSON objects containing conditions.

Array of objects

An array of JSON objects containing other attributes.

object

A JSON object containing Mac Check Enforcement attributes.

conditionDemo
required
integer <int32>

The condition demo

guestStrategy
string

The access strategy for guest users..

byodStrategy
string

the access strategy for employee users with BYOD devices.

webAuthentication
required
string
Enum: "Guest" "BYOD" "Guest or BYOD" "None"

The Web Authentication Strategy used (None, Guest, BYOD, Guest or BYOD).

defaultARPName
string

Default Access Role Profile for the authentication strategy.

defaultPLName
string

Default Access Policy for the authentication strategy.

eapTypeRestriction
string
Enum: "DISABLED" "ENABLED"

Enable to restricted the EAP method defined in the eapType

eapType
Array of strings
Items Enum: "EAP-TLS" "EAP-PEAP"

An array of string of allowed EAP methods.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple access policies

Delete multiple access policies.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of access policies.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing deleted access policies information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get an access policy.

Get an access policy by Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update an access policy

Update an access policy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
authenticationAgainst
required
string
Enum: "None" "Local Database" "External Radius" "Cloud-Identity"

The source of the user profile (Account/Password). The user profile can reside on different servers and it is required to specify where so that UPAM is able to obtain the user profile for authentication.

serverName
string

The name of external RADIUS server. It is required if authenticationAgainst is External Radius or Cloud-Identity

priority
required
integer <int32>

Access Policy Priority. A user requesting authentication may match several access policies and the one with highest priority will take effect after passing the authentication.

required
Array of objects

An array of JSON objects containing conditions.

Array of objects

An array of JSON objects containing other attributes.

object

A JSON object containing Mac Check Enforcement attributes.

conditionDemo
required
integer <int32>

The condition demo

guestStrategy
string

The access strategy for guest users..

byodStrategy
string

the access strategy for employee users with BYOD devices.

webAuthentication
required
string
Enum: "Guest" "BYOD" "Guest or BYOD" "None"

The Web Authentication Strategy used (None, Guest, BYOD, Guest or BYOD).

defaultARPName
string

Default Access Role Profile for the authentication strategy.

defaultPLName
string

Default Access Policy for the authentication strategy.

eapTypeRestriction
string
Enum: "DISABLED" "ENABLED"

Enable to restricted the EAP method defined in the eapType

eapType
Array of strings
Items Enum: "EAP-TLS" "EAP-PEAP"

An array of string of allowed EAP methods.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Guestaccessstrategy

Get guest access strategies

Get guest access strategies.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a guest access strategy

Create a guest access strategy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
strategyName
required
string

The guest access strategy name.

redirectionStrategy
required
string

The captive portal page template used for guest user login.

protocolMode
required
string
Enum: "HTTPS" "HTTP"

The http protocol used to redirect the captive portal page (https or http).

fqdnMode
required
string
Enum: "FQDN" "IP"

The displayed URL format for redirection to the captive portal page (FQDN or IP).

authenticationResource
required
string

The guest user profile database.

required
object

Data associated with the self-registration attributes for guest user login.

required
object

Data associated with the post portal authentication enforcement.

object

Data associated with the guest user login.

required
object

Data associated with the social guest user login.

wifi4EUSwitch
string
Enum: "DISABLED" "ENABLED"

Enable or disable the use of the WiFi4EU feature.

selfTestModus
string

The WiFi4EU portal self-test mode.

networkIdentifier
string

The network identifier received from the WiFi4EU portal as part of installation report.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple guest access strategies

Delete multiple guest access strategies by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

An array of guest access strategies identifiers to be deleted.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing deleted guest access strategies information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a guest access strategy

Get a single guest access strategy indetified by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update a guest access strategy

Update a guest access strategy by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
redirectionStrategy
required
string

The captive portal page template used for guest user login.

protocolMode
required
string
Enum: "HTTPS" "HTTP"

The http protocol used to redirect the captive portal page (https or http).

fqdnMode
required
string
Enum: "FQDN" "IP"

The displayed URL format for redirection to the captive portal page (FQDN or IP).

authenticationResource
required
string

The guest user profile database.

required
object

Data associated with the self-registration attributes for guest user login.

required
object

Data associated with the post portal authentication enforcement.

object

Data associated with the guest user login.

required
object

Data associated with the social guest user login.

wifi4EUSwitch
string
Enum: "DISABLED" "ENABLED"

Enable or disable the use of the WiFi4EU feature.

selfTestModus
string

The WiFi4EU portal self-test mode.

networkIdentifier
string

The network identifier received from the WiFi4EU portal as part of installation report.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Guestemailsmstemplate

Get all SMS or Email template guest access strategy

Get all SMS or Email template guest access strategy requests.

query Parameters
type
string

Choice the type of template ("SMS" or "EMAIL") to select

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing the templates for each language.

Response samples

Content type
application/json
{
}

Get one SMS or Email template guest access strategy

Get one SMS or Email template guest access strategy by Id.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the content template.

Response samples

Content type
application/json
{
}

Update a SMS or a Email template guest access strategy

Update a SMS or a Email template guest access strategy by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
content
string

The content of 'sms' or 'email'.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
string

data always null.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Companyproperty

Get all company properties.

Get all company properties.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order fields of each record object. The field name corresponds to the field in one record, ex: strategyName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"strategyName":"ASC"}]

filters
Array of arrays

Object of the specific fields from the record object to filter the list of records. The field name corresponds to the key of the record object, for example: for the key strategyName, to filter with the same value, use the object {"strategyName":"strategy"}, to filter the records containing a value, use the object {"strategyName":{"contains":"strategy"}}. To filter by more attributes, add more fields in the object. If no filter applied, send an empty object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a company property.

Create a company property.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceFamily
string
Enum: "Alcatel-Lucent Enterprise" "Apple" "Samsung" "Huawei" "Microsoft" "LG" "Lenovo" "HP" "IBM" "Nokia" "MI" "HTC" "Sony" "Blackberry" "Others"

The family of the company device.

deviceCategory
string
Enum: "Computer" "Mobile" "Tablet" "Game console" "Digital media receiver" "Others"

The category of the company device.

deviceName
string

The system name of the comapny device.

deviceOS
string
Enum: "Linux" "Windows" "MacOS" "Android" "IOS" "Others"

The operation system of the company device.

employeeAccount
string

The emmployee account to which the company device is associated.

arpName
string

The Access Role Profile that is bound to the company device. It is prior to the Access Role Profile configured in Authentication Strategy. Send an empty string to remove it.

plName
string

The Policy that is bound to the company device. It is prior to the Policy configured in an Authentication Strategy. Send an empty string to remove it.

Array of objects

An array of JSON objects containing other attributes.

enableDeviceSpecificPSK
string
Enum: "DISABLED" "ENABLED"

Enable or Disable the Device Specific PSK for the company property.

deviceSpecificPassphrase
string

The Device Specific PSK for the device. It is auto-removed when enableDeviceSpecificPSK is DISABLED

expireFlag
string
Enum: "Never" "Custom"

Always or limit period for Device Specific PSK of the company property.

pskValidityPeriod
integer <int32>

The PSK validity period for the PSK in Custom case.

deviceMac
required
string

The MAC address of the company device

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple company properties.

Delete multiple company properties by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of company properties.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing company properties.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a company property.

Get a company property by Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the company property.

Response samples

Content type
application/json
{
}

Update a company property.

Update a company property by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceFamily
string
Enum: "Alcatel-Lucent Enterprise" "Apple" "Samsung" "Huawei" "Microsoft" "LG" "Lenovo" "HP" "IBM" "Nokia" "MI" "HTC" "Sony" "Blackberry" "Others"

The family of the company device.

deviceCategory
string
Enum: "Computer" "Mobile" "Tablet" "Game console" "Digital media receiver" "Others"

The category of the company device.

deviceName
string

The system name of the comapny device.

deviceOS
string
Enum: "Linux" "Windows" "MacOS" "Android" "IOS" "Others"

The operation system of the company device.

employeeAccount
string

The emmployee account to which the company device is associated.

arpName
string

The Access Role Profile that is bound to the company device. It is prior to the Access Role Profile configured in Authentication Strategy. Send an empty string to remove it.

plName
string

The Policy that is bound to the company device. It is prior to the Policy configured in an Authentication Strategy. Send an empty string to remove it.

Array of objects

An array of JSON objects containing other attributes.

enableDeviceSpecificPSK
string
Enum: "DISABLED" "ENABLED"

Enable or Disable the Device Specific PSK for the company property.

deviceSpecificPassphrase
string

The Device Specific PSK for the device. It is auto-removed when enableDeviceSpecificPSK is DISABLED

expireFlag
string
Enum: "Never" "Custom"

Always or limit period for Device Specific PSK of the company property.

pskValidityPeriod
integer <int32>

The PSK validity period for the PSK in Custom case.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the company property.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Send QR Code to Employee Account.

Send the QR code to the Employee account's email configured in the company property.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of company properties.

ssid
required
string

Unique SSID identifier.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing company properties.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Mass import of company properties.

Mass import company properties.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of company properties to be created.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing company properties.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Nasclients

Get all NAS clients.

Get all NAS clients.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a NAS client.

Create a NAS client.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
nasName
string

The name of the NAS Client.

startNasIP
string

The starting IP of the NAS Client segment.

endNasIP
string

The ending IP of the NAS Client segment.

shareSecurity
string

The shared secret used by the NAS client to communicate with the Authentication Server.

description
string

An optional description for the NAS Client.

dmAttributes
Array of strings

The DM message is used to disconnect subscriber sessions in the system from a RADIUS server. The DM request message should contain necessary attributes (User-Name/Calling-Station-Id) to identify the subscriber session

coaAttributes
Array of strings

The COA message is used to disconnect subscriber sessions in the system from a RADIUS server. The COA request message should contain necessary attributes (User-Name/Calling-Station-Id) to identify the subscriber session

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple NAS clients.

Delete multiple NAS clients by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of NAS clients.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing NAS clients.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a NAS client.

Get a NAS client by Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the NAS client.

Response samples

Content type
application/json
{
}

Update a NAS client.

Update a NAS client by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
description
string

An optional description for the NAS Client.

shareSecurity
string

The shared secret used by the NAS client to communicate with the Authentication Server.

dmAttributes
Array of strings

The DM message is used to disconnect subscriber sessions in the system from a RADIUS server. The DM request message should contain necessary attributes (User-Name/Calling-Station-Id) to identify the subscriber session

coaAttributes
Array of strings

The COA message is used to disconnect subscriber sessions in the system from a RADIUS server. The COA request message should contain necessary attributes (User-Name/Calling-Station-Id) to identify the subscriber session

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Byodaccessstrategy

Retrieve BYOD access strategies

Get BYOD access strategies.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a BYOD access strategy

Create a BYOD access strategy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
strategyName
required
string

The BYOD access strategy name.

url
string

The BYOD access strategy URL.

redirectionStrategy
string

The captive portal page template used for BYOD user login.

successRedirectUrl
string

The redirect URL option after the BYOD user passes captive portal authentication (none, go to initial URL, go to fixed url).

authenticationSource
required
string
Enum: "Local Database" "On-Premise LDAP" "External Radius"

The BYOD user profile database.

serverName
string

The name of external RADIUS server. It is required if authenticationSource is External Radius

fixedAccessRoleProfile
string

The access role profile assigned to the Byod user after passing authentication.

fixedPolicyList
string

The policy List assigned to the Byod user after passing authentication.

enableRoleMapping
string
Enum: "ENABLED" "DISABLED"

Enable or disable the use of the Role Mapping.

protocolMode
string
Enum: "HTTPS" "HTTP"

The http protocol used to redirect the captive portal page (https or http).

fqdnMode
string
Enum: "FQDN" "IP"

The displayed URL format for redirection to the captive portal page (FQDN or IP).

portalUrl
string

The portal URL.

periodUnit
string
Enum: "Day(s)" "Hour(s)" "Minute(s)"

The period unit

rememberDevice
string
Enum: "ENABLED" "DISABLED"

Enable or disable remembering user devices.

expireFlag
string

The BYOD access strategy expire setting (1: device never expired, 0: customized device expiry period).

deviceValidityPeriod
integer <int32>

The length of time that the user device is valid. This value is entered based on the selected Period Unit.

maxDeviceNumberPerAccount
integer <int32>

Maximum number of devices that can access the network with one single guest account.

Array of objects

An array of JSON objects containing other attributes.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple BYOD access strategies

Delete multiple BYOD access strategies by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

An array of BYOD access strategies identifiers to be deleted.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing deleted BYOD access strategies information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a BYOD access strategy by ID

Get a BYOD access strategy by its ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Response samples

Content type
application/json
{
}

Update a BYOD access strategy

Update a BYOD access strategy by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
url
string

The BYOD access strategy URL.

redirectionStrategy
string

The captive portal page template used for BYOD user login.

successRedirectUrl
string

The redirect URL option after the BYOD user passes captive portal authentication (none, go to initial URL, go to fixed url).

authenticationSource
required
string
Enum: "Local Database" "On-Premise LDAP" "External Radius"

The BYOD user profile database.

serverName
string

The name of external RADIUS server. It is required if authenticationSource is External Radius

fixedAccessRoleProfile
string

The access role profile assigned to the Byod user after passing authentication.

fixedPolicyList
string

The policy List assigned to the Byod user after passing authentication.

enableRoleMapping
string
Enum: "ENABLED" "DISABLED"

Enable or disable the use of the Role Mapping.

protocolMode
string
Enum: "HTTPS" "HTTP"

The http protocol used to redirect the captive portal page (https or http).

fqdnMode
string
Enum: "FQDN" "IP"

The displayed URL format for redirection to the captive portal page (FQDN or IP).

portalUrl
string

The portal URL.

periodUnit
string
Enum: "Day(s)" "Hour(s)" "Minute(s)"

The period unit

rememberDevice
string
Enum: "ENABLED" "DISABLED"

Enable or disable remembering user devices.

expireFlag
string

The BYOD access strategy expire setting (1: device never expired, 0: customized device expiry period).

deviceValidityPeriod
integer <int32>

The length of time that the user device is valid. This value is entered based on the selected Period Unit.

maxDeviceNumberPerAccount
integer <int32>

Maximum number of devices that can access the network with one single guest account.

Array of objects

An array of JSON objects containing other attributes.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Radiusattribute

Retrieve radius attributes of a given scope

Get all radius attributes of a given scope (1 - AccessPolicy, 2 - AuthEnforcement, 4 - COA/DM) whithin an organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Byoddevice

Get online BYOD Devices

Get all online BYOD Devices.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Kick multiple BYOD devices offline

Kick multiple BYOD devices offline by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

An array of BYOD devices identifiers to be deleted.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing deleted BYOD devices offline information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get BYOD remember record list

Get all BYOD remember record list.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: deviceMac. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"deviceMac":"ASC"}]

filters
Array of arrays

The filter applied to filter the value of a specific object fields in record. The field name in filter object corresponds to the field in the record, for example: deviceMac. If no filter applied, send an empty Array. The name of this query is an enum of: LIKE, EQUAL. ex: filter : [{"deviceMac":{"LIKE":"143CC32CF77A"}, "and":"true"}]

startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

search
string

The search is applied to filter all the fields in the object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple BYOD remember devices

Delete multiple BYOD remember devices by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

An array of BYOD remember devices identifiers to be deleted.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing deleted BYOD remembered devices information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Guestdevice

Get online guest devices list

Get all online guest devices list.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Kick multiple guest devices offline

Kick multiple guest devices offline by their MAC addresses.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

An array of guest devices mac addresses to be kicked offline.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing kicked guest devices offline information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get guest remembered records list

Get all guest remembered records list.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: deviceMac. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"deviceMac":"ASC"}]

filters
Array of arrays

The filter applied to filter the value of a specific object fields in record. The field name in filter object corresponds to the field in the record, for example: deviceMac. If no filter applied, send an empty Array. The name of this query is an enum of: LIKE, EQUAL. ex: filter : [{"deviceMac":{"LIKE":"143CC32CF77A"}, "and":"true"}]

startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

search
string

The search is applied to filter all the fields in the object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create Guest Remember Device

Create a Guest Remember Device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
account
required
string

Name of the guest remember device.

deviceMac
required
string

MAC of the guest remember device.

deviceCategory
string

Category of the device.

deviceOS
string

Operation System of the device.

deviceFamily
string

Family of the device.

description
string

Description of the guest remember device.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple guest remembered devices

Delete multiple guest remembered devices by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

An array of guest remembered devices identifiers to be deleted.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing deleted guest remembered devices information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reset Quota guest remembered devices

Reset Time Data Quota of a guest remembered device by its Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
dataQuotaThreshold
integer <int32>

Maximum data quota not to be exceeded.

timeQuotaPerDay
integer <int32>

Quota of the number of hours during which access will be allowed per day.

timeQuotaByHour
integer <int32>

Number of hours during which access will be allowed before data is blocked.

blockedHours
integer <int32>

Time in hours during which the data will be blocked before returning to normal.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Authenticationrecord

Get authentication records list

Get all authentication records list.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: deviceMac. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"deviceMac":"ASC"}]

filters
Array of arrays

The filter applied to filter the value of a specific object fields in record. The field name in filter object corresponds to the field in the record, for example: deviceMac. If no filter applied, send an empty Array. The name of this query is an enum of: LIKE, EQUAL. ex: filter : [{"deviceMac":{"LIKE":"143CC32CF77A"}, "and":"true"}]

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Generate PSK for history authentication records

Create the DSPSK for the history authentication records by device MAC.

Request Body schema: application/json
required
macs
required
Array of strings

The array of the record's device MAC.

pskValidityPeriod
integer <int32>

The validity period of the PSK (in Unix timestamp format to the accuracy of milliseconds ex: 1654500839000). If this field is not sent, the PSK is always valid .

generatePskMode
string
Enum: "DISTINCT" "NORMAL"

Generate the same PSK for all the devices or distinct PSK for each devices.

Responses

Request samples

Content type
application/json
{
}

Get history of authentication records

Get the history of authentication records.

query Parameters
limit
integer

The number of records to fetch from the total records.

offset
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: deviceMac. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"deviceMac":"ASC"}]

filters
Array of arrays

The filter applied to filter the value of a specific object fields in record. The field name in filter object corresponds to the field in the record, for example: deviceMac. If no filter applied, send an empty Array. The name of this query is an enum of: LIKE, EQUAL. ex: filter : [{"deviceMac":{"LIKE":"143CC32CF77A"}, "and":"true"}]

startDate
required
string

"startDate" is the start date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00

endDate
required
string

"endDate" is the end date of the period in this format: YYYY-MM-DDTHH:mm:ss+HH:mm which include the timezone, ex: 2021-03-28T00:00:00+01:00.

search
string

The search is applied to filter all the fields in the object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple authentication records

Delete multiple authentication records by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
Array of strings

An array of authentication records identifiers to be deleted.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing deleted authentication records information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get history authentication records detail

Get the detail of history authentication record by record Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get online authentication records detail

Get the detail of online authentication record by client MAC address.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Classifications

Get all classifications

Get all classifications for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the response.

Response samples

Content type
application/json
{
}

Create classifications

Create classifications for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
required
object

The object of the classification.

object

The assignment of the profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update classifications

Update classifications for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
required
object

The object of the classification.

object

The assignment of the profile.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

The JSON object of the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple classifications by names

Delete multiple classifications by names for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
names
required
Array of strings

The array of the names which are removed.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

The JSON array of the classification.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get classifications by Id

Get classifications by id for a given organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

The JSON object of the response.

Response samples

Content type
application/json
{
}

Guestoperator

get list of Guests operators

Get list of Guests operators.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of records.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: strategyName. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"strategyName":"ASC"}]

filters
Array of arrays

The filter applied to filter the value of specific object fields in records. The field name in filter object corresponds to the field in the record, for example: strategyName. If no filter applied, send an empty Array. The name of this query is an enum of: LIKE, EQUAL. ex: filter : [{"strategyName":{"LIKE":"strategy"}, "and":"true"}]

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated with the response.

Response samples

Content type
application/json
{
}

Create a new guest operator

Create new guest operator.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
username
required
string

The user name for the guest operator.

fullName
required
string

The full name of the guest operator.

telephone
string

The telephone number of the guest operator.

password
required
string

The password for the guest operator.

email
required
string

The Email address of the guest operator.

description
string

The description of this guest operator.

location
string

The location of the guest operator.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete multiple guests operators

Delete multiple guests operators by Ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

An array of guests operators identifiers to be deleted.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing deleted guest operators information and operation status.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get guest operator by id

Get guest operator by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Update a guest operator by id

Update a guest operator by id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
fullName
string

The optional full name of the guest operator.

telephone
string

The optional telephone number of the guest operator.

password
string

The optional password for the guest operator.

email
string

The optional Email address of the guest operator.

description
string

The optional description of this guest operator.

location
string

The optional location of the guest operator.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get guest operator locations

Get the guest operator list of locations.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

data
Array of strings

An array of string containing available guest operator locations.

Response samples

Content type
application/json
{
}

Captiveportalaccessrecords

Get all captive portal access records.

Get all captive portal access records.

query Parameters
limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: deviceMac. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"deviceMac":"ASC"}]

filters
Array of arrays

The filter applied to filter the value of a specific object fields in record. The field name in filter object corresponds to the field in the record, for example: deviceMac. If no filter applied, send an empty Array. The name of this query is an enum of: LIKE, EQUAL. ex: filter : [{"deviceMac":{"LIKE":"143CC32CF77A"}, "and":"true"}]

search
string

The search is applied to filter all the fields in the object.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple captive portal access records

Delete multiple captive portal access records by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of captive portal access records.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing captive portal access records.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Globalpolicy

Get the global policy

Get global policy

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the organization site.

Response samples

Content type
application/json
{
}

Update the global policy

Update global policy

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
accountLockoutThreshold
required
integer <int32>

Account lockout threshold can set a value from 3 through 999 for failed sign-in attempts, or we can specify that the account will never be locked by setting the value to 0. Default = 5.

accountLockoutDuration
required
integer <int32>

Account lockout threshold is set to a number greater than zero, Account lockout duration can be set from 300 seconds (5 minutes) to 18000 seconds (5 hours), with default = 900 (15 minutes). It's a number of minutes expressed in seconds.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated organization site.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Radsecca

Get all RadSecs CA

Get all RadSecs CA of organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a radsec CA

Create new radsec CA in organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data

Request Body schema: multipart/form-data
required
name
required
string

The name of radsec CA.

file
required
string

The name of the uploaded CA file.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple RadSecs CA

Delete multiple RadSecs CA identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The identifiers of the radsecs CA.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of deleting action of multiple radsec CA.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Download a radsec CA by id

Download a radsec CA identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Radiustrustca

Get all Radius CA

Get all Radius CA of organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Create a radius CA

Create new radius trust CA in organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

multipart/form-data

Request Body schema: multipart/form-data
required
name
required
string

The name of radius CA.

file
required
string

The name of the uploaded CA file.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple Radius Trust CA

Delete multiple Radius trust CA identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The identifiers of the radius CA.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of deleting action of multiple radius CA.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Download a radius CA by id

Download a radius CA identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Trust Radius Certification Authority

Trust Radius Certification identified by their ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The identifiers of the radius CA.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of trust action.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Untrust Radius Certification Authority

Untrust Radius Certification Authority by Id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The identifiers of the radius CA.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of untrust action.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Schedulerbackup

Get all Schedules Backups

Get all Backup Schedulers.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of JSON objects containing description of all scheduled jobs of one organization

Response samples

Content type
application/json
{
}

Delete multiple Backup Schedulers

Delete mutiple Backup Schedulers identified by there ids.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of scheduler.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

An array of deleted schedules jobs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create a Backup Scheduler

Create a Backup Scheduler

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

Name of the backup job.

description
required
string

Description of the backup job.

includeSecurityFiles
required
boolean

Whether security files are included in the backup.

paused
required
boolean

Whether the backup job is paused.

scope
required
string
Enum: "site" "switch_sn" "floor"

Type of the scope.

scopeId
required
Array of strings

Array of scope ID. If scope is switch_sn, it is the array of Master serial number if the device is in VC. Unless, it is the serial number of the device

repeat
required
string
Enum: "daily" "weekly" "monthly"

Frequency of the backup job.

startDate
required
string

Start date of the backup job in ISO format.

endDate
required
string

End date of the backup job in ISO format.

dayInWeeks
required
Array of strings

Days of the week when the backup job is scheduled to run, represented as numbers from '1' (Monday) to '7' (Sunday).

dayInMonths
required
Array of strings

Days of the month when the backup job is scheduled to run, numbers range from '1' to '31'.

hourInDay
required
integer <int32>

Hour of the day when the backup job is scheduled to start, represented as an hour in 24-hour format.

minute
required
integer <int32>

Minute of the hour when the backup job is scheduled to start.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a Backup Scheduler by id

Fetch one Backup Scheduler identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the scheduled job.

Response samples

Content type
application/json
{
}

Update a Backup Scheduler by id

Update one schedule backup identified by its id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

Name of the backup job.

description
required
string

Description of the backup job.

includeSecurityFiles
required
boolean

Whether security files are included in the backup.

paused
required
boolean

Whether the backup job is paused.

scope
required
string
Enum: "site" "switch_sn" "floor"

Type of the scope.

scopeId
required
Array of strings

Array of scope ID. If scope is switch_sn, it is the array of Master serial number if the device is in VC. Unless, it is the serial number of the device

repeat
required
string
Enum: "daily" "weekly" "monthly"

Frequency of the backup job.

startDate
string

Start date of the backup job in ISO format. If the job started already, it is not modifiable.

endDate
string

End date of the backup job in ISO format.

dayInWeeks
required
Array of strings

Days of the week when the backup job is scheduled to run, represented as numbers from '1' (Monday) to '7' (Sunday).

dayInMonths
required
Array of strings

Days of the month when the backup job is scheduled to run, numbers range from '1' to '31'.

hourInDay
required
integer <int32>

Hour of the day when the backup job is scheduled to start, represented as an hour in 24-hour format.

minute
required
integer <int32>

Minute of the hour when the backup job is scheduled to start.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

A JSON object of the updated scheduled job.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Deactivate multiple backup schedulers

Deactivate multiple backup schedulers by their id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of scheduler.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON Object of the deactivated scheduled jobs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Activate multiple backup schedulers

Activate multiple backup schedulers identified by their id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of unique identifiers of scheduler.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

Array of objects

A JSON Object of the scheduled jobs.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Configurationbackup

Get all configuration backups

Get the list of configuration backups created by scope.

query Parameters
scope
required
string

"scope" is the target: org, site, switch_sn.

scopeId[]
required
string

Array of id corresponding to the selected scope. If the switch is in a VC, it should be the serial number of the Master in switch's VC.

limit
required
integer

The number of records to fetch from the total records.

offset
required
integer

The start position of the records to fetch over the total number of record.

sort
Array of arrays

"sort" is an array of sort order for each field of object in the record. The field name corresponds to the field in one record, ex: clientIp. Its value is enum of ASC, DESC (ascending or descending order). If no sorting applied, send an empty array. ex: sort: [{"clientIp":"ASC"}]

filters
required
object

The filter applied to filter the value of a specific object field in record. The field name in filter object corresponds to the field in one record, for example: clientIp. If no filter applied, send an empty JSON. The name of this query is an enum of: contains, !=, startsWith, endsWith. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'clientMac': '00:1B:2A:3C:4D:5F'. ex: filter with object: {"clientMac":{"contains":"00:1B"}}

latestBackupByDevice
boolean

Option to distinct the backup by device, by default all backups are fetched.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Delete multiple configuration backups

Delete multiple configuration backups by providing a list of ids in the body

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
ids
required
Array of strings

The array of backup identifiers

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create Instant Backup

Create Instant Backup for multiple devices

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumbers
required
Array of strings

The array of Master serial number if the device is in VC. Unless, it is the serial number of the device

description
required
string

Description of the instant backup. Null allowed.

isSecurityFiles
required
boolean

Whether security files are included in the backup.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

Array of objects

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Configuration backup by Id

Get the details (including file list) of a given backup by its ID.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated with the response. (200)

message
string

Status message associated with the response.

object

Backup of device configuration.

Response samples

Content type
application/json
{
}

Get File content of a Configuration backup

Get get files of configuration backup by backup ID and file Id.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

data
string

Content of file.

Response samples

Content type
application/json
{
}

Download a Configuration backup by Id

Download a zip file of a Configuration backup.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Restorebackup

Create a restore

Create a backup restore on a device.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
device
required
string

Serial number of the device.

backupId
required
string

backupId corresponding to the device with a status COMPLETED.

checkImages
required
boolean

check chassis in the restore.

checkChassis
required
boolean

check chassis in the restore.

rebootNeeded
required
boolean

Reboot device at end of restore.

description
string

Description of this restore.

files
required
Array of strings

Array of file ids to restore.

rebootDirectory
required
string

Reboot directory.

startDate
string

Start date of the restore job in ISO format.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (201)

message
string

Status message associated to the response.

object

restore of device configuration.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete Restore

Delete restore only when status is COMPLETED or FAILED.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

object

Response samples

Content type
application/json
{
}

Get the list of restores performed

Get the list of restores performed in the selected scope.

query Parameters
scope
required
string

"scope" is the target: org, site, building, floor, ap, switch_sn.

devType
string

"devType" is the target: ap, switch_sn or all.

scopeId[]
required
string

"scopeId" is an array of id corresponding to the selected scope, could be an array of device MAC Address if scope is "ap". It is required when scope is org, site, building, floor or ap

limit
required
string

the number of record to fetch from the total records, ex: 10.

offset
required
string

The start position of the records to fetch over the total number of record, ex: 0.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Get restore details for a restoreId

This API is used get details of a restore (including restored files status).

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated with the response.

object

Restore details.

Response samples

Content type
application/json
{
}

Pii

Retrieve org PII data

Fetch all Personal Identifiable Information (PII) that were stored in OmniVista Cirrus. Using this API, you well get all PII data from all Access Points that have been declared at least one time in this organization.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}

Cancel a delete PII request

Enable again the storage of Personal Identifiable Information (PII) for a given list of clients.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
keyType
required
string

The type of the key used to delete.

keyValues
required
Array of strings

The value of keys used to delete.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete PII data

Delete all Personal Identifiable Information (PII) for a given list of clients. Important: When this request is performed, please note that the next data retrieved for the list of provided clients will no more stored in the system. For enabling the data to be stored again for these clients, you should call the cancel API for them.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
keyType
required
string

The type of the key used to delete.

keyValues
required
Array of strings

The value of keys used to delete.

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Retrieve Access Point PII data

Fetch all Personal Identifiable Information (PII) for one Access Point. Using this API, you will get all PII data for all clients that have been connected on this Access Point.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response Schema: application/json
status
integer

HTTP Status Code associated to the response. (200)

message
string

Status message associated to the response.

object

Data associated to the response.

Response samples

Content type
application/json
{
}