logo
API docs by Redocly

OmniVista Cirrus Developer API Reference (10.4.3)

Download OpenAPI specification:Download

Alcatel-Lucent Enterprise: ALE.WelcomeCenter@al-enterprise.com URL: https://manage.ovcirrus.com License: Apache 2.0 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/PUT/DELETE are used. Standard HTTP responses are used to provide requested information or error status. There is no session notion in OmniVista Cirrus system, so requests could be issued according stateless model, without transport conservation between them. 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 should contain some credential information to authenticate itself. Standard HTTP authentication with basic/bearer modes is used. JSON Web Token mechanism is used to provide authentication information. JWT has an expired timeout that is controlled by the OmniVista Cirrus portal to prevent very long token usage. Also authentication with application token is used. The token must be provided in the request HTTP header, using the Authorization header. At server side, token is verified, and if it doesn’t match, 403 Not Allowed response is sent. TLS is used as a transport protocol to support message exchanges between OmniVista Cirrus portal and an 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 From Windows-1252 From UTF-8
space %20 %20
# %23 %23
? %3F %3F
& %26 %26
+ %2B %2B
, %2C %2C
. %2E %2E
: %3A %3A
; %3B %3B
= %3D %3D
$ %24 %24
@ %40 %40
! %21 %21
~ %7E %7E
{ %7B %7B
} %7D %7D
[ %5B %5B
] %5D %5D
( %28 %28
) %29 %29
' %27 %27
" %22 %22
` %60 %60
^ %5E %5E
| %7C %7C
< %3C %3C
> %3E %3E
\ %5C %5C
/ %2F %2F

User

Get user's authentication policy

This API allows to check if user is required to update account security (Two-factor Authenticator or password) .

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get user's profile

This API allows to get user's profile for the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": {
    }
}

Update user's profile

This API allows to 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

Request samples

Content type
application/json
{
  • "firstname": "string",
  • "lastname": "string",
  • "country": "string",
  • "lastLoginDate": "string",
  • "verified": true,
  • "companyName": "string",
  • "closestRegion": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "preferredLanguage": "string",
  • "isTwoFAEnabled": true,
  • "faMethod": "EMAIL",
  • "isSuperAdmin": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully updated.",
  • "data": {
    }
}

Get user's msp level permission

This API allows to get permission for an unique MSP of the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All permissions has been successfully fetched.",
  • "data": [
    ]
}

Get user's organization level permission

This API allows to 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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "All permissions has been successfully fetched.",
  • "data": [
    ]
}

Get user's site level permission

This API allows to 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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "All permissions has been successfully fetched.",
  • "data": [
    ]
}

Device

Create a device

This API allows to register a new device in a given organization, site, building and floor.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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. It is required if device is a Stellar AP in Analytics Only.

ipAddress
string

The IP v4 address of the device. It is required if device is a Stellar AP in Analytics Only.

ipAddressV6
string

The IP v6 address of the device.

macAddress
string

The MAC address of the device. It is required if device is a Stellar AP in Analytics Only.

serialNumber
required
string

The serial number of the device.

type
string

The type of the device. It is required if device is a Stellar AP in Analytics Only.

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
number <float>

The floorElevation of the device.

managementMode
string

The Management mode on OVNG. "FullManagement" for full management by OVNG or "AnalyticsOnly" for only analytics by OVNG

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "ipAddress": "string",
  • "ipAddressV6": "string",
  • "macAddress": "string",
  • "serialNumber": "string",
  • "type": "string",
  • "version": "string",
  • "deviceLocationLldp": true,
  • "physicalLocation": "string",
  • "description": "string",
  • "geoLocation": "string",
  • "systemContact": "string",
  • "location": { },
  • "floorElevation": 0,
  • "managementMode": "string",
  • "groupId": "string",
  • "deviceFamily": "AP",
  • "provisioningTemplate": "string",
  • "valueMappingTemplate": "string",
  • "mgmtUsersTemplate": "string",
  • "saveAndCertify": true,
  • "deviceLabelIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The device has been successfully created.",
  • "data": {
    }
}

Get all devices

This API allows to fetch all devices declared in one site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully fetched.",
  • "data": [
    ]
}

Create a remote AP.

This API is used to create a remote AP.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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

Request samples

Content type
application/json
{
  • "serialNumber": "string",
  • "description": "string",
  • "vpnSettingName": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The device has been successfully created.",
  • "data": {
    }
}

Mass import devices

This API allows to mass import devices (if MAC Address of the device exists then this device is updated otherwise it's created).

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
managementMode
string

The Management mode on OVNG. "FullManagement" for full management by OVNG or "AnalyticsOnly" for only analytics by OVNG

Array of objects

An array of devices to be created.

Responses

Request samples

Content type
application/json
{
  • "managementMode": "string",
  • "devices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The request to import devices has been successfully sent to the server.",
  • "data": [ ]
}

Update multiple devices group

This API allows to update multiple devices group (site, group).

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "siteId": "string",
  • "groupId": "string",
  • "devicesIds": [
    ],
  • "serialNumber": "string",
  • "rfProfile": "string",
  • "deviceCountryCode": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully updated.",
  • "data": {
    }
}

Update multiple devices location

This API allows to update multiple devices location (site, building, floor).

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "buildingId": "string",
  • "floorId": "string",
  • "siteId": "string",
  • "devicesIds": [
    ],
  • "groupId": "string",
  • "rfProfile": "string",
  • "deviceCountryCode": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully updated.",
  • "data": {
    }
}

Upload files for OVAgent

This API allows you to upload files for OVAgent.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "OVAgent configuration file has been successfully uploaded.",
  • "data": [
    ]
}

Upload package zip file for OVAgent

This API allows you to upload package zip file for OVAgent.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "OVAgent package upgrade is in progress.",
  • "data": [
    ]
}

Get all devices from organization

This API allows to fetch all devices from organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully fetched.",
  • "data": [
    ]
}

Get a device

This API allows to fetch one device identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

deviceId
required
string

This is a path param for deviceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully fetched.",
  • "data": {
    }
}

Get all details device

This API allows to fetch all details of device identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

deviceId
required
string

This is a path param for deviceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device has been successfully fetched.",
  • "data": {
    }
}

Update a device

This API allows to update one device identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

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. It is required if device is a Stellar AP in Analytics Only.

ipAddress
string

The IP v4 address of the device. It is required if device is a Stellar AP in Analytics Only.

ipAddressV6
string

The IP v6 address of the device.

macAddress
string

The MAC address of the device. It is required if device is a Stellar AP in Analytics Only.

serialNumber
required
string

The serial number of the device.

type
string

The type of the device. It is required if device is a Stellar AP in Analytics Only.

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
number <float>

The floorElevation of the device.

managementMode
string

The Management mode on OVNG. "FullManagement" for full management by OVNG or "AnalyticsOnly" for only analytics by OVNG

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "ipAddress": "string",
  • "ipAddressV6": "string",
  • "macAddress": "string",
  • "serialNumber": "string",
  • "type": "string",
  • "version": "string",
  • "deviceLocationLldp": true,
  • "physicalLocation": "string",
  • "description": "string",
  • "geoLocation": "string",
  • "systemContact": "string",
  • "location": { },
  • "floorElevation": 0,
  • "managementMode": "string",
  • "groupId": "string",
  • "deviceFamily": "AP",
  • "provisioningTemplate": "string",
  • "valueMappingTemplate": "string",
  • "mgmtUsersTemplate": "string",
  • "saveAndCertify": true,
  • "deviceLabelIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device has been successfully updated.",
  • "data": {
    }
}

Delete a device

This API allows to delete a device identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device has been successfully deleted.",
  • "data": {
    }
}

Update a remote AP.

This API is used to update a remote AP.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

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

Request samples

Content type
application/json
{
  • "serialNumber": "string",
  • "description": "string",
  • "vpnSettingName": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device has been successfully updated.",
  • "data": {
    }
}

Update LED Mode

This API allows to update LED mode for multiple devices

path Parameters
orgId
required
string

This is a path param for orgId

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.

required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "devicesIds": [
    ],
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The request to update ledmode has been successfully sent to the device(s).",
  • "data": [
    ]
}

Ping Device

This API allows to ping one device identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The ping request has been successfully sent to the device.",
  • "data": {
    }
}

Update Radio Configuration

This API allows to update radio configuration on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The request to update radio config has been successfully sent to the device(s).",
  • "data": {
    }
}

Reset Action

This API allows to reset action on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

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

required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "devicesIds": [
    ],
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The reset request has been successfully sent to the device(s).",
  • "data": {
    }
}

Update IOT Radio Config

This API allows to update iot radio config of one device identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device has been successfully updated.",
  • "data": {
    }
}

Save to Running

This API allows to save to running action on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

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

required
object

Responses

Request samples

Content type
application/json
{
  • "devicesIds": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The save to running request has been successfully sent to the device(s).",
  • "data": {
    }
}

Reboot

This API allows to reboot action on the device catalog.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The reboot request has been successfully sent to the device(s).",
  • "data": {
    }
}

Copy Working/Running To Certified

This API allows to Copy Working/Running To Certified action on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "deviceMacAddresses": [
    ],
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The Copy Working/Running to Certified request has been successfully sent to the device(s).",
  • "data": [
    ]
}

Copy Certified To Working/Running

This API allows to Copy Certified To Working/Running action on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "deviceMacAddresses": [
    ],
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The Copy Certified to Working/Running request has been successfully sent to the device(s).",
  • "data": [
    ]
}

Rediscover

This API allows to rediscover the devices on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "deviceMacAddresses": [
    ],
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The Rediscover request has been successfully sent to the device(s).",
  • "data": [
    ]
}

Update IP mode

This API allows to update ip mode of one device identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully updated.",
  • "data": {
    }
}

Update multiple location device

This API allows the update of multiple location devices.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully updated.",
  • "data": [
    ]
}

Get wired ports for each device.

This API allows to get wired ports for each device.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "org",
  • "scopeId": [
    ],
  • "offset": 0,
  • "limit": 0,
  • "filters": {
    },
  • "sort": [
    ],
  • "search": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wired ports have been successfully fetched.",
  • "data": {
    }
}

Update wired ports for each device.

This API allows to update wired ports for each device.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wired ports have been successfully updated.",
  • "data": [
    ]
}

Get multiple devices health thresholds.

This API allows to get multiple health thresholds of devices by their serial number.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The devices' Health thresholds have been successfully fetched.",
  • "data": [
    ]
}

Update multiple devices health thresholds config with the same configuration.

This API allows to update multiple health thresholds config on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The request to update health thresholds has been successfully sent to the device(s).",
  • "data": [
    ]
}

Update multiple devices health thresholds config with the specified configuration.

This API allows to update multiple health thresholds config on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The request to update health thresholds has been successfully sent to the device(s).",
  • "data": [
    ]
}

Update multiple devices qoe&rtls status

This API allows to update multiple qoe&rtls status on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The request to update Location/ Advanced Analytics Server has been successfully sent to the device(s)."
}

Get Qoe&Rtl value in device

This API allows to fetch Qoe&Rtls value following macAddress.

path Parameters
orgId
required
string

This is a path param for orgId

macAddress
required
string

This is a path param for macAddress

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": {
    }
}

Get unsupported scale-up SSID devices

This API allows you to get unsupported scale-up SSID devices from a group.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

groupId
required
string

This is a path param for groupId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully fetched.",
  • "data": [
    ]
}

Update multiple IOT status

This API allows to update multiple IOT status on devices catalog.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully updated.",
  • "data": [
    ]
}

Update device location

This API allows to update a device location

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

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.

required
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
number <float>

The updated floor elevations

Responses

Request samples

Content type
application/json
{
  • "buildingId": "string",
  • "floorId": "string",
  • "siteId": "string",
  • "location": {
    },
  • "floorElevation": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device has been successfully updated.",
  • "data": {
    }
}

Delete device location

This API allows to delete a device location

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The location of the device has been successfully deleted.",
  • "data": {
    }
}

Delete multiple devices

This API allows to delete mutiple devices identified by there ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully deleted.",
  • "data": {
    }
}

Update Mesh Configuration

This API allows to update Mesh Configuration of one device identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully updated.",
  • "data": {
    }
}

Update Mesh Network Configuration

This API allows to update Mesh Configurations of all devices.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "root_mac": "string",
  • "band": "string",
  • "encryptionType": "BothWpaWpa2",
  • "ssid": "string",
  • "passphrase": "string",
  • "repeaters": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}

Status of device OVNG agent for single switch

This API allows to retrieve the status of the device OVNG Agent .

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "serialNumber": "string",
  • "agentType": "ALL"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Agent status received successfully.",
  • "data": {
    }
}

Status of device OVNG agent for multiple switches

This API allows to retrieve the status of the device OVNG Agent for multiple switches.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Agent status received successfully.",
  • "data": [
    ]
}

Restart of device OVNG agent for single switch

This API allows to retrieve the status of the device OVNG Agent .

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "serialNumber": "string",
  • "agentType": "ALL"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Agent restarted successfully",
  • "data": {
    }
}

Restart of device OVNG agent for multiple switches

This API allows to retrieve the status of the device OVNG Agent.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Agent restart in progress",
  • "data": [
    ]
}

Get Device counter based on stats

This API is used to count all devices based on field changes

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully fetched.",
  • "data": {
    }
}

Get all of devices with naas licenses from organization.

This API allows to get all of devices with naas licenses from organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully fetched.",
  • "data": [
    ]
}

Get all of devices with naas licenses from site.

This API allows to get all of devices with naas licenses from site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices have been successfully fetched.",
  • "data": [
    ]
}

Mass import remote aps

This API allows to mass import remote aps (if remote ap exists then this device is updated otherwise it's created).

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Devices have been successfully created.",
  • "data": {
    }
}

Topology

Get Topology configuration

This API is used to get all the topology configuration for a given site identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Topology l2 link have been successfully fetched.",
  • "data": {
    }
}

Discoverymanagerentries

Get the Discovery Manager Entry(s)

This API allows to Get the Discovery Manager Entry(s) of devices.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Discovery manager entries have been successfully fetched.",
  • "data": [
    ]
}

Edit the Discovery Manager Entry

This API allows to Edit the Discovery Manager Entry on device catalog.

path Parameters
orgId
required
string

This is a path param for orgId

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 Updating Discovery Manager Entry.

meta
object

The JSON metadata of the Updating Discovery Manager Entry.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Discovery manager entries have been successfully updated.",
  • "data": [
    ]
}

Networkconfig

Reset Mesh Configuration

This API allows to Reset Mesh Configuration of individual AP.

path Parameters
orgId
required
string

This is a path param for orgId

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.

Responses

Request samples

Content type
application/json
{
  • "macAddress": "string",
  • "isRoot": true
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "data": {
    }
}

Reset Mesh Network Configuration

This API allows to Reset Mesh Network Configuration.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "root_mac": "string",
  • "repeaters": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "data": {
    }
}

Add a client to the blocklist.

This API is used to add a client to the blocklist.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "clientMac": [
    ],
  • "agingTime": 0,
  • "reason": "string",
  • "scope": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The client has been successfully added to the blocklist.",
  • "data": [
    ]
}

Get clients in the blocklist

This API allows to fetch all clients in the blocklist of a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The clients in the blocklist have been successfully fetched.",
  • "data": [
    ]
}

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

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The clients blocklisted have been successfully deleted.",
  • "data": {
    }
}

Get a client in the blocklist

This API allows to fetch one client in the blocklist identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

clientBlocklistId
required
string

This is a path param for clientBlocklistId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The client blocklisted has been successfully fetched.",
  • "data": {
    }
}

Update a client in the blocklist

This API allows to update one client in the blocklist identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

clientBlocklistId
required
string

This is a path param for clientBlocklistId

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

Request samples

Content type
application/json
{
  • "agingTime": 0,
  • "reason": "string",
  • "scope": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The client blocklisted has been successfully updated.",
  • "data": {
    }
}

Create an event configuration

This API allows to create an event configuration.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "orgId": "string",
  • "sites": [
    ],
  • "apGroups": [
    ],
  • "devices": [
    ],
  • "deviceType": "string",
  • "protocol": "SNMPv2",
  • "trapSubscriptionState": true,
  • "eventIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get all event configurations

This API allows to get all event configurations.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete multiple event configurations

This API allows to delete multiple event configurations identified by its ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update an event configuration

This API allows to update an event configuration within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

configurationId
required
string

This is a path param for configurationId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "orgId": "string",
  • "sites": [
    ],
  • "apGroups": [
    ],
  • "devices": [
    ],
  • "deviceType": "string",
  • "protocol": "SNMPv2",
  • "trapSubscriptionState": true,
  • "eventIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete event configuration by id

This API allows to delete event configuration identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

configurationId
required
string

This is a path param for configurationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete all event configurations

This API allows to delete all event configurations.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get mesh topology

This API allows to get the mesh topology of Access Points.

path Parameters
orgId
required
string

This is a path param for orgId

macAddress
required
string

This is a path param for macAddress

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Debugfileserver

Get all user files

This API allows to fetch all user files of given organization id.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device files have been successfully fetched.",
  • "data": [
    ]
}

Delete user files

This API allows to delete user files of given organization id.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "downloadDirectory": "string",
  • "fileName": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device files have been successfully deleted.",
  • "data": [
    ]
}

Move user file

This API allows to move user file of given organization id.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "subDirectory": "string",
  • "fileName": "string",
  • "destination": "string",
  • "forceToOverride": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The device file has been successfully updated.",
  • "data": {
    }
}

Devicemodule

Get all Device Modules

This API allows you to get all Device Modules by MAC addresses for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "offset": 0,
  • "limit": 0,
  • "filters": {
    },
  • "sort": [
    ],
  • "search": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Device Modules have been successfully fetched.",
  • "data": {
    }
}

Ipinterface

Get all IP addresses of IP Interfaces

This API allows you to get all IP addresses of IP Interfaces by the MAC address for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "data": "string",
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The IP interfaces have been successfully fetched.",
  • "data": [
    ]
}

Eventlog

Get all Activation Logs

This API allows you to get all Activation Logs by the device serial number for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Activation logs have been successfully fetched.",
  • "data": [
    ]
}

Devicelabel

Create a Device Label

This API allows you to create a new Device Label within a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Device Label has been successfully created.",
  • "data": {
    }
}

Get all Device Labels

This API allows you to get all Device Labels within a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Device Labels have been successfully fetched.",
  • "data": [
    ]
}

Delete a Device Label

This API allows you to delete a Device Label by ID within a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

deviceLabelId
required
string

This is a path param for deviceLabelId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Device Label has been successfully deleted.",
  • "data": {
    }
}

Update a Device Label

This API allows you to update a Device Label by ID within a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

deviceLabelId
required
string

This is a path param for deviceLabelId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Device Label has been successfully updated.",
  • "data": {
    }
}

Attach Device Labels

This API allows you to attach Device Labels to devices within a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "deviceIds": [
    ],
  • "deviceLabelIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Device Labels have been successfully attached.",
  • "data": [
    ]
}

Detach Device Labels

This API allows you to detach Device Labels from devices within a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "deviceIds": [
    ],
  • "deviceLabelIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Device Labels have been successfully detached.",
  • "data": [
    ]
}

Update the Device Label attachment

This API allows you to update the Device Label attachment for the device within a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

deviceId
required
string

This is a path param for deviceId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Device Label attachment has been successfully updated.",
  • "data": {
    }
}

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

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "pa$$word",
  • "appId": "string",
  • "appSecret": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Y2QwNjEzYTJjNDQyMTViYmI2ZTY2MjYiLCJpYXQiOjE1NTc3NjE5NjIsImV4cCI6MTU1OTA1Nzk2Mn0.PBIINTeq7Yqs5i2jdlHhwHBqqLLJmHPC7tmERQcR3Xo",
  • "expires_in": 1296000,
  • "token_type": "Bearer"
}

Create an application

This API allows to 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

Request samples

Content type
application/json
{
  • "name": "string",
  • "target": "WEB_APPLICATION",
  • "description": "string",
  • "isInProduction": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The application has been successfully created.",
  • "data": {
    }
}

Get user applications

This API allows to fetch all applications created by the authenticated user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The applications have been successfully fetched.",
  • "data": [
    ]
}

Delete user applications

This API allows to 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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully deleted.",
  • "data": {
    }
}

Get a user application

This API allows to fetch one application identified by its id.

path Parameters
applicationId
required
string

This is a path param for applicationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully fetched.",
  • "data": {
    }
}

Update a user application

This API allows to update one application identified by its id.

path Parameters
applicationId
required
string

This is a path param for applicationId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "target": "WEB_APPLICATION",
  • "description": "string",
  • "isInProduction": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully updated.",
  • "data": {
    }
}

Delete a user application

This API allows to delete a user application identified by its id.

path Parameters
applicationId
required
string

This is a path param for applicationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully deleted.",
  • "data": {
    }
}

Update application state

This API update the application state identified by its id.

path Parameters
applicationId
required
string

This is a path param for applicationId

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

Request samples

Content type
application/json
{
  • "isInProduction": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully updated.",
  • "data": {
    }
}

Msp

Get user's MSP

This API allows to get retrieve the unique managed service provider (MSP) data for a given user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The MSPs have been successfully fetched.",
  • "data": [
    ]
}

Get a MSP

This API allows to get an existing managed service provider (MSP) identified by its mspId

path Parameters
mspId
required
string

This is a path param for mspId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The MSP has been successfully fetched.",
  • "data": {
    }
}

Update a MSP

This API allows to update an existing managed service provider (MSP)

path Parameters
mspId
required
string

This is a path param for mspId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "enforceStrongPassword": true,
  • "enforceStrongPasswordNotifyType": "SHOW_MESSAGE_AFTER_LOGIN"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The MSP has been successfully updated.",
  • "data": {
    }
}

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

This API allows to fetch all users inside a MSP, as well as Organization level user and their Two-factor Authentication status

path Parameters
mspId
required
string

This is a path param for mspId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All users have been successfully fetched.",
  • "data": [
    ]
}

Update the requirement of 2FA Configuration of user inside MSP

This API allows to set the obligation of Two-factor authentication for a group of users inside a MSP

path Parameters
mspId
required
string

This is a path param for mspId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user authenticator has been successfully updated.",
  • "data": [
    ]
}

Get a verified user of a MSP

This API allows to find a verified user of the managed service provider (MSP) by its ID

path Parameters
mspId
required
string

This is a path param for mspId

userId
required
string

This is a path param for userId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user profile has been successfully fetched.",
  • "data": {
    }
}

Update the user's role in MSP

This API allows to update the Msp level access role of a verified user in a MSP.

path Parameters
mspId
required
string

This is a path param for mspId

userId
required
string

This is a path param for userId

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

Request samples

Content type
application/json
{
  • "role": "MSP_ADMIN",
  • "userOrgPermissions": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user role has been successfully updated.",
  • "data": {
    }
}

Revoke user access to a MSP

This API allows to remove access of a user to a managed service provider and all its organizations and sites. (MSP)

path Parameters
mspId
required
string

This is a path param for mspId

userId
required
string

This is a path param for userId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user role has been successfully revoked.",
  • "data": {
    }
}

Get all users in msp level

This API allows to get all verified users of a managed service provider (MSP) identified by mspId parameter

path Parameters
mspId
required
string

This is a path param for mspId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All users have been successfully fetched.",
  • "data": [
    ]
}

Revoke access of multiple users to a MSP

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

path Parameters
mspId
required
string

This is a path param for mspId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The users access has been successfully revoked.",
  • "data": {
    }
}

Invitee

Invite User to a MSP

This API allows to create an invitation for a user to join a managed service provider (MSP) with specific role

path Parameters
mspId
required
string

This is a path param for mspId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The invitation has been successfully sent.",
  • "data": [
    ]
}

Get all pending invitations of a MSP

This API allows to get all pending invitations of the identified managed service provider (MSP) identified by mspId parameter

path Parameters
mspId
required
string

This is a path param for mspId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All invitations have been successfully fetched.",
  • "data": [
    ]
}

Resend multiple invitation emails of a MSP

This API allows to resend invitation email to many users in a MSP

path Parameters
mspId
required
string

This is a path param for mspId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All invitations have been successfully sent.",
  • "data": {
    }
}

Delete multiple invitation of a MSP

This API allows to delete multiple invitation in a MSP

path Parameters
mspId
required
string

This is a path param for mspId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The invitations have been successfully deleted.",
  • "data": {
    }
}

Get a pending invitation of a MSP

This API allows to find a pending invitation of the managed service provider (MSP) by its ID

path Parameters
mspId
required
string

This is a path param for mspId

inviteeId
required
string

This is a path param for inviteeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "An invitation has been successfully fetched.",
  • "data": {
    }
}

Update an invitation of a MSP

This API allows to update an invitation and resend invitation in a MSP. For resending without update: set the body an empty JSON

path Parameters
mspId
required
string

This is a path param for mspId

inviteeId
required
string

This is a path param for inviteeId

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

Request samples

Content type
application/json
{
  • "message": "string",
  • "role": "MSP_ADMIN",
  • "limitedOrganizations": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The invitation has been successfully updated.",
  • "data": {
    }
}

Delete an invitation

This API allows to delete an existing invitation identified by inviteeId in managed service provider. (MSP)

path Parameters
mspId
required
string

This is a path param for mspId

inviteeId
required
string

This is a path param for inviteeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Invitation has been successfully deleted.",
  • "data": [
    ]
}

Accept an invitation to a Msp

This API allows to accept an invitation to a MSP for a user who has already signed up and who should not be attached to any entity

path Parameters
inviteeId
required
string

This is a path param for inviteeId

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Invitation(s) have been successfully accepted and removed.",
  • "data": {
    }
}

Resend multiple invitation emails of an Organization

This API allows to resend invitation email to many users in an organization

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All invitations have been successfully sent.",
  • "data": {
    }
}

Invite User to an Organization

This API allows to create an invitation for a user to join an organization with specific role

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The invitation has been successfully sent.",
  • "data": [
    ]
}

Get all pending invitations of an Organization

This API allows to get all pending invitations of the identified organization by orgId parameter

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All invitations have been successfully fetched.",
  • "data": [
    ]
}

Delete multiple invitation of an Organization

This API allows to delete multiple invitation in an Organization

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The invitations have been successfully deleted.",
  • "data": {
    }
}

Get a pending invitation of an Organization

This API allows to find a pending invitation of the organization by its ID

path Parameters
orgId
required
string

This is a path param for orgId

inviteeId
required
string

This is a path param for inviteeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "An invitation has been successfully fetched.",
  • "data": {
    }
}

Update an invitation of an Organization

This API allows to update an invitation and resend invitation in an Organization. For resending without update: set the body an empty JSON

path Parameters
orgId
required
string

This is a path param for orgId

inviteeId
required
string

This is a path param for inviteeId

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

Request samples

Content type
application/json
{
  • "message": "string",
  • "role": "ORGANIZATION_ADMIN",
  • "userSitePermissions": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The invitation has been successfully updated.",
  • "data": {
    }
}

Delete an invitation of an Organization

This API allows to delete an existing invitation identified by inviteeId in an Organization

path Parameters
orgId
required
string

This is a path param for orgId

inviteeId
required
string

This is a path param for inviteeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Invitation has been successfully deleted.",
  • "data": [
    ]
}

Accept an invitation to an Organization

This API allows to accept an invitation to an organization for an exist user, who has already signed up.

path Parameters
inviteeId
required
string

This is a path param for inviteeId

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Invitation(s) have been successfully accepted and removed.",
  • "data": {
    }
}

Organization

Create an organization

This API allows you to 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
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" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

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.

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "imageUrl": "string",
  • "mspId": "string",
  • "countryCode": "string",
  • "timezone": "Africa/Abidjan",
  • "idleTimeout": 0,
  • "auditHour": 0,
  • "enforceStrongPassword": true,
  • "enforceStrongPasswordNotifyType": "SHOW_MESSAGE_AFTER_LOGIN"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The organization has been successfully created.",
  • "data": {
    }
}

Get all user organizations

This API allows to fetch all user organizations.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The organizations have been successfully fetched.",
  • "data": [
    ]
}

Get all organizations of MSP

This API allows to fetch all organizations of specific MSP.

path Parameters
mspId
required
string

This is a path param for mspId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The organizations have been successfully fetched.",
  • "data": [
    ]
}

Get all organizations of MSP Summary

This API allows to fetch all organizations summaries of a specific MSP .

path Parameters
mspId
required
string

This is a path param for mspId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The organizations have been successfully fetched.",
  • "data": [
    ]
}

Get an organization with settings

This API allows to fetch one organization identified by its id with its settings.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The organization has been successfully fetched.",
  • "data": {
    }
}

Get an organization

This API allows to fetch one organization identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The organization has been successfully fetched.",
  • "data": {
    }
}

Update an organization

This API allows to update one organization identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

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" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "imageUrl": "string",
  • "mspId": "string",
  • "countryCode": "string",
  • "timezone": "Africa/Abidjan",
  • "idleTimeout": 0,
  • "auditHour": 0,
  • "upamAuthRecords": 0,
  • "events": 0,
  • "alerts": 0,
  • "wifiRtls": 0,
  • "networkAnalytics": 0,
  • "clientSessions": 0,
  • "clientAnalytics": 0,
  • "auditLogs": 0,
  • "loginAttemps": 0,
  • "iotData": 0,
  • "collectInfo": 0,
  • "backupPerDevice": 0,
  • "configurationBackup": 0,
  • "qoe": 0,
  • "enforceStrongPassword": true,
  • "enforceStrongPasswordNotifyType": "SHOW_MESSAGE_AFTER_LOGIN"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The organization has been successfully updated.",
  • "data": {
    }
}

Delete an organization

This API allows to delete an organization identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The organization has been successfully deleted.",
  • "data": {
    }
}

Get the enforcement password setting of an Organization

This API allows to get the enforcement password setting of an Organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": {
    }
}

Update the enforcement password setting of an Organization

This API allows to update enforcement password setting of an Organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "enforceStrongPassword": true,
  • "enforceStrongPasswordNotifyType": "SHOW_MESSAGE_AFTER_LOGIN"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The organization has been successfully updated.",
  • "data": {
    }
}

Get a verified user of an Organization

This API allows to find a verified user of the organization by its id.

path Parameters
orgId
required
string

This is a path param for orgId

userId
required
string

This is a path param for userId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user profile has been successfully fetched.",
  • "data": {
    }
}

Update the user's role in Organization

This API allows to update the organization level access role of a verified user in an organization.

path Parameters
orgId
required
string

This is a path param for orgId

userId
required
string

This is a path param for userId

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

Request samples

Content type
application/json
{
  • "role": "ORGANIZATION_ADMIN",
  • "userSitePermissions": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user role has been successfully updated.",
  • "data": {
    }
}

Revoke access user to an organization

This API allows to remove access of a user to an organization and all its sites.

path Parameters
orgId
required
string

This is a path param for orgId

userId
required
string

This is a path param for userId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user access has been successfully revoked.",
  • "data": {
    }
}

Get Two-factor Authentication status of users

This API allows to fetch the Two-factor authentication configuration of the organization-level users in this organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Update the Two-factor Authentication in Organization

This API allows to impose or not the Two-factor Authentication for organization-level users in this Organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "is2FARequired": true
}

Response samples

Content type
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get all users in organization level

This API allows to get all verified users of an organization identified by orgId parameter.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All users have been successfully fetched.",
  • "data": [
    ]
}

Revoke access of multiple users to an Organization

This API allows to remove access of many users by Id to an Organization and all its sites.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The users access has been successfully revoked.",
  • "data": {
    }
}

Site

Create a site

This API allows to create a new site in an organization.

path Parameters
orgId
required
string

This is a path param for orgId

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" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "timezone": "Africa/Abidjan",
  • "zoom": 0,
  • "address": "string",
  • "countryCode": "string",
  • "isDefault": true,
  • "location": {
    },
  • "imageUrl": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The site has been successfully created.",
  • "data": {
    }
}

Get organization sites

This API allows to fetch all sites of a given organization by its id.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The sites have been successfully fetched.",
  • "data": [
    ]
}

Get organization sites, buildings and floors

This API allows to fetch all sites (including their their buildings and floors) of a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The sites have been successfully fetched.",
  • "data": [
    ]
}

Get a site

This API allows to fetch one site identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site has been successfully fetched.",
  • "data": {
    }
}

Update a site

This API allows to update one site identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "timezone": "Africa/Abidjan",
  • "address": "string",
  • "zoom": 0,
  • "countryCode": "string",
  • "isDefault": true,
  • "location": {
    },
  • "imageUrl": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site has been successfully updated.",
  • "data": {
    }
}

Delete a site

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

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site has been successfully deleted.",
  • "data": {
    }
}

Smsprovider

Get SMS Provider Settings

This API allows to fetch the SMS Provider settings for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The SMS Gateway Settings have been successfully fetched.",
  • "data": {
    }
}

Update SMS Provider Settings

This API allows to update the SMS Provider settings for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "smsProvider": "PLIVO",
  • "twilio_accountSid": "string",
  • "twilio_authToken": "string",
  • "twilio_numberFrom": "string",
  • "plivo_authId": "string",
  • "plivo_authToken": "string",
  • "plivo_numberFrom": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The SMS Gateway Settings have been successfully updated.",
  • "data": {
    }
}

Send SMS for test

This API allows you to send an SMS for testing SMS Provider Settings.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "smsProvider": "PLIVO",
  • "twilio_accountSid": "string",
  • "twilio_authToken": "string",
  • "twilio_numberFrom": "string",
  • "plivo_authId": "string",
  • "plivo_authToken": "string",
  • "plivo_numberFrom": "string",
  • "to": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The test SMS has been successfully sent.",
  • "data": {
    }
}

Group

Create a group

This API allows to create a new group in an site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "provisioningTemplateName": "string",
  • "isExtendScale": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The group has been successfully created.",
  • "data": {
    }
}

Get all Group(s) belong to site

This API allows to fetch all groups of a given site by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The groups have been successfully fetched.",
  • "data": [
    ]
}

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)

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "groupForDeviceMigration": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The groups has been successfully deleted.",
  • "data": [
    ]
}

Get all Group(s) belong to organization

This API allows to fetch all groups of a given organization by its id.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The groups have been successfully fetched.",
  • "data": [
    ]
}

Get Group by Id belong to site

This API allows to fetch group by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

groupId
required
string

This is a path param for groupId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The group has been successfully fetched.",
  • "data": {
    }
}

Update a group

This API allows to update one group identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

groupId
required
string

This is a path param for groupId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "provisioningTemplateName": "string",
  • "isExtendScale": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The group has been successfully updated.",
  • "data": {
    }
}

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)

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

groupId
required
string

This is a path param for groupId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The group has been successfully deleted.",
  • "data": {
    }
}

Alert

Get alert summary

This API allows to fetch all alert of given organization id.

path Parameters
orgId
required
string

This is a path param for orgId

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
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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert have been successfully fetched.",
  • "data": {
    }
}

Delete summary alerts

This API allows to delete summary alerts.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "string",
  • "scopeId": [
    ],
  • "limit": "string",
  • "offset": "string",
  • "search": "string",
  • "filters": {
    },
  • "summary": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Alerts in the Alert Summary have been successfully deleted.",
  • "data": {
    }
}

Get alert details

This API allows to get all alert details.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert have been successfully fetched.",
  • "data": [
    ]
}

Acknowledge all alerts

This API allows to acknowledge all alerts within an organization

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "scope": "string",
  • "scopeId": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alerts have been successfully acknowledged.",
  • "data": {
    }
}

Acknowledge summary alerts

This API allows to acknowledge summary alerts within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "string",
  • "scopeId": [
    ],
  • "limit": "string",
  • "offset": "string",
  • "search": "string",
  • "filters": {
    },
  • "summary": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Alerts in the Alert Summary have been successfully acknowledged.",
  • "data": {
    }
}

Acknowledge multiple alerts

This API allows to acknowledge multiple alerts by their ids within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alerts have been successfully acknowledged.",
  • "data": {
    }
}

Acknowledge an alert by id

This API allows to acknowledge an alert by id within an organization

path Parameters
orgId
required
string

This is a path param for orgId

alertId
required
string

This is a path param for alertId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert has been successfully acknowledged.",
  • "data": {
    }
}

Delete an alert by id

This API allows to delete an alert identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

alertId
required
string

This is a path param for alertId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert has been successfully deleted.",
  • "data": {
    }
}

Delete all alerts

This API allows to delete all alerts within an organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "scope": "string",
  • "scopeId": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alerts have been successfully deleted.",
  • "data": {
    }
}

Delete multiple alerts

This API allows to delete multiple alerts identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alerts have been successfully deleted.",
  • "data": {
    }
}

Get all alert definitions

This API allows to get all alert definitions.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert definitions have been successfully fetched.",
  • "data": [
    ]
}

Update multiple alert definitions

This API allows to update multiple alert definitions.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert definitions have been successfully updated.",
  • "data": [
    ]
}

Update an alert definition

This API allows to update an alert definition.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert definition has been successfully updated.",
  • "data": {
    }
}

Reset alert definitions

This API allows to reset alert definitions.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert definitions have been successfully reseted.",
  • "data": [
    ]
}

Reset all alert definitions

This API allows to reset all alert definitions.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert definitions have been successfully reseted.",
  • "data": {
    }
}

Get alerts by client.

This API is used to get the related alerts to a specific client identified by providing the client mac address

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event details have been successfully fetched",
  • "data": {
    }
}

Alerttype

Get all alert types

This API allows to get all alert types.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert types have been successfully fetched.",
  • "data": [
    ]
}

Alerttemplate

Create an alert template

This API allows to create a new alert template.

path Parameters
orgId
required
string

This is a path param for orgId

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.

required
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

Request samples

Content type
application/json
{
  • "name": "string",
  • "organization": "string",
  • "alertTypes": [
    ],
  • "siteScope": [
    ],
  • "scope": 0
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The alert template has been successfully created.",
  • "data": {
    }
}

Get all alert templates

This API allows to get all alert templates.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert templates have been successfully fetched.",
  • "data": {
    }
}

Delete multiple alert templates

This API allows to delete mutiple alert templates identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert templates have been successfully deleted.",
  • "data": {
    }
}

Update an alert template

This API allows to update an alert template within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

alertTemplateId
required
string

This is a path param for alertTemplateId

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.

required
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

Request samples

Content type
application/json
{
  • "name": "string",
  • "organization": "string",
  • "alertTypes": [
    ],
  • "siteScope": [
    ],
  • "scope": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert template has been successfully updated.",
  • "data": {
    }
}

Delete an alert template

This API allows to delete an alert template identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

alerttemplateId
required
string

This is a path param for alerttemplateId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alert template has been successfully deleted.",
  • "data": {
    }
}

Iot

Create a Category

This API allows to create a new Category. Either macMapping(Mac based Category) or hierarchyMapping(Hierarchy based category) is mandatory.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "path": "string",
  • "description": "string",
  • "hierarchyMapping": [
    ],
  • "macMapping": [
    ],
  • "accessRoleProfile": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The category has been successfully created",
  • "data": [
    ]
}

Get all categories

This API allows to get all categories.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The categories have been successfully fetched.",
  • "data": [
    ]
}

Delete multiple Categories

This API allows to delete mutiple categories identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The categories have been successfully deleted.",
  • "data": {
    }
}

Get all device hierarchies

This API allows to get all device hierarchies. Only those category hierarchies that have been detected and displayed on the Inventory Screen are fetched

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The hierarchy categories have been successfully fetched.",
  • "data": [
    ]
}

Update a Category

This API allows to update a new Category. Either macMapping(Mac based Category) or hierarchyMapping(Hierarchy based category) is mandatory.

path Parameters
orgId
required
string

This is a path param for orgId

categoryId
required
string

This is a path param for categoryId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "path": "string",
  • "description": "string",
  • "hierarchyMapping": [
    ],
  • "macMapping": [
    ],
  • "accessRoleProfile": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The category has been successfully updated",
  • "data": [
    ]
}

Delete a category

This API allows to delete a category identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

categoryId
required
string

This is a path param for categoryId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The category has been successfully deleted.",
  • "data": {
    }
}

Get Automatic Enforcement

This API allows to get automatic enforcement status.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Exception lists have been successfully fetched.",
  • "data": [
    ]
}

Update Automatic Enforcement

This API allows to update automatic enforcement status.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "parameter": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autoenforcement status has been successfully updated."
}

Update Manual Enforcement

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

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "categoryName": [
    ],
  • "action": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autoenforcement status has been successfully updated",
  • "data": {
    }
}

Get Exception List

This API allows to get exception list.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Exception lists have been successfully fetched.",
  • "data": {
    }
}

Update an Exception List

This API allows to 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.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "apGroups": [
    ],
  • "sites": [
    ],
  • "ssid": [
    ],
  • "endpointMac": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Exception lists has been successfully updated.",
  • "data": {
    }
}

Update an Access Role Profile

This API allows to update access role profile.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The access role profile has been successfully updated.",
  • "data": {
    }
}

Get all Inventories

This API allows to get all inventories.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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.

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The inventories have been successfully fetched.",
  • "data": {
    }
}

Assign category to device

This API allows to assign custom category to devices by their mac ids within an organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "macs": [
    ],
  • "categoryName": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The inventories have been successfully updated.",
  • "data": {
    }
}

Vlanmanager

Get all VLANs

This API allows you to get all VLANs

path Parameters
orgId
required
string

This is a path param for orgId

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
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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLANs have been successfully fetched.",
  • "data": {
    }
}

Delete VLAN by ID.

This API allows to delete VLAN by ID

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN has been successfully deleted.",
  • "data": {
    }
}

Create VLAN

This API allows to create VLAN(s).

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The VLAN has been successfully created.",
  • "data": [
    ]
}

Get VLAN device details by VLAN ID

This API allows to VLAN device details by VLAN ID.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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
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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN details have been successfully fetched.",
  • "data": [
    ]
}

Delete devices from VLAN by device mac.

This API allows to delete devices from VLAN by device mac

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN have been successfully deleted",
  • "data": {
    }
}

Get VLAN port details by VLAN ID

This API allows to VLAN port details by VLAN ID.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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
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 any

"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 any

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

serials[]
Array of any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN details have been successfully fetched.",
  • "data": {
    }
}

Get VLAN link aggregate details by VLAN ID

This API allows to VLAN link aggregate details by VLAN ID.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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
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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN details have been successfully fetched.",
  • "data": [
    ]
}

Enable/disable VLAN admin status by VLAN ID

This API allows to enable/ disable VLAN admin status by VLAN ID

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "vlanId": "string",
  • "adminStatus": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN has been successfully enabled.",
  • "data": {
    }
}

Enable/ disable VLAN admin status by VLAN IDs

This API allows to Enable/ disable VLAN admin status by VLAN IDs

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "vlanIds": [
    ],
  • "adminStatus": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN has been successfully enabled.",
  • "data": {
    }
}

Enable/disable VLAN admin status by device MAC

This API allows to enable/ disable VLAN admin status by device MAC

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "vlanId": "string",
  • "adminStatus": true,
  • "deviceMac": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN admin status for selected device has been successfully disabled.",
  • "data": {
    }
}

Enable/ disable VLAN admin status by device MACs

This API allows to Enable/ disable VLAN admin status by device MACs

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "vlanId": "string",
  • "adminStatus": true,
  • "deviceMacs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN admin status for selected devices have been successfully disabled.",
  • "data": {
    }
}

Delete VLANs by IDs.

This API allows to delete VLANs by IDs

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLANs have been successfully deleted",
  • "data": {
    }
}

Delete device from VLAN by device mac.

This API allows to delete VLAN by ID

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VLAN has been successfully deleted",
  • "data": {
    }
}

Edit VLAN

This API allows to edit VLAN.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "vlanId": "string",
  • "add": {
    },
  • "remove": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Successfully edited specific VLAN info globally based on given request.",
  • "data": {
    }
}

Get VLAN device and port details by VLAN ID

This API allows to get VLAN device and port details by VLAN ID.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Retrieved detailed VLAN info of specific VLAN for given organization.",
  • "data": {
    }
}

Get VLAN available ports details in device by VLAN ID

This API allows to get VLAN available ports details in device by VLAN ID.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Retrieved VLAN IDs and port info for given organization.",
  • "data": {
    }
}

Get STP Summary By VLAN ID

This API allows you to get summary details of spanning tree protocol.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The spanning trees have been successfully fetched.",
  • "data": {
    }
}

Get STP Bridge By VLAN ID

This API allows to get STP bridge details by VLAN ID.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The spanning tree bridges have been successfully fetched.",
  • "data": {
    }
}

Get STP Ports By VLAN ID

This API allows to get STP ports details by VLAN ID.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The spanning tree ports have been successfully fetched.",
  • "data": {
    }
}

Update STP Port By VLAN ID

This API allows to update STP Port by VLAN ID within an organization

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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

Request samples

Content type
application/json
{
  • "deviceMac": "string",
  • "portNumber": "string",
  • "adminStatus": "string",
  • "adminConnection": "string",
  • "priority": "string",
  • "pathCost": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The spanning tree port has been successfully updated.",
  • "data": {
    }
}

Update STP Bridge By VLAN ID

This API allows to update STP Bridge by VLAN ID within an organization

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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

Request samples

Content type
application/json
{
  • "deviceMac": "string",
  • "protocol": "string",
  • "priority": "string",
  • "bridgeMaxAge": "string",
  • "bridgeHelloTime": "string",
  • "bridgeForwardDelay": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The spanning tree bridge has been successfully updated.",
  • "data": {
    }
}

Get IP interfaces

This API allows to fetch all IP interfaces of given organization id.

path Parameters
orgId
required
string

This is a path param for orgId

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
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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "IP Interfaces have been successfully fetched.",
  • "data": {
    }
}

Create an IP interface

This API allows to create an IP interface.

path Parameters
orgId
required
string

This is a path param for orgId

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
Value: 1500

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

Request samples

Content type
application/json
{
  • "ipInterfaceAddress": "string",
  • "ipInterfaceAdminState": "Enabled",
  • "ipInterfaceDeviceType": "string",
  • "ipInterfaceEncap": "string",
  • "ipInterfaceIpForward": "Disabled",
  • "ipInterfaceLocalProxyArp": "Disabled",
  • "ipInterfaceMask": "string",
  • "ipInterfaceMtu": 1500,
  • "ipInterfaceName": "string",
  • "ipInterfacePrimCfg": "True",
  • "ipInterfaceTunnelDstAddressType": "string",
  • "ipInterfaceTunnelDst": "string",
  • "ipInterfaceTunnelSrcAddressType": "string",
  • "ipInterfaceTunnelSrc": "string",
  • "ipInterfaceVlanID": "string",
  • "ipv6InterfaceAddressPrefixLength": "string",
  • "ipv6InterfaceTunnelId": "string",
  • "macAddress": [
    ],
  • "vrfId": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The IP interface has been successfully created.",
  • "data": {
    }
}

Get an IP Interface

This API allows to get an IP interface within an organization

path Parameters
orgId
required
string

This is a path param for orgId

ipInterfaceId
required
string

This is a path param for ipInterfaceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Retrieved the specific IP interface for the given organization.",
  • "data": {
    }
}

Update an IP Interface

This API allows to update an IP interface within an organization

path Parameters
orgId
required
string

This is a path param for orgId

ipInterfaceId
required
string

This is a path param for ipInterfaceId

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
Value: 1500

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

Request samples

Content type
application/json
{
  • "ipInterfaceAddress": "string",
  • "ipInterfaceAdminState": "Enabled",
  • "ipInterfaceDeviceType": "string",
  • "ipInterfaceEncap": "string",
  • "ipInterfaceIpForward": "Disabled",
  • "ipInterfaceLocalProxyArp": "Disabled",
  • "ipInterfaceMask": "string",
  • "ipInterfaceMtu": 1500,
  • "ipInterfaceName": "string",
  • "ipInterfacePrimCfg": "True",
  • "ipInterfaceTunnelDstAddressType": "string",
  • "ipInterfaceTunnelDst": "string",
  • "ipInterfaceTunnelSrcAddressType": "string",
  • "ipInterfaceTunnelSrc": "string",
  • "ipInterfaceVlanID": "string",
  • "ipv6InterfaceAddressPrefixLength": "string",
  • "ipv6InterfaceTunnelId": "string",
  • "macAddress": [
    ],
  • "vrfId": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The IP interface has been successfully updated.",
  • "data": {
    }
}

Delete IP interface by id

This API allows to delete IP interface identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

ipInterfaceId
required
string

This is a path param for ipInterfaceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The IP interface has been successfully deleted.",
  • "data": {
    }
}

Delete multiple IP interfaces

This API allows to delete multiple IP interfaces identified by its ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The IP interfaces have been successfully deleted.",
  • "data": {
    }
}

Get the VLAN's Ip Router

This API is used to get the ip routers information of given vlan id.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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
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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The IP routers have been successfully fetched.",
  • "data": {
    }
}

Create a new IP Router

This API is used to create a new IP Router.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

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

Request samples

Content type
application/json
{
  • "routerIpAddress": "string",
  • "routerIpMask": "string",
  • "ipv6AddressPrefixLength": "string",
  • "ipEncapsulation": "string",
  • "ipForwarding": "string",
  • "interfaceName": "string",
  • "vrfId": "string",
  • "macAddress": [
    ],
  • "vlanID": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The IP router has been successfully created.",
  • "data": {
    }
}

Edit a IP Router

This API allows to edit a exisiting IP router.

path Parameters
orgId
required
string

This is a path param for orgId

vlanId
required
string

This is a path param for vlanId

interfaceId
required
string

This is a path param for interfaceId

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

Request samples

Content type
application/json
{
  • "routerIpAddress": "string",
  • "routerIpMask": "string",
  • "ipv6AddressPrefixLength": "string",
  • "ipEncapsulation": "string",
  • "ipForwarding": "string",
  • "interfaceName": "string",
  • "vrfId": "string",
  • "macAddress": [
    ],
  • "vlanID": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The IP router has been successfully updated.",
  • "data": {
    }
}

Delete a IP Router by id

This API allows to delete ip router identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

interfaceId
required
string

This is a path param for interfaceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The IP router has been successfully deleted.",
  • "data": {
    }
}

Delete multiple ip Routers

This API allows to delete multiple ip routers identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The IP routers has been successfully deleted.",
  • "data": {
    }
}

Networkevents

Get QoE event summary

This API allows to get QoE all events.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully fetched",
  • "data": {
    }
}

Acknowledge summary QoE events

This API allows to acknowledge summary QoE events within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "string",
  • "scopeId": [
    ],
  • "limit": "string",
  • "offset": "string",
  • "search": "string",
  • "filters": {
    },
  • "summary": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged.",
  • "data": {
    }
}

Delete QoE summary events

This API allows to delete summary QoE events.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "string",
  • "scopeId": [
    ],
  • "limit": "string",
  • "offset": "string",
  • "search": "string",
  • "filters": {
    },
  • "summary": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted.",
  • "data": {
    }
}

Get Traps event summary

This API allows to get Traps all events.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully fetched",
  • "data": {
    }
}

Acknowledge summary Traps events

This API allows to acknowledge summary Traps events within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "string",
  • "scopeId": [
    ],
  • "limit": "string",
  • "offset": "string",
  • "search": "string",
  • "filters": {
    },
  • "summary": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged.",
  • "data": {
    }
}

Delete Traps summary events

This API allows to delete summary Traps events.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "string",
  • "scopeId": [
    ],
  • "limit": "string",
  • "offset": "string",
  • "search": "string",
  • "filters": {
    },
  • "summary": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted.",
  • "data": {
    }
}

Get Switch Traps summary

This API allows to get summary of all Switch Traps.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully fetched",
  • "data": {
    }
}

Acknowledge Switch Traps Summary

This API allows to acknowledge summary of Switch Traps within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "string",
  • "scopeId": [
    ],
  • "limit": "string",
  • "offset": "string",
  • "search": "string",
  • "filters": {
    },
  • "summary": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged.",
  • "data": {
    }
}

Delete Switch Traps summary

This API allows to delete summary of Switch Traps.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "scope": "string",
  • "scopeId": [
    ],
  • "limit": "string",
  • "offset": "string",
  • "search": "string",
  • "filters": {
    },
  • "summary": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted.",
  • "data": {
    }
}

Get QoE event details

This API allows to get all QoE event details.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully fetched",
  • "data": {
    }
}

Acknowledge QoE events

This API allows to acknowledge QoE events by their ids within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged.",
  • "data": {
    }
}

Delete QoE events

This API allows to delete QoE events identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted.",
  • "data": {
    }
}

Get Traps event details

This API allows to get all Traps event details.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully fetched",
  • "data": {
    }
}

Acknowledge Traps events

This API allows to acknowledge Traps events by their ids within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged.",
  • "data": {
    }
}

Delete Traps events

This API allows to delete Traps events identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted.",
  • "data": {
    }
}

Get Switch Traps details

This API allows to get all Switch Traps details.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully fetched",
  • "data": {
    }
}

Acknowledge Switch Traps

This API allows to acknowledge Switch Traps by their ids within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged.",
  • "data": {
    }
}

Delete Switch Traps

This API allows to delete Switch Traps identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted.",
  • "data": {
    }
}

Acknowledge all QoE events

This API allows to acknowledge all QoE events within an organization

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "scope": "string",
  • "scopeId": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged."
}

Acknowledge all Traps events

This API allows to acknowledge all Traps events within an organization

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "scope": "string",
  • "scopeId": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged."
}

Acknowledge all Switch Traps

This API allows to acknowledge all Switch Traps within an organization

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "scope": "string",
  • "scopeId": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully acknowledged."
}

Delete all QoE events

This API allows to delete all QoE events within an organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "scope": "string",
  • "scopeId": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted."
}

Delete all Traps events

This API allows to delete all Traps events within an organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "scope": "string",
  • "scopeId": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted."
}

Delete all Switch Traps

This API allows to delete all Switch Traps within an organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "scope": "string",
  • "scopeId": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The events have been successfully deleted."
}

Get all event definitions

This API allows to get all event definitions.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event definitions have been successfully fetched.",
  • "data": [
    ]
}

Update multiple event definitions

This API allows to update multiple event definitions.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event definitions have been successfully updated.",
  • "data": [
    ]
}

Update an event definition

This API allows to update an event definition.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

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

Request samples

Content type
application/json
{
  • "severity": "string",
  • "synopsis": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event definition has been successfully updated.",
  • "data": {
    }
}

Reset event definitions

This API allows to reset event definitions.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event definitions have been successfully reseted",
  • "data": {
    }
}

Reset all event definitions

This API allows to reset all event definitions.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event definitions have been successfully reseted",
  • "data": {
    }
}

Create an event responder

This API allows to create an event responder.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "isEnabled": true,
  • "devices": [
    ],
  • "apGroups": [
    ],
  • "sites": [
    ],
  • "filterType": "Severity",
  • "filterScope": "ANY",
  • "filters": [
    ],
  • "severities": [
    ],
  • "response": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The event responder has been successfully created.",
  • "data": {
    }
}

Get all event responder

This API allows to get all event responder.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Event Responder have been successfully fetched.",
  • "data": [
    ]
}

Delete multiple event responder

This API allows to delete multiple event responder identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Event Responder have been successfully deleted.",
  • "data": {
    }
}

Update an event responder

This API allows to update an event responder within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

responderId
required
string

This is a path param for responderId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "isEnabled": true,
  • "devices": [
    ],
  • "apGroups": [
    ],
  • "sites": [
    ],
  • "filterType": "Severity",
  • "filterScope": "ANY",
  • "filters": [
    ],
  • "severities": [
    ],
  • "response": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Event Responder has been successfully updated.",
  • "data": {
    }
}

Get all event settings

This API allows to get all event settings.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event settings have been successfully fetched.",
  • "data": [
    ]
}

Update an event setting

This API allows to update an event setting within an organization using JSON

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "event_absorption": "string",
  • "absorption_period": "string",
  • "days_before_purge": "string",
  • "max_no_of_records": "string",
  • "responder_max_trap_limit": "string",
  • "responder_max_time_limit": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event settings has been successfully updated.",
  • "data": {
    }
}

Get the wips policy

This API allows to get the wips policy.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The policy has been successfully fetched.",
  • "data": {
    }
}

Update wips policy

This API allows to update wips policy.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "orgId": "string",
  • "isSignalStrengthThresholdEnabled": true,
  • "signalStrengthThreshold": 0,
  • "isDetectSSIDEnabled": true,
  • "isRogueSSIDEnabled": true,
  • "rogueSSID": [
    ],
  • "isRogueOUIEnabled": true,
  • "rogueOUI": [
    ],
  • "isFriendlyAPEnabled": true,
  • "friendlyMac": [
    ],
  • "isPreventSwitchEnabled": true,
  • "isDetectSwitchEnabled": true,
  • "wirelessAttackDetection": [
    ],
  • "isDynamicClientBlocklistEnabled": true,
  • "agingTimeValue": "string",
  • "agingTimeUnit": "string",
  • "maxAuthFailureTimes": "string",
  • "maxAuthFailurePeriod": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The policy has been successfully fetched.",
  • "data": {
    }
}

Get the ap attack details

This API allows to get the ap attack details.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The AP detection policy has been successfully fetched",
  • "data": [
    ]
}

Get the client attack details

This API allows to get the client attack details.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The detection policy successfully fetched",
  • "data": [
    ]
}

Get the aging time details.

This API allows to get the aging time details.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Aging time successfully fetched.",
  • "data": {
    }
}

Reset wips policy

This API allows to reset wips policy.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The policy has been successfully reset",
  • "data": {
    }
}

Get Interfering AP

This API allows to get Interfering AP details.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Interfering APs have been successfully fetched.",
  • "data": {
    }
}

Get Friendly AP

This API allows to get Friendly AP details.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Friendly APs have been successfully fetched.",
  • "data": {
    }
}

Get Rogue AP

This API allows to get Rogue AP details.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue APs have been successfully fetched.",
  • "data": {
    }
}

Get Client associated with Interfering AP

This API allows to get Client associated with Interfering AP details.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Clients Info connected to Interfering APs have been successfully fetched.",
  • "data": {
    }
}

Get Client associated with Rogue AP

This API allows to get Client associated with Rogue AP details.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Clients Info connected to Rogue APs have been successfully fetched.",
  • "data": {
    }
}

Move Interfering/Rogue AP to Friendly AP

This API allows to Move Interfering/Rogue AP to Friendly AP.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Friendly AP has been successfully updated.",
  • "data": {
    }
}

Get Wireless Attack Client

This API allows to get Wireless Attacks Client details.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Interfering APs have been successfully fetched.",
  • "data": {
    }
}

Get Wireless Attack AP

This API allows to get Wireless Attacks AP details.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Interfering APs have been successfully fetched.",
  • "data": {
    }
}

Get Client Blocklist

This API allows to get Blocklisted client data.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Blocklisted client data has been successfully fetched.",
  • "data": [
    ]
}

Get Rogue AP and Clients

This API allows to get Rogue AP and Client Analytics.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP and Client Analytics have been successfully fetched.",
  • "data": [
    ]
}

Get Top Attacks

This API allows to get Top Attacks.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Top Attacks Analytics have been successfully fetched.",
  • "data": {
    }
}

Get RogueAP Detected count

This API allows to get RogueAP Detected count.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP and Client Analytics have been successfully fetched.",
  • "data": [
    ]
}

Get RogueAP Detected List

This API allows to get RogueAP Detected List.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP list have been successfully fetched.",
  • "data": [
    ]
}

Get RogueAP Prevented count

This API allows to get RogueAP Prevented count.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP and Client Analytics have been successfully fetched.",
  • "data": [
    ]
}

Get RogueAP Prevented List

This API allows to get RogueAP Prevented List.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP list have been successfully fetched.",
  • "data": [
    ]
}

Get Rogue Client count

This API allows to get Rogue Client count.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP and Client Analytics have been successfully fetched.",
  • "data": [
    ]
}

Get Rogue Client List

This API allows to get Rogue Client List.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP list have been successfully fetched.",
  • "data": [
    ]
}

Get Block Client count

This API allows to get Block Client count.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP and Client Analytics have been successfully fetched.",
  • "data": [
    ]
}

Get Block Client List

This API allows to get Block Client List.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP list have been successfully fetched.",
  • "data": [
    ]
}

Get DeAuth Client count

This API allows to get DeAuth Client count.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP and Client Analytics have been successfully fetched.",
  • "data": [
    ]
}

Get DeAuth Client List

This API allows to get DeAuth Client List.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Rogue AP list have been successfully fetched.",
  • "data": [
    ]
}

Get events by client.

This API is used to get the related events to a specific client identified by providing the client mac address

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The event details have been successfully fetched",
  • "data": {
    }
}

Building

Create a Building

This API allows to register a new building in a given organization and site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The building has been successfully created.",
  • "data": {
    }
}

Get all site buildings

This API allows to fetch all buildings associated to a given organization and site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The buildings have been successfully fetched.",
  • "data": [
    ]
}

Get a building

This API allows to fetch one building identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The building has been successfully fetched.",
  • "data": {
    }
}

Update a building

This API allows to update one building identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The building has been successfully updated.",
  • "data": {
    }
}

Delete a building

This API allows to delete a building identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The building has been successfully deleted.",
  • "data": {
    }
}

Get all buildings and theirs floors of a site

This API allows to fetch all buildings and the associated floors of a given site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The buildings have been successfully fetched.",
  • "data": [
    ]
}

Floor

Create a Floor

This API allows to register a new floor in a given organization, site and building.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

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
number <double>

The relative altitude of the floor. (in meters)

required
object

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

area
required
number <double>

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "floorNumber": 0,
  • "floorPlanUrl": "string",
  • "floorPlanImageCoordinates": {
    },
  • "relativeAltitude": 0,
  • "areaGeometry": {
    },
  • "area": 0,
  • "areaUnit": "squareMeters",
  • "buildingId": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The floor has been successfully created.",
  • "data": {
    }
}

Get all building floors

This API allows to fetch all floors associated to a given building.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The floors have been successfully fetched.",
  • "data": [
    ]
}

Get a floor

This API allows to fetch one floor identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The floor has been successfully fetched.",
  • "data": {
    }
}

Update a floor

This API allows to update one floor identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

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
number <double>

The relative altitude of the floor. (in meters)

required
object

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

area
required
number <double>

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "floorNumber": 0,
  • "floorPlanUrl": "string",
  • "floorPlanImageCoordinates": {
    },
  • "relativeAltitude": 0,
  • "areaGeometry": {
    },
  • "area": 0,
  • "areaUnit": "squareMeters",
  • "buildingId": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The floor has been successfully updated.",
  • "data": {
    }
}

Delete a floor

This API allows to delete a floor identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The floor has been successfully deleted.",
  • "data": {
    }
}

Loginhistory

Get user login history

This API allows to 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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Login histories have been successfully fetched.",
  • "data": [
    ]
}

Usersettings

Get user's settings

This API allows to get user's settings for the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user settings has been successfully fetched.",
  • "data": {
    }
}

Update user's settings

This API allows to 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" "MAC_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

Request samples

Content type
application/json
{
  • "isLoginHistoryEnabled": true,
  • "theme": "DEFAULT",
  • "chartColorScheme": "GENERIC",
  • "tableDisplayMode": "MEDIUM",
  • "preferredDeviceNaming": "IP_ADDRESS",
  • "gridDisplayMode": "CARD"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user settings has been successfully updated.",
  • "data": {
    }
}

Qoe

Get WLAN thresholds for a given site.

This API is used to get WLAN thresholds for a given site. Those thresholds are taken into account in the calculation of the WLAN Analytics data.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Site thresholds has been successfully fetched.",
  • "data": {
    }
}

Update WLAN thresholds for a given site.

This API is used to 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.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
timeToConnectThreshold
number <double>

Time to to connect thereshold.

coverageThreshold
number <double>

Coverage threshold.

roamingThreshold
number <double>

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
number <double>

Available Capacity threshold in percentage for Access Point.

clientHealth2_4GThreshold
number <double>

Client Health (2.4 GHz) threshold.

clientHealth5GThreshold
number <double>

Client Health (5 GHz) threshold.

clientHealth6GThreshold
number <double>

Client Health (6 GHz) threshold.

clientSNR2_4GThreshold
number <double>

Client SNR (2.4 GHz) threshold.

clientSNR5GThreshold
number <double>

Client SNR (5 GHz) threshold.

clientSNR6GThreshold
number <double>

Client SNR (6 GHz) threshold.

radioNoise2_4GThreshold
number <double>

Radio noise (2.4 GHz) threshold.

radioNoise5GThreshold
number <double>

Radio noise (5 GHz) threshold.

radioNoise6GThreshold
number <double>

Radio noise (6 GHz) threshold.

radioUtilization2_4GThreshold
number <double>

Radio utilization (2.4 GHz) threshold.

radioUtilization5GThreshold
number <double>

Radio utilization (5 GHz) threshold.

radioUtilization6GThreshold
number <double>

Radio utilization (6 GHz) threshold.

radioInterference2_4GThreshold
number <double>

Radio interference (2.4 GHz) threshold.

radioInterference5GThreshold
number <double>

Radio interference (5 GHz) threshold.

radioInterference6GThreshold
number <double>

Radio interference (6 GHz) threshold.

retransmissionThreshold
number <double>

Retransmission threshold.

errorThreshold
number <double>

Error threshold.

Responses

Request samples

Content type
application/json
{
  • "timeToConnectThreshold": 0,
  • "coverageThreshold": 0,
  • "roamingThreshold": 0,
  • "cpuAPThreshold": 0,
  • "memoryAPThreshold": 0,
  • "flashAPThreshold": 0,
  • "availableCapacityThreshold": 0,
  • "clientHealth2_4GThreshold": 0,
  • "clientHealth5GThreshold": 0,
  • "clientHealth6GThreshold": 0,
  • "clientSNR2_4GThreshold": 0,
  • "clientSNR5GThreshold": 0,
  • "clientSNR6GThreshold": 0,
  • "radioNoise2_4GThreshold": 0,
  • "radioNoise5GThreshold": 0,
  • "radioNoise6GThreshold": 0,
  • "radioUtilization2_4GThreshold": 0,
  • "radioUtilization5GThreshold": 0,
  • "radioUtilization6GThreshold": 0,
  • "radioInterference2_4GThreshold": 0,
  • "radioInterference5GThreshold": 0,
  • "radioInterference6GThreshold": 0,
  • "retransmissionThreshold": 0,
  • "errorThreshold": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Site thresholds has been successfully updated",
  • "data": {
    }
}

Get QoE metrics for all organization sites

This API is used to 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.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "QoE Organization summary metrics have been successfully fetched.",
  • "data": [
    ]
}

Get QoE Time To Connect data

This API is used to 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.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "QoE Time-to-connect data have been successfully fetched.",
  • "data": {
    }
}

Get QoE Time To Connect classifiers data

This API is used to 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.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "QoE Time-to-connect classifiers data have been successfully fetched.",
  • "data": {
    }
}

Get QoE Successful Connects data

This API is used to get the number of Successful Connects and the classified failure reasons applied to a given scope in a specified period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "QoE Successful Connects data have been successfully fetched.",
  • "data": {
    }
}

Get QoE Successful Connections Classifiers data

This API is used to 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.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "QoE Successful Connects Classifiers data have been successfully fetched.",
  • "data": {
    }
}

Get QoE Coverage data

This API is used to get the Coverage RSSI signal and the classified failures reasons applied to a given scope in a specified period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "QoE Coverage data have been successfully fetched.",
  • "data": {
    }
}

Get QoE Available Capacity data

This API is use to get QoE Available Capacity of Access Points presented in a given scope in a specified period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get QoE Available Capacity Classifiers data

This API is use to get the Available Capacity Classifiers QoE of AP devices and clients in an identified scope during a specified period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Available Capacity Classifiers data have been successfully fetched.",
  • "data": {
    }
}

Get QoE Roaming data

This API is use to get QoE Roaming data applied to a given scope in a specified period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "QoE Roaming data have been successfully fetched.",
  • "data": {
    }
}

Get QoE Coverage Classifiers data

This API is used to get the Coverage Classifiers to a given scope in a specified period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}

Get QoE Roaming Failed Classifiers data

This API is use to get QoE Roaming Classifiers data applied to a given scope in a specified period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "QoE Romaing Classifiers data have been successfully fetched.",
  • "data": {
    }
}

Retrieve AP Link uptime/downtime

This API is used to get the Link uptime/downtime of Access Points.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Subscription

Request subscription for given organization

This API is used to 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.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

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

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

aleRepresentativeEmails
required
Array of any

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

Request samples

Content type
application/json
{
  • "aleRepresentativeNames": [
    ],
  • "aleRepresentativeEmails": [
    ],
  • "startDate": "string",
  • "expectedDuration": 0,
  • "partnerCRDID": "string",
  • "partnerName": "string",
  • "partnerContactName": "string",
  • "partnerContactEmail": "string",
  • "allowedDevices": "string",
  • "businessArgument": "string",
  • "isRAPRequested": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The subscription request has been successfully sent.",
  • "data": {
    }
}

Get the subscription attached to a given organization.

This API is used to get the subscription attached to a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The subscription has been successfully fetched.",
  • "data": {
    }
}

Request update for an approved subscription

This API is used to 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.

path Parameters
orgId
required
string

This is a path param for orgId

subId
required
string

This is a path param for subId

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

Request samples

Content type
application/json
{
  • "newEndDate": "string",
  • "newAllowedDevices": 0,
  • "businessArgument": "string",
  • "isRAPRequested": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The update subscription request has been successfully sent.",
  • "data": {
    }
}

Request update for an Expired subscription

This API is used to 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.

path Parameters
orgId
required
string

This is a path param for orgId

subId
required
string

This is a path param for subId

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

Request samples

Content type
application/json
{
  • "newEndDate": "string",
  • "newAllowedDevices": 0,
  • "businessArgument": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The update subscription request has been successfully sent.",
  • "data": {
    }
}

Useractivity

Export a user's activity

This API is used to export activities for a given user between two dates

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
text/csv
Timestamp,Action,User,Organization,Site,Description
Thu Nov 26 2020 14:59:36,Add Site 'ALE',john.doe@al-enterprise.com,ALE,ALE NAME,Creation of a new site 'ALE NAME'
Thu Nov 26 2020 14:59:53,Add Building 'Building West',john.doe@al-enterprise.com,ALE,ALE NAME,Creation of a new building 'Batiment A'
Thu Nov 26 2020 15:17:21,Add Floor '1st floor' inside Building 'Building West',john.doe@al-enterprise.com,ALE,ALE NAME,Creation of a new floor 'Etage 1'
Thu Nov 26 2020 15:59:04,Add Device 'switch R&D' into inventory,john.doe@al-enterprise.com,ALE,ALE NAME,Creation of a new device '00:11:22:33:44:11 (OAW-OS6860E-U2)'
Thu Nov 26 2020 15:59:15,Update Settings of the Device 'switch R&D',john.doe@al-enterprise.com,ALE,ALE Paris,Update of the device '00:11:22:33:44:84 (OAW-U28)'
Thu Nov 26 2020 16:00:10,Add Device 'switch Meeting Room 1',john.doe@al-enterprise.com,ALE,ALE NAME,Creation of new devices: '18:64:72:CF:76:C1 (OAW-AP1201)', '00:0B:86:B5:85:07 (OAW-4030)', '00:0B:86:B5:78:37 (OAW-4030)', '00:0B:86:6D:37:2C (OAW-4704)', 'DC:08:56:00:34:B0 (OAW-AP1231)', '34:E7:0B:00:17:20 (OAW-AP1101)'
Thu Nov 26 2020 16:09:26,,john.doe@al-enterprise.com,Microsoft S.A.,-,Update of the organization 'Microsoft S.A.'

Walltype

Get all wall types

This API allows to 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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Wall types have been successfully fetched.",
  • "data": [
    ]
}

Wall

Get site walls

This API allows to fetch all walls associated to a given site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The walls have been successfully fetched.",
  • "data": [
    ]
}

Get building walls

This API allows to fetch all walls located in a given building.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The walls have been successfully fetched.",
  • "data": [
    ]
}

Get floor walls

This API allows to fetch all walls located in a given floor of a given building.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The walls have been successfully fetched.",
  • "data": [
    ]
}

Create a wall

This API allows to cretae a new wall in a floor.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "wallTypeId": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The wall has been successfully created.",
  • "data": {
    }
}

Get a wall

This API allows to fetch one wall identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

wallId
required
string

This is a path param for wallId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wall have been successfully fetched.",
  • "data": {
    }
}

Delete a wall

This API allows to delete a wall identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

wallId
required
string

This is a path param for wallId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wall has been successfully deleted.",
  • "data": {
    }
}

Update a wall

This API allows to update one wall identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

wallId
required
string

This is a path param for wallId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "wallTypeId": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wall has been successfully updated.",
  • "data": {
    }
}

Update a wall geometry

This API allows to update the geometry of one wall identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

wallId
required
string

This is a path param for wallId

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.

required
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

Request samples

Content type
application/json
{
  • "name": "string",
  • "wallTypeId": "string",
  • "geometry": {
    },
  • "distance": 0,
  • "distanceUnit": "meters"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wall has been successfully updated.",
  • "data": {
    }
}

Wifirtls

Retrieve fingerprint heatmap

This API is used to get the fingerprint heatmap of a floor identified by its id, or a set of devices identified by their MAC address.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Heatmap data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve location of clients

This API is used to 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).

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Heatmap data have been successfully fetched.",
  • "data": {
    }
}

Retrieve the proximity, loyalty and dwell time analytics

This API is used to get the proximity, loyalty and dwell time analytics of one polygon area in an identified floor.

path Parameters
orgId
required
string

This is a path param for orgId

floorId
required
string

This is a path param for floorId

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

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Dwell time data have been successfully fetched.",
  • "data": {
    }
}

Retrieve the historic client heatmap

This API is used to get the client heatmap of an identified floor at a moment in the past.

path Parameters
orgId
required
string

This is a path param for orgId

floorId
required
string

This is a path param for floorId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Heatmap data have been successfully fetched.",
  • "data": {
    }
}

Retrieve the status of fingerprint generation

This API is used to get the status of the fingerprint generation process of an identified floor.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Heatmap status have been successfully fetched.",
  • "data": {
    }
}

Request a new fingerprint

This API is used to send a demand to re-genreate the fingerprint heatmap of floor.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Heatmap status have been successfully fetched.",
  • "data": {
    }
}

Wlananalytics

Retrieve distributed channel assignment

This API is used to get the distributed channel assignment

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Channel assignement data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve the Device health summary

This API is used to get the Health usage of the devices in the selected scope.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Devices Summary data have been successfully fetched.",
  • "data": {
    }
}

Retrieve the Access Point Power Details

This API is used to get the Power PoE Detail of an Access Point.

path Parameters
orgId
required
string

This is a path param for orgId

apMac
required
string

This is a path param for apMac

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "WLAN Analytics data have been successfully fetched.",
  • "data": {
    }
}

Retrieve the Access Point Rf Details

This API is used to get the Radio Frequency Detail of an Access Point.

path Parameters
orgId
required
string

This is a path param for orgId

apMac
required
string

This is a path param for apMac

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "WLAN Analytics data have been successfully fetched.",
  • "data": {
    }
}

Retrieve the Access Point Health

This API is used to get the CPU and Memory usage of AccessPoint in the selected scope.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Access Point Health data have been successfully fetched.",
  • "data": {
    }
}

Retrieve channel utilization percentage

This API is used to get the channel utilization percentage.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Channel utilization data have been successfully fetched.",
  • "data": {
    }
}

Retrieve neighbor APs and the channel utilization analytics

This API is used to get the current neighbor Access Points and the current channel utilization for each AP in an identified floor.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Neighbor Access Point data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve Rogue/Interfering Access Points

This API is used to get Rogue/Interfering Access Points detected by all Access Points or by only one identified Access Points located in a floor.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

floorId
required
string

This is a path param for floorId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Rogue/Interference Access Point data have been successfully fetched.",
  • "data": [
    ]
}

Get connected clients

This API is used to get the list of connected clients in a given period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client List data have been successfully fetched.",
  • "data": {
    }
}

Retrieve History Wireless client Sessions

This API is used to get the list of historical client sessions in period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client sessions have been successfully fetched.",
  • "data": [
    ]
}

Retrieve History Wired clients Sessions

This API is used to get the list of historical wired client sessions in period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "errorCode": 400,
  • "errorMsg": "Bad Request",
  • "errors": [
    ]
}

Retrieve Online Wireless clients

This API is used to get the list of Online Wireless client's sessions.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client sessions have been successfully fetched.",
  • "data": [
    ]
}

Retrieve client Wireless summary

This API is used to get the summary of a wireless client.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Wireless client sessions summary has been successfully fetched.",
  • "data": {
    }
}

Retrieve client Wired summary

This API is used to get the summary of a wired client.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Wired client sessions summary has been successfully fetched.",
  • "data": {
    }
}

Retrieve throughput consumption (Rx/Tx)

This API is used to get the throughput consumption (Rx/Tx).

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Throughput consumption have been successfully fetched.",
  • "data": {
    }
}

Retrieve TX Power history

This API is used to get TX power history of a given device by providing the device mac address.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Tx Power History of a given device have been successfully fetched.",
  • "data": {
    }
}

Retrieve Channel Utilization of a given device.

This API is used to get the channel utilization of a given device by providing the device mac address.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Channel utilization of a given device have been successfully fetched.",
  • "data": {
    }
}

Retrieve Channel In Used of a given device.

This API is used to get the channel in used of a given device by providing the device mac address.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Channel in used of a given device have been successfully fetched.",
  • "data": {
    }
}

Retrieve RSSI values evolution of a given client.

This API is used to get the RSSI values evolution of a given client by providing the client mac address.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client RSSI have been successfully fetched",
  • "data": {
    }
}

Retrieve Phy Rate values evolution of a given client.

This API is used to get the Physical Rate values evolution of a given client by providing the client mac address.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client Phy Rate evolution have been successfully fetched.",
  • "data": {
    }
}

Retrieve throughput values evolution of a given client.

This API is used to get the throughput values evolution of a given client by his Mac address.

path Parameters
orgId
required
string

This is a path param for orgId

mode
required
string

This is a path param for mode

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Throughput have been successfully fetched.",
  • "data": {
    }
}

Retrieve client distribution

This API is used to get the client distribution across Access Points.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client distribution across AP has been successfully fetched.",
  • "data": [
    ]
}

Retrieve client categorization

This API is used to get the client categorization in a period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client categorization has been successfully fetched.",
  • "data": [
    ]
}

Retrieve list session distribution

This API is used to get a distribution of sessions based on a given groupBy label.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client session list distribution data have been successfully fetched.",
  • "data": [
    ]
}

The criteria trend by client

This API is used to get criteria trend by client

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Data client by criteria have been successfully fetched.",
  • "data": [
    ]
}

Retrieve wireless connected duration pagination

This API is used to get information about the wireless user's connected duration.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Connected durations data have been successfully fetched.",
  • "data": {
    }
}

Retrieve wired connected duration pagination

This API is used to get information about the wired user's connected duration.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Connected durations data have been successfully fetched.",
  • "data": {
    }
}

Retrieve Connected durations

This API is used to get information about the average duration of clients sessions.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Connected durations data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve devices number per user

This API is used to get the number of devices used on average per user.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Number of devices used per user data have been successfully fetched.",
  • "data": {
    }
}

Retrieve top N domain names and URLs

This API is used to get the top N Domain names and URLs accessed by clients.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Top URLs domain data have been successfully fetched.",
  • "data": {
    }
}

Retrieve Client Health

This API is used to 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.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client Health data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve SSID usage

This API is used to get the usage over time for a given SSID.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "SSID usages data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve SSID clients

This API is used to get the number of clients connected to a given SSID over time.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "SSID clients data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve access points radios

This API is used to get access points radios in a given scope.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "AP Radios data have been successfully fetched..",
  • "data": [
    ]
}

Retrieve access points utilization ranking

This API is used to get access points ranking based on utilization

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Utilization ranking data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve SSID usage detail

This API is used to get SSID usage detail

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "SSID Detail Usage have been successfully fetched.",
  • "data": [
    ]
}

Retrieve radios interferences

This API is used to get the radios interferences.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Radios interferences data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve Client Session Distribution

This API is used to get Client session distribution

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Sessions distribution data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve trend of # of radios with Low/High utilisation

This API is used to get trend of # of radios with Low/High utilisation

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Radios utilisation data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve trend of # of Radios with Low/High Noise

This API is used to get trend of # of Radios with Low/High Noise

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Radios noise successfully fetched.",
  • "data": [
    ]
}

Retrieve Access Points ranking by criteria.

This API is used to get Access Points ranking order by criteria.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "AP ranking by criteria data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve Clients ranking by criteria.

This API is used to get clients list ranking order by criteria

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client ranking by criteria data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve the top clients based on usage

This API is used to get the top clients based on usage

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Top clients by usage data have been successfully fetched.",
  • "data": [
    ]
}

Switchanalytics

Get summary of one switch

This API is used to get the summary of one switch.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "LAN Analytics data have been successfully fetched.",
  • "data": {
    }
}

Get Switch Port PoE

This API is used to get the PoE Status on switch ports.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Slot interface switch data have been successfully fetched.",
  • "data": [
    ]
}

Get Switch Port status

This API is used to get the Port information of a Switch.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Slot interface switch data have been successfully fetched.",
  • "data": {
    }
}

Get Switch CMM Utilization Summary

This API is used to get the switch CMM utilization summary .

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "LAN Analytics data have been successfully fetched.",
  • "data": {
    }
}

Retrieve switch health evolution

This API is used to get the CPU and Memory usage of a switch identified by its serial number.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The health evolution has been successfully fetched.",
  • "data": {
    }
}

Retrieve switch throughput evolution

This API is used to get the average of the rx & rxTx per day, minute and hour of a switch identified by its serial number.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Throughput have been successfully fetched.",
  • "data": {
    }
}

Retrieve switch port vlan list

This API is used to get the vlan port list of a switch identified by its serial number.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "data": [
    ],
  • "status": 200,
  • "message": "LAN Analytics data have been successfully fetched."
}

Retrieve switch port health evolution

This API is used to get the evolution of the port rx & rxTx of a switch identified by its mac.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "data": {
    },
  • "message": "The health evolution has been successfully fetched.",
  • "status": 200
}

Retrieve switch ethernet port health evolution

This API is used to get the evolution of the ethernet port rx & rxTx of a switch identified by its mac.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
null

Retrieve Switch Interface port

This API is used to get the list of Interface port of Switch in the scope.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Slot interface switch data have been successfully fetched.",
  • "data": [
    ]
}

Retrieve Session Summary of UNP

This API is used to get the summary of a UNP client.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "UNP client sessions summary has been successfully fetched.",
  • "data": {
    }
}

Retrieve Live UNP and Wired Clients

This API is used to get the list of current UNP and wired clients with an active session.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "List of UNP and Wired users have been successfully fetched.",
  • "data": {
    }
}

Retrieve History UNP and Wired clients Sessions

This API is used to get the list of historical UNP and wired client sessions in period of time.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "List of UNP and Wired users have been successfully fetched.",
  • "data": {
    }
}

Get Lldp by Switch

This API is used to obtain LLDP data for a given switch identified by its serial number.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Reporting

Get report templates

This API is used to get all default report templates.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The report templates have been successfully fetched.",
  • "data": [
    ]
}

Get user's reports

This API is used to get the user's reports in an organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The reports have been successfully fetched.",
  • "data": [
    ]
}

Create organization report

This API allows to create .

path Parameters
orgId
required
string

This is a path param for orgId

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.

email
required
Array of strings

List of emails where to send the report. At least 1 email is required

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" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

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.

required
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

Request samples

Content type
application/json
{
  • "dateRange": "lasthour",
  • "scope": "org",
  • "scopeId": [
    ],
  • "serials": [
    ],
  • "startDate": "string",
  • "endDate": "string",
  • "email": [
    ],
  • "timeZone": "Africa/Abidjan",
  • "search": {
    },
  • "widgets": [
    ],
  • "fileType": "CSV",
  • "widgetInFile": {
    },
  • "scheduler": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The report has been successfully created.",
  • "data": {
    }
}

Delete multiple reports

This API is used to delete multiples reports by a list of ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The reports have been successfully deleted",
  • "data": [
    ]
}

Update report

This API is used to update an user's report content or to set scheduled generation by report's id.

path Parameters
orgId
required
string

This is a path param for orgId

reportId
required
string

This is a path param for reportId

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.

email
required
Array of strings

List of emails where to send the report. At least 1 email is required

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" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

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.

required
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

Request samples

Content type
application/json
{
  • "dateRange": "lasthour",
  • "scope": "org",
  • "scopeId": [
    ],
  • "serials": [
    ],
  • "startDate": "string",
  • "endDate": "string",
  • "email": [
    ],
  • "timeZone": "Africa/Abidjan",
  • "search": {
    },
  • "widgets": [
    ],
  • "fileType": "CSV",
  • "widgetInFile": {
    },
  • "scheduler": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The reports have been successfully updated",
  • "data": {
    }
}

Delete report

This API is used to delete a user'report by id.

path Parameters
orgId
required
string

This is a path param for orgId

reportId
required
string

This is a path param for reportId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The report has been successfully deleted.",
  • "data": {
    }
}

Get report by Id

This API is used to get the user's reports in an organization by id.

path Parameters
orgId
required
string

This is a path param for orgId

reportId
required
string

This is a path param for reportId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The reports have been successfully fetched.",
  • "data": {
    }
}

Send report

This API is used to send an user's report to the list of email and to update the receiver's emails list in report.

path Parameters
orgId
required
string

This is a path param for orgId

reportId
required
string

This is a path param for reportId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
emails
required
string

List of emails where to send the report

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The report has been successfully sent.",
  • "data": {
    }
}

Ssid

Get all SSIDs

This API allows you to get all SSIDs for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "SSID has been successfully fetched.",
  • "data": [
    ]
}

Create SSID

This API allows you to create a new SSID for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

A JSON object of the SSID.

object

The Config Assignment of SSID.

Responses

Request samples

Content type
application/json
{
  • "ssid": {
    },
  • "configAssignment": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "SSID has been successfully created.",
  • "data": {
    }
}

Update SSID

This API allows you to update an SSID for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

A JSON object of the SSID.

Array of objects

The Config Assignment of SSID.

Responses

Request samples

Content type
application/json
{
  • "ssid": {
    },
  • "assignments": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "SSID has been successfully updated.",
  • "data": {
    }
}

Get the number of SSIDs by group

This API allows you to get the number of SSIDs by group for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

groupId
required
string

This is a path param for groupId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The number of SSIDs has been successfully fetched.",
  • "data": 10
}

Get SSID by name

This API allows you to get SSID by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "SSID has been successfully fetched.",
  • "data": {
    }
}

Delete multiple SSIDs by names

This API allows you to delete multiple ssid by names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "SSIDs have been successfully removed.",
  • "data": [
    ]
}

Externalcaptiveportal

Get all External Captive Portals

This API allows you to get all External Captive Portals for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "External Captive Portals have been successfully fetched.",
  • "data": [
    ]
}

Create External Captive Portal

This API allows you to get create External Captive Portals for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{}

Update External Captive Portal

This API allows you to get update External Captive Portals for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "External Captive Portal has been successfully updated.",
  • "data": {
    }
}

Delete multiple External Captive Portal

This API allows you to get delete multiple External Captive Portals for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "message": "External Captive Portal has been successfully removed.",
  • "status": 200,
  • "data": [
    ]
}

Get only names External Captive Portals

This API allows you to get only names External Captive Portals for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "External Captive Portal has been successfully fetched.",
  • "data": [
    ]
}

Get External Captive Portal By Id

This API allows you to get External Captive Portal by id for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "External Captive Portal has been successfully fetched.",
  • "data": {
    }
}

Sync External Captive Portal to all aps

This API allows you to get only names External Captive Portals for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "External Captive Portals have been successfully fetched.",
  • "data": [
    ]
}

Download External Captive Portals

This API allows you to download External Captive Portals for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "data": "profile.zip"
}

Arp

Get all ARPs

This API allows you to get all ARPs for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "ARP has been successfully fetched.",
  • "data": [
    ]
}

Create an ARP

This API allows you to create a new ARP for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "arp": {
    },
  • "assignment": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "ARP has been successfully created.",
  • "data": {
    }
}

Update an ARP

This API allows you to update ARPs for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "arp": {
    },
  • "assignments": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "ARP has been successfully updated.",
  • "data": {
    }
}

Delete multiple ARPs by organization

This API allows you to delete multiple ARPs for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "ARPs have been successfully removed.",
  • "data": [
    ]
}

Get the ARP by name

This API allows you to get the ARP by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "ARP has been successfully fetched.",
  • "data": {
    }
}

Get the ARP by Id

This API allows you to get the ARP by Id for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "ARP has been successfully fetched.",
  • "data": {
    }
}

Arpdeviceconfig

Get all ARP Device Configs

This API allows you to get all ARP Device Configs for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "ARP Device Config has been successfully fetched.",
  • "data": [
    ]
}

Client802_1xcertificate

Get all Client 802.1X Certificates

This API allows you to get all client 802.1X certificates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client 802.1X certificates have been successfully fetched.",
  • "data": [
    ]
}

Create Client 802.1X Certificate

This API allows you to create client 802.1X certificate for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
string

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
string

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 samples

Content type
application/json
{}

Delete multiple Client 802.1X Certificates

This API allows you to delete multiple client 802.1X certificates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client 802.1X certificates have been successfully deleted.",
  • "data": [
    ]
}

Get all Client 802.1X Certificate names

This API allows you to get all client 802.1X certificate names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Client 802.1X certificates have been successfully fetched.",
  • "data": [
    ]
}

Download Client 802.1X Certificate

This API allows you to download client 802.1X certificate for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "name": "string"
}

Response samples

Content type
application/octet-stream; charset=utf-8
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Stellarblecertificate

Get all Stellar BLE Certificates

This API allows you to get all Stellar BLE Certificates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Stellar BLE Certificates have been successfully fetched.",
  • "data": [
    ]
}

Create Stellar BLE Certificate

This API allows you to create Stellar BLE Certificate for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
string

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
string

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
string

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 samples

Content type
application/json
{}

Delete multiple Stellar BLE Certificates

This API allows you to delete multiple Stellar BLE Certificates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Stellar BLE Certificates have been successfully deleted.",
  • "data": [
    ]
}

Get Stellar BLE Certificate by id

This API allows you to get Stellar BLE Certificate by id for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Stellar BLE Certificate has been successfully fetched.",
  • "data": {
    }
}

Get all Stellar BLE Certificate names

This API allows you to get all Stellar BLE certificate names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Stellar BLE Certificates have been successfully fetched.",
  • "data": [
    ]
}

Download Stellar BLE Certificate

This API allows you to download Stellar BLE Certificate for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "name": "string"
}

Response samples

Content type
application/octet-stream; charset=utf-8
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Stellarwifirtlscertificate

Get all Stellar WIFI RTLS Certificates

This API allows you to get all Stellar WIFI RTLS Certificates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Stellar WIFI RTLS Certificates have been successfully fetched.",
  • "data": [
    ]
}

Create Stellar WIFI RTLS Certificate

This API allows you to create Stellar WIFI RTLS Certificate for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
string

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
string

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
string

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 samples

Content type
application/json
{}

Delete multiple Stellar WIFI RTLS Certificates

This API allows you to delete multiple Stellar WIFI RTLS Certificates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Stellar WIFI RTLS Certificates have been successfully deleted.",
  • "data": [
    ]
}

Get Stellar WIFI RTLS Certificate by id

This API allows you to get Stellar WIFI RTLS Certificate by id for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Stellar WIFI RTLS Certificate has been successfully fetched.",
  • "data": {
    }
}

Get all Stellar WIFI RTLS Certificate names

This API allows you to get all Stellar WIFI RTLS certificate names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Stellar WIFI RTLS Certificates have been successfully fetched.",
  • "data": [
    ]
}

Download Stellar WIFI RTLS Certificate

This API allows you to download Stellar WIFI RTLS Certificate for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "name": "string"
}

Response samples

Content type
application/octet-stream; charset=utf-8
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Syslogovertlscertificate

Get all Syslog Over TLS Certificates

This API allows you to get all Syslog Over TLS Certificates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Syslog Over TLS Certificates have been successfully fetched.",
  • "data": [
    ]
}

Create Syslog Over TLS Certificate

This API allows you to create Syslog Over TLS Certificate for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
string

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 samples

Content type
application/json
{}

Delete multiple Syslog Over TLS Certificates

This API allows you to delete multiple Syslog Over TLS Certificates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Syslog Over TLS Certificates have been successfully deleted.",
  • "data": [
    ]
}

Get Syslog Over TLS Certificate by ID

This API allows you to get Syslog Over TLS Certificate by ID for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Syslog Over TLS Certificate has been successfully fetched.",
  • "data": {
    }
}

Get all Syslog Over TLS Certificate names

This API allows you to get all Syslog Over TLS certificate names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Syslog Over TLS Certificates have been successfully fetched.",
  • "data": [
    ]
}

Download Syslog Over TLS Certificate

This API allows you to download Syslog Over TLS Certificate for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "name": "string"
}

Response samples

Content type
application/octet-stream; charset=utf-8
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Rftemplate

Get all RF Templates

This API allows you to get all RF Templates for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "RF Template(s) has been successfully fetched.",
  • "data": [
    ]
}

Create an RF Template

This API allows you to create RF Template for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
number <double>

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
number <double>

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
number <double>

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
number <double>

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
number <double>

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
number <double>

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.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "countryCode": "string",
  • "bandSteering": true,
  • "bandSteeringForce5g": true,
  • "bandSteeringForce6g": true,
  • "excludeMacOUILists": "string",
  • "associationRSSIThreshold2": 0,
  • "associationRSSIThreshold5A": 0,
  • "associationRSSIThreshold5L": 0,
  • "associationRSSIThreshold5H": 0,
  • "associationRSSIThreshold6": 0,
  • "roamingRSSIThreshold2": 0,
  • "roamingRSSIThreshold5A": 0,
  • "roamingRSSIThreshold5H": 0,
  • "roamingRSSIThreshold5L": 0,
  • "roamingRSSIThreshold6": 0,
  • "dynamicLoadBalance": true,
  • "backgroundScanning": true,
  • "scanningInterval": 0,
  • "scanningDuration": 0,
  • "scanningChannel": "workChannel",
  • "voiceAndVideoAwareness": true,
  • "defaultSetting": true,
  • "band2": true,
  • "band5A": true,
  • "band5H": true,
  • "band5L": true,
  • "band6": true,
  • "channelSetting2": "string",
  • "channelSetting5A": "string",
  • "channelSetting5H": "string",
  • "channelSetting5L": "string",
  • "channelSetting6": "string",
  • "channelWidth2": "string",
  • "channelWidth5A": "string",
  • "channelWidth5H": "string",
  • "channelWidth5L": "string",
  • "channelWidth6": "string",
  • "powerSetting2": "string",
  • "powerSetting5A": "string",
  • "powerSetting5H": "string",
  • "powerSetting5L": "string",
  • "powerSetting6": "string",
  • "channelList5A": "string",
  • "channelList5H": "string",
  • "channelList5L": "string",
  • "channelList6": "string",
  • "channelDRM5A": true,
  • "channelDRM5H": true,
  • "channelDRM5L": true,
  • "channelDRM6": true,
  • "shortGuardInterval2": true,
  • "shortGuardInterval5A": true,
  • "shortGuardInterval5L": true,
  • "shortGuardInterval5H": true,
  • "shortGuardInterval6": true,
  • "minTXPower2": "string",
  • "minTXPower5A": "string",
  • "minTXPower5L": "string",
  • "minTXPower5H": "string",
  • "minTXPower6": "string",
  • "maxTXPower2": "string",
  • "maxTXPower5A": "string",
  • "maxTXPower5L": "string",
  • "maxTXPower5H": "string",
  • "maxTXPower6": "string",
  • "airtimeFairness2G": true,
  • "airtimeFairness5G": true,
  • "externalAntennasGain2": 0,
  • "externalAntennasGain5A": 0,
  • "externalAntennasGain5L": 0,
  • "externalAntennasGain5H": 0,
  • "externalAntennasGain6": 0,
  • "clientAwareness2": true,
  • "clientAwareness5A": true,
  • "clientAwareness5H": true,
  • "clientAwareness5L": true,
  • "clientAwareness6": true,
  • "muMimo2": true,
  • "muMimo5H": true,
  • "muMimo5A": true,
  • "muMimo5L": true,
  • "muMimo6": true,
  • "highEfficiency2": true,
  • "highEfficiency5L": true,
  • "highEfficiency5H": true,
  • "highEfficiency5A": true,
  • "highEfficiency6": true,
  • "beaconInterval2": 0,
  • "beaconInterval5A": 0,
  • "beaconInterval5L": 0,
  • "beaconInterval5H": 0,
  • "beaconInterval6": 0,
  • "csa2": true,
  • "csa5A": true,
  • "csa5H": true,
  • "csa5L": true,
  • "csa6": true,
  • "csaCount2": 0,
  • "csaCount5L": 0,
  • "csaCount5H": 0,
  • "csaCount5A": 0,
  • "csaCount6": 0,
  • "drmInterval": 0,
  • "drmStartTime": "string",
  • "drmTimeControl": true,
  • "radioSetting": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "RF Template has been successfully created.",
  • "data": {
    }
}

Update RF Template

This API allows you to update RF Template for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
number <double>

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
number <double>

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
number <double>

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
number <double>

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
number <double>

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
number <double>

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.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "countryCode": "string",
  • "bandSteering": true,
  • "bandSteeringForce5g": true,
  • "bandSteeringForce6g": true,
  • "excludeMacOUILists": "string",
  • "associationRSSIThreshold2": 0,
  • "associationRSSIThreshold5A": 0,
  • "associationRSSIThreshold5L": 0,
  • "associationRSSIThreshold5H": 0,
  • "associationRSSIThreshold6": 0,
  • "roamingRSSIThreshold2": 0,
  • "roamingRSSIThreshold5A": 0,
  • "roamingRSSIThreshold5H": 0,
  • "roamingRSSIThreshold5L": 0,
  • "roamingRSSIThreshold6": 0,
  • "dynamicLoadBalance": true,
  • "backgroundScanning": true,
  • "scanningInterval": 0,
  • "scanningDuration": 0,
  • "scanningChannel": "workChannel",
  • "voiceAndVideoAwareness": true,
  • "defaultSetting": true,
  • "band2": true,
  • "band5A": true,
  • "band5H": true,
  • "band5L": true,
  • "band6": true,
  • "channelSetting2": "string",
  • "channelSetting5A": "string",
  • "channelSetting5H": "string",
  • "channelSetting5L": "string",
  • "channelSetting6": "string",
  • "channelWidth2": "string",
  • "channelWidth5A": "string",
  • "channelWidth5H": "string",
  • "channelWidth5L": "string",
  • "channelWidth6": "string",
  • "powerSetting2": "string",
  • "powerSetting5A": "string",
  • "powerSetting5H": "string",
  • "powerSetting5L": "string",
  • "powerSetting6": "string",
  • "channelList5A": "string",
  • "channelList5H": "string",
  • "channelList5L": "string",
  • "channelList6": "string",
  • "channelDRM5A": true,
  • "channelDRM5H": true,
  • "channelDRM5L": true,
  • "channelDRM6": true,
  • "shortGuardInterval2": true,
  • "shortGuardInterval5A": true,
  • "shortGuardInterval5L": true,
  • "shortGuardInterval5H": true,
  • "shortGuardInterval6": true,
  • "minTXPower2": "string",
  • "minTXPower5A": "string",
  • "minTXPower5L": "string",
  • "minTXPower5H": "string",
  • "minTXPower6": "string",
  • "maxTXPower2": "string",
  • "maxTXPower5A": "string",
  • "maxTXPower5L": "string",
  • "maxTXPower5H": "string",
  • "maxTXPower6": "string",
  • "airtimeFairness2G": true,
  • "airtimeFairness5G": true,
  • "externalAntennasGain2": 0,
  • "externalAntennasGain5A": 0,
  • "externalAntennasGain5L": 0,
  • "externalAntennasGain5H": 0,
  • "externalAntennasGain6": 0,
  • "clientAwareness2": true,
  • "clientAwareness5A": true,
  • "clientAwareness5H": true,
  • "clientAwareness5L": true,
  • "clientAwareness6": true,
  • "muMimo2": true,
  • "muMimo5H": true,
  • "muMimo5A": true,
  • "muMimo5L": true,
  • "muMimo6": true,
  • "highEfficiency2": true,
  • "highEfficiency5L": true,
  • "highEfficiency5H": true,
  • "highEfficiency5A": true,
  • "highEfficiency6": true,
  • "beaconInterval2": 0,
  • "beaconInterval5A": 0,
  • "beaconInterval5L": 0,
  • "beaconInterval5H": 0,
  • "beaconInterval6": 0,
  • "csa2": true,
  • "csa5A": true,
  • "csa5H": true,
  • "csa5L": true,
  • "csa6": true,
  • "csaCount2": 0,
  • "csaCount5L": 0,
  • "csaCount5H": 0,
  • "csaCount5A": 0,
  • "csaCount6": 0,
  • "drmInterval": 0,
  • "drmStartTime": "string",
  • "drmTimeControl": true,
  • "radioSetting": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "RF Template has been successfully updated.",
  • "data": {
    }
}

Remove RF Templates By Names

This API allows you to remove RF Template by names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "RF Templates have been successfully removed.",
  • "data": [
    ]
}

Get all RF Templates and Assignments

This API allows you to get all RF Templates and Assignments for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "RF Templates have been partially removed.",
  • "data": [
    ]
}

Get all RF Templates (name only)

This API allows you to get all RF Template (name only) for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "RF Template(s) has been successfully fetched.",
  • "data": [
    ]
}

Get RF Template by Name

This API allows you to get an RF Template by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "RF Template(s) has been successfully fetched.",
  • "data": {
    }
}

Locationpolicy

Get all Location Policy

This API allows you to get all location policy for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Location Policy has been successfully fetched.",
  • "data": [
    ]
}

Create Location Policy

This API allows you to create a new location policy for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The object of the location policy.

Responses

Request samples

Content type
application/json
{
  • "locationPolicy": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Location Policy has been successfully created.",
  • "data": {
    }
}

Update Location Policy

This API allows you to update location policy for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The object of the location policy.

Responses

Request samples

Content type
application/json
{
  • "locationPolicy": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Location Policy has been successfully updated.",
  • "data": {
    }
}

Remove Location Policy By Names

This API allows you to remove location policy by names for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Location Policies have been successfully removed.",
  • "data": [
    ]
}

Get Location Policy by name

This API allows you to get location policy by name for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Location Policy has been successfully fetched.",
  • "data": {
    }
}

Remove Location Policy by name

This API allows you to remove location policy by name for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Location Policies have been successfully removed.",
  • "data": {
    }
}

Tunnel

Get all Tunnels

This API allows you to get all Tunnel for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Tunnel has been successfully fetched.",
  • "data": [
    ]
}

Create a Tunnel

This API allows you to create a Tunnel for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 tunnel.

Responses

Request samples

Content type
application/json
{
  • "tunnel": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Tunnel has been successfully created.",
  • "data": {
    }
}

Update Tunnel

This API allows you to update Tunnel for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 tunnel.

Responses

Request samples

Content type
application/json
{
  • "tunnel": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Tunnel has been successfully updated.",
  • "data": {
    }
}

Delete multiple Tunnels by names

This API allows you to delete multiple Tunnel by names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Tunnel has been successfully removed.",
  • "data": [
    ]
}

Get Tunnel by name

This API allows you to get a Tunnel by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Tunnel has been successfully fetched.",
  • "data": {
    }
}

Certificate

Get all certificates

This API allows you to get all certificate for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{}

Update certificate

This API allows you to update certificate for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{}

Create certificate

This API allows you to create certificate for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

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

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 samples

Content type
application/json
{}

Delete multiple certificates by names

This API allows you to delete multiple certificates by names for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Certificates have been successfully removed.",
  • "data": []
}

Download certificate

This API allows you to download certificate for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "name": "string"
}

Response samples

Content type
application/zip
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Get certificate by name

This API allows you to get certificate by name for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{}

Accessauthprofile

Get all Access Auth Profile

This API allows you to get all access auth profile for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Access Auth Profiles have been successfully fetched.",
  • "data": [
    ]
}

Update Access Auth Profile

This API allows you to update access auth profile for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "accessAuthProfile": {
    },
  • "assignments": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Access Auth Profile has been successfully updated.",
  • "data": {
    }
}

Create Access Auth Profile

This API allows you to create access auth profile for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "accessAuthProfile": {
    },
  • "configAssignment": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Access Auth Profile has been successfully created.",
  • "data": {
    }
}

Delete multiple Access Auth Profile

This API allows you to delete multiple access auth profile for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Access Auth Profiles have been successfully removed.",
  • "data": [
    ]
}

Get Access Auth Profile by id

This API allows you to get access auth profile by id for organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Access Auth Profile has been successfully fetched.",
  • "data": {
    }
}

Iotlocationserverprofile

Get all IOTLocationServerProfile

This API allows you to get all IOTLocationServerProfile for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "IOT Location Server Profile has been successfully fetched.",
  • "data": [
    ]
}

Update IOT Location Server Profile

This API allows you to update IOT Location Server Profile for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "engineType": "string",
  • "description": "string",
  • "host": "string",
  • "vendorPort": 0,
  • "port": 0,
  • "minimalReportingInterval": 0,
  • "unassociatedClientInfo": true,
  • "uploadAdvType": [
    ],
  • "rssiFormat": "string",
  • "name": "string",
  • "qoeEvents": [
    ],
  • "reportingInterval": 0,
  • "tlsSwitch": true,
  • "certificate": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "IOT Location Server Profile has been successfully updated.",
  • "data": {
    }
}

Create IOT Location Server Profile

This API allows you to create IOT Location Server Profile for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "engineType": "string",
  • "description": "string",
  • "host": "string",
  • "vendorPort": 0,
  • "port": 0,
  • "minimalReportingInterval": 0,
  • "unassociatedClientInfo": true,
  • "uploadAdvType": [
    ],
  • "rssiFormat": "string",
  • "name": "string",
  • "qoeEvents": [
    ],
  • "reportingInterval": 0,
  • "tlsSwitch": true,
  • "certificate": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "IOT Location Server Profile has been successfully created.",
  • "data": {
    }
}

Delete multiple IOT Location Server Profile By Names

This API allows you to delete multiple IOT Location Server Profile by names for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "IOT Location Server Profile has been successfully removed.",
  • "data": [
    ]
}

Get IOT Location Server Profile By Name

This API allows you to get all IOT Location Server Profile by name for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "IOT Location Server Profile has been successfully fetched.",
  • "data": {
    }
}

Get Kafka serverip/host and port

This API allows you to get Kafka serverip/host and port for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "IOT Location Server Profile has been successfully fetched.",
  • "data": {
    }
}

Ldap

Get all LDAP certificates

This API allows you to get all ldap certificates for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{}

Create LDAP certificate

This API allows you to create ldap certificate for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
string

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
string

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
string

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 samples

Content type
application/json
{}

Delete multiple LDAP certificates By Names

This API allows you to delete multiple ldap certificates by names for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "LDAP certificates have been successfully removed.",
  • "data": []
}

Download LDAP certificate

This API allows you to download ldap certificate for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "name": "string"
}

Response samples

Content type
application/x-tar
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Get LDAP certificate by name

This API allows you to get ldap certificate by name for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{}

Localradseccertificate

Get all Local RadSec certificates

This API allows you to get all Local RadSec certificates for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Local RadSec has been successfully fetched.",
  • "data": []
}

Create Local RadSec certificate

This API allows you to create Local RadSec certificate for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{}

Delete multiple Local RadSec certificates By Names

This API allows you to delete multiple Local RadSec certificates by names for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{}

Download Local RadSec Certificate

This API allows you to download Local RadSec certificate for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "name": "string"
}

Response samples

Content type
application/x-tar
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Vpnsetting

Create a VPN Setting.

This API is used to create a VPN Setting.

path Parameters
orgId
required
string

This is a path param for orgId

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
required
string

RAP Server IP.

manageRapVpnServerPort
required
string

RAP VPN port.

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "manageRapVpnServer": "string",
  • "manageRapVpnServerPort": "string",
  • "dataVpnServerIP": "string",
  • "ovEnterpriseServerIP": "string",
  • "tcpmss": "string",
  • "ipAddressPoolOption": "shorthandMask",
  • "networkIPAddress": "string",
  • "networkIPLength": "string",
  • "startIPRange": "string",
  • "endIPRange": "string",
  • "subnetMask": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The VPN Setting has been successfully created.",
  • "data": {
    }
}

Get all VPN Setting

This API is used to get all VPN Setting.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Setting(s) has been successfully fetched.",
  • "data": [
    ]
}

Delete VPN Settings

This API is used to delete VPN Settings.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Setting(s) has been successfully removed.",
  • "data": [
    ]
}

Update a VPN Setting.

This API is used to update a VPN Setting.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for 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 for the vpn setting attribute.

manageRapVpnServer
required
string

RAP Server IP.

manageRapVpnServerPort
required
string

RAP VPN port.

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "manageRapVpnServer": "string",
  • "manageRapVpnServerPort": "string",
  • "dataVpnServerIP": "string",
  • "ovEnterpriseServerIP": "string",
  • "tcpmss": "string",
  • "ipAddressPoolOption": "shorthandMask",
  • "networkIPAddress": "string",
  • "networkIPLength": "string",
  • "startIPRange": "string",
  • "endIPRange": "string",
  • "subnetMask": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Setting has been successfully updated.",
  • "data": {
    }
}

Get a VPN Setting

This API is used to get a VPN Setting.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Setting(s) has been successfully fetched.",
  • "data": {
    }
}

Export a VPN Setting

This API is used to export a VPN Setting.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Certificate has been successfully downloaded.",
  • "data": "VPNSetting.zip"
}

Vpnserver

Get all VPN Servers

This API allows you to get all VPN Servers for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Servers has been successfully fetched.",
  • "data": [
    ]
}

Update a VPN Server

This API allows you to update VPN Server for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
required
string

The server public IP 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
required
string

The server public port of the profile. Value in 1 - 65535.

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.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "autoPrivateKey": true,
  • "autoPublicKey": true,
  • "description": "string",
  • "endIp": "string",
  • "maskInt": "string",
  • "maskString": "string",
  • "maskType": "maskStr",
  • "serverPrivateKey": "string",
  • "serverPublicIp": "string",
  • "serverPublicKey": "string",
  • "serverPublicPort": "string",
  • "serverVpnIp": "string",
  • "startIp": "string",
  • "tcpMss": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Server has been successfully updated.",
  • "data": {
    }
}

Create a VPN Server

This API allows you to create VPN Server for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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
required
string

The server public IP 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
required
string

The server public port of the profile. Value in 1 - 65535.

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.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "autoPrivateKey": true,
  • "autoPublicKey": true,
  • "description": "string",
  • "endIp": "string",
  • "maskInt": "string",
  • "maskString": "string",
  • "maskType": "maskStr",
  • "serverPrivateKey": "string",
  • "serverPublicIp": "string",
  • "serverPublicKey": "string",
  • "serverPublicPort": "string",
  • "serverVpnIp": "string",
  • "startIp": "string",
  • "tcpMss": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "VPN Server has been successfully created.",
  • "data": {
    }
}

Delete multiple VPN Servers by ids

This API allows you to delete multiple VPN Servers by ids for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Servers have been successfully removed.",
  • "data": [
    ]
}

Export VPN Server by id

This API allows you to export VPN Server by id for organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "data": "test.conf"
}

Get VPN Server by id

This API allows you to get VPN Server by id for organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Servers has been successfully fetched.",
  • "data": {
    }
}

Get the details VPN Server by id

This API allows you to get the details VPN Server by id for organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "VPN Server has been successfully fetched.",
  • "data": {
    }
}

Get all VPN Servers by groups

This API allows you to get all VPN Servers by groups for organization.

path Parameters
orgId
required
string

This is a path param for orgId

Responses

Response samples

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

Switchconfigtemplate

Create Template.

This API allows to create Template in a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 template.

meta
object

The JSON metadata of the template.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Pre-provisioning Template has been successfully created.",
  • "data": {
    }
}

Get all Switch Config Template(s) by Organization

This API allows to get all Templates from organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Template(s) has been successfully fetched.",
  • "data": [
    ]
}

Remove Templates By Names

This API allows you to remove Templates by names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Template(s) has been successfully removed.",
  • "data": [
    ]
}

Create assign Incremental Configuration

This API allows to assign Incremental Configuration in a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 template.

meta
object

The JSON metadata of the template.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Incremental provisioning configuration has been successfully assigned.",
  • "data": [
    ]
}

Get Template by name

This API allows you to get Template by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

name
required
string

This is a path param for name

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Template(s) has been successfully fetched.",
  • "data": {
    }
}

Update Switch Config Template.

This API allows you to update Template for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

name
required
string

This is a path param for name

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 template.

meta
object

The JSON metadata of the template.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Template has been successfully updated.",
  • "data": {
    }
}

Valuemapping

Create Value Mapping

This API allows to create a new Value Mapping in a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 Value Mapping.

meta
object

The JSON metadata of the Value Mapping.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Pre-provisioning Value Mapping has been successfully created.",
  • "data": {
    }
}

Get all Value Mapping(s) by Organization

This API allows to get all Value Mapping from organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Value Mapping(s) has been successfully fetched.",
  • "data": {
    }
}

Remove Value Mapping By Names

This API allows you to remove Value Mapping by names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Value Mapping(s) has been successfully removed.",
  • "data": [
    ]
}

Get Value Mapping by name

This API allows you to get Value Mapping by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

name
required
string

This is a path param for name

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Value Mapping(s) has been successfully fetched.",
  • "data": {
    }
}

Update Value Mapping.

This API allows you to update Value Mapping for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

name
required
string

This is a path param for name

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
meta
object

The JSON metadata of the Value Mapping.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Value Mapping has been successfully updated.",
  • "data": {
    }
}

Get Value Mappings by template name

This API allows to get all Value Mapping from organization.

path Parameters
orgId
required
string

This is a path param for orgId

templateName
required
string

This is a path param for templateName

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Pre-provisioning Value Mapping(s) has been successfully fetched.",
  • "data": {
    }
}

Managementusertemplate

Get All Management User Template(s) by Organization

This API allows to get all Management User Template(s) from organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Management User Template(s) has been successfully fetched.",
  • "data": [
    ]
}

Create Management User Template

This API allows to create a new Management User Template in a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 Management User Template.

meta
object

The JSON metadata of the Management User Template.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Management User Template has been successfully created.",
  • "data": {
    }
}

Remove Management User Template(s)

This API allows you to remove Management User Template(s) by names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Management User Template(s) has been successfully removed.",
  • "data": [
    ]
}

Get Management User Template by name

This API allows you to get a Management User Template by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

name
required
string

This is a path param for name

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Management User Template(s) has been successfully fetched.",
  • "data": {
    }
}

Update Management User Template

This API allows you to update a Management User Template for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

name
required
string

This is a path param for name

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 Management User Template.

meta
object

The JSON metadata of the Management User Template.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Management User Template has been successfully updated.",
  • "data": {
    }
}

Resultsprovisioning

Get Provisioning Results.

This API allows you to get Provisioning Results for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Result provisioning configuration(s) has been successfully fetched.",
  • "data": [
    ]
}

Force Provisioning Configuration.

This API allows you to push a Provisioning Rule configuration to a matching switch the next time the switch contacts on the OmniVista Cirrus Server.

path Parameters
orgId
required
string

This is a path param for orgId

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 Force Provisioning.

meta
object

The JSON metadata of the Force Provisioning.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Force provisioning configuration(s) has been successfully updated.",
  • "data": [
    ]
}

Get Latest Provisioning configuration file.

This API allows you to get the latest Provisioning Configuration File contents was sent to the switch.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Latest Provisioning configuration file has been successfully fetched.",
  • "data": "user password-size min 8\nuser password-history 0\nuser password-min-age 0\nuser password-expiration disable\nuser password-policy min-uppercase 1\nuser password-policy min-lowercase 1\nuser password-policy min-digit 1\nuser password-policy min-nonalpha 1\nuser password-policy cannot-contain-username enable\naaa authentication ftp local\n"
}

Preprovisioningsetting

Get Pre Provisioning Setting.

This API allows you to get the Pre Provisioning Setting for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Setting pre provisioning configuration has been successfully fetched.",
  • "data": {
    }
}

Update Pre Provisioning Setting.

This API allows you to update the Pre Provisioning Setting for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 Pre Provisioning Setting.

meta
object

The JSON metadata of the Pre Provisioning Setting.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Setting pre provisioning configuration has been successfully updated.",
  • "data": {
    }
}

Provisioningtemplate

Get all Provisioning Templates by Org

This API allows to get all Provisioning Templates from organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Provisioning Templates have been successfully fetched.",
  • "data": [
    ]
}

Get Default Redirect Server Host by Org

This API allows you to get Default redirect server host for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The 'defaultRedirectProxyServerPort' have been successfully fetched.",
  • "data": "dev.portal.ovcirrus.com"
}

Get all Provisioning Templates by Site

This API allows to get all Provisioning Templates declared in one site

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Provisioning Templates have been successfully fetched.",
  • "data": [
    ]
}

Create Provisioning Template

This API allows to create a new Provisioning Template in a given organization, site

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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

Request samples

Content type
application/json
{
  • "provisioningTemplate": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Provisioning Template has been successfully created.",
  • "data": {
    }
}

Update Provisioning Template

This API allows to update Provisioning Template in a given organization, site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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

Request samples

Content type
application/json
{
  • "provisioningTemplate": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Provisioning Template has been successfully updated.",
  • "data": {
    }
}

Get all Provisioning Templates (name only) by Site

This API allows to get all Provisioning Template Names in a given organization, site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Provisioning Templates have been successfully fetched.",
  • "data": [
    ]
}

Get Provisioning Template by Name

This API allows you to get the Provisioning Template by Name for the site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Provisioning Template has been successfully fetched.",
  • "data": {
    }
}

Create Provisioning Template Default

This API allows you to create a new Provisioning Template Default for the site.

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
required
object

The JSON of Provisioning Configuration.

Responses

Request samples

Content type
application/json
{
  • "provisioningTemplate": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Provisioning Template has been successfully created.",
  • "data": {
    }
}

Create Assign Provisioning Template for AP Group

This API allows to assign Provisioning Template for AP Group identified by deviceGroupId

path Parameters
orgId
required
string

This is a path param for orgId

siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
required
object

The JSON of Provisioning Configuration.

Responses

Request samples

Content type
application/json
{
  • "assignment": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Provisioning Template has been successfully assigned.",
  • "data": {
    }
}

Delete multiple Provisioning Templates by ids

This API allows to deletion of multiple Provisioning Templates by ids in a given organization or site.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "sites": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Provisioning Templates have been successfully removed.",
  • "data": [
    ]
}

Unifiedpolicylist

Get all Unified Policies List And Assignments

This API allows you to get all unified policy list and assignments for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy list has been successfully fetched.",
  • "data": [
    ]
}

Get all Unified Policies List

This API allows you to get all unified policy list for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy list has been successfully fetched.",
  • "data": [
    ]
}

Update Unified Policies List

This API allows you to update unified policies list for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

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

Request samples

Content type
application/json
{
  • "assignments": [
    ],
  • "policyList": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy list has been successfully updated.",
  • "data": {
    }
}

Create Unified Policy List

This API allows you to create unified policy list for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
object

The Config Assignment of policy.

required
object

The JSON object of policy list.

Responses

Request samples

Content type
application/json
{
  • "assignment": {
    },
  • "policyList": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Unified policy list has been successfully created.",
  • "data": {
    }
}

Remove Unified Policy List

This API allows you to remove unified policy list for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

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

The ids of unified policy list

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy lists have been successfully removed.",
  • "data": [
    ]
}

Get Unified Policy List by name

This API allows you to get unified policy list by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy list has been successfully fetched.",
  • "data": {
    }
}

Get Unified Policy List by Id

This API allows you to get unified policy list by Id for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy list has been successfully fetched.",
  • "data": {
    }
}

Unifiedpolicy

Get all Unified Policies And Assignments

This API allows you to get all unified policies and assignments for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy has been successfully fetched.",
  • "data": [
    ]
}

Get all Unified Policies

This API allows you to get all unified policies for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy has been successfully fetched.",
  • "data": [
    ]
}

Update Unified Policy

This API allows you to update unified policy for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
required
object

The JSON object of policy

Array of objects or objects

The config assignments of the unified policy.

Responses

Request samples

Content type
application/json
{
  • "policy": {
    },
  • "assignments": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy has been successfully updated.",
  • "data": {
    }
}

Create Unified Policy

This API allows you to create a unified policy for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
required
object

The JSON object of policy

object

The Config Assignment of policy.

Responses

Request samples

Content type
application/json
{
  • "policy": {
    },
  • "assignment": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Unified policy has been successfully created.",
  • "data": {
    }
}

Delete multiple Unified Policy by ids

This API allows you to delete multiple unified policy by ids for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

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

An array ids of the unified policy.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policies have been successfully removed.",
  • "data": [
    ]
}

Get Unified Policy By Name

This API allows you to get unified policy by name for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy has been successfully fetched.",
  • "data": {
    }
}

Get Unified Policy By Id

This API allows you to get unified policy by id for organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Unified policy has been successfully fetched.",
  • "data": {
    }
}

Ssidschedule

Get SSID Schedule by SSID ID

This API allows you to get SSID Schedule by SSID Id for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

ssidId
required
string

This is a path param for ssidId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "message": "SSID Schedule has been successfully fetched.",
  • "status": 200,
  • "data": {
    }
}

Create SSID Schedules

This API allows you to create SSID Schedules for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "ssidName": "string",
  • "scheduleConfig": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "SSID Schedule has been successfully created.",
  • "status": 201,
  • "data": [
    ]
}

Delete SSID Schedules

This API allows you to delete SSID Schedules for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "ssidName": "string",
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "SSID Schedules have been successfully removed.",
  • "data": [
    ]
}

Periodpolicy

Get all Period Policy

This API allows you to get all period policy for organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "message": "Period Policy has been successfully fetched.",
  • "status": 200,
  • "data": [
    ]
}

Create Period Policy

This API allows you to create period policy for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "periodPolicy": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Period Policy has been successfully created.",
  • "status": 200,
  • "data": {
    }
}

Update Period Policy

This API allows you to update period policy for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "periodPolicy": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Period Policy has been successfully updated.",
  • "status": 200,
  • "data": {
    }
}

Remove Period Policy by names

This API allows you to remove period policy by names for organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "message": "Period Policies have been successfully removed.",
  • "status": 200,
  • "data": [
    ]
}

Get Period Policy by name

This API allows you to get period policy by name for organization.

path Parameters
orgId
required
string

This is a path param for orgId

query Parameters
name
required
string

The name of the period policy.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "message": "Period Policy has been successfully fetched.",
  • "status": 200,
  • "data": {
    }
}

Get Period Policy by Id

This API allows you to get period policy by id for organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "message": "Period Policy has been successfully fetched.",
  • "status": 200,
  • "data": {
    }
}

Remove Period Policy by id

This API allows you to remove period policy by id for organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "message": "Period Policy has been successfully removed.",
  • "status": 200,
  • "data": {
    }
}

Aaaprofile

Get all AAA Profiles

This API allows you to get all AAA Profiles for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Profiles have been successfully fetched.",
  • "data": [
    ]
}

Update AAA Profile

This API allows you to update an AAA Profile for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "aaaProfileVO": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Profile has been successfully updated.",
  • "data": {
    }
}

Create AAA Profile

This API allows you to create an AAA Profile for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "aaaProfileVO": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "AAA Profile has been successfully created.",
  • "data": {
    }
}

Delete multiple AAA Profiles by names

This API allows you to delete multiple AAA Profiles by names from a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Profiles have been successfully removed.",
  • "data": [
    ]
}

Get AAA Profile by id

This API allows you to get an AAA Profile by id for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Profile has been successfully fetched.",
  • "data": {
    }
}

Aaaserver

Get all AAA Servers

This API allows you to get all AAA Servers for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Servers have been successfully fetched.",
  • "data": [
    ],
  • "meta": {
    }
}

Update AAA Server

This API allows you to update the AAA Server for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The data of the AAA Server will be updated.

Responses

Request samples

Content type
application/json
{
  • "aaaServer": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Server has been successfully updated.",
  • "data": {
    }
}

Create AAA Server

This API allows you to create an AAA Server for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

The data of the AAA Server will be created.

Responses

Request samples

Content type
application/json
{
  • "aaaServer": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "AAA Server has been successfully created.",
  • "data": {
    }
}

Remove AAA Servers by names

This API allows you to remove AAA Server by names from a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Servers have been successfully removed.",
  • "data": [
    ]
}

Get AAA Servers by Type

This API allows you to get AAA Servers by type for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

type
required
string

This is a path param for type

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Server has been successfully fetched.",
  • "data": [
    ]
}

Get Invalid AAA Servers

This API allows you to get Invalid AAA Servers by the AAA Profile for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "aaaProfileName": "string",
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Invalid AAA Servers have been successfully fetched.",
  • "data": [
    ]
}

Get AAA Server By Name

This API allows you to get AAA Server by name for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "AAA Server has been successfully fetched.",
  • "data": {
    }
}

Piirequest

Retrieve all PII Requests for an organization

This API allows to get all pii requests performed on organization level.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "Personal identifiable information requests have been successfully fetched.",
  • "data": [
    ]
}

Activationserver

Create a Schedule

This API allows to create Schedule to upgrade sofware Device.

path Parameters
orgId
required
string

This is a path param for orgId

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" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

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

Request samples

Content type
application/json
{
  • "scheduleName": "string",
  • "cronExpression": "string",
  • "duration": 0,
  • "timezone": "Africa/Abidjan",
  • "scheduleType": "PERIODICALLY",
  • "siteId": "string",
  • "scheduledDevices": [
    ],
  • "groups": [
    ],
  • "startDate": "string",
  • "endDate": "string",
  • "fromApp": "DEVICE",
  • "enable": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The schedule has been successfully created.",
  • "data": {
    }
}

Get all schedule from organization

This API allows to fetch all schedule from organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": [
    ]
}

Delete multiple schedules

This API allows to delete mutiple schedules identified by there ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedules have been successfully deleted.",
  • "data": [
    ]
}

Update a schedule

This API allows to update one schedule identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

scheduledUpgradeId
required
string

This is a path param for scheduledUpgradeId

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" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

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

Request samples

Content type
application/json
{
  • "scheduleName": "string",
  • "cronExpression": "string",
  • "duration": 0,
  • "timezone": "Africa/Abidjan",
  • "scheduleType": "PERIODICALLY",
  • "siteId": "string",
  • "scheduledDevices": [
    ],
  • "groups": [
    ],
  • "startDate": "string",
  • "endDate": "string",
  • "fromApp": "DEVICE",
  • "enable": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule has been successfully updated.",
  • "data": {
    }
}

Get a schedule by id

This API allows to fetch one schedule identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

scheduledUpgradeId
required
string

This is a path param for scheduledUpgradeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": {
    }
}

Delete a schedule by id

This API allows to delete a schedule identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

scheduledUpgradeId
required
string

This is a path param for scheduledUpgradeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule has been successfully deleted.",
  • "data": {
    }
}

Execute a schedule

This API allows to execute one schedule identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

scheduledUpgradeId
required
string

This is a path param for scheduledUpgradeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule has been successfully updated.",
  • "data": {
    }
}

Deactivate the schedule upgrades

This API allows to deactivate multiple schedule upgrades identified by there ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule upgrades have been successfully deactivated.",
  • "data": [
    ]
}

Activate the schedule upgrades

This API allows to deactivate multiple schedule upgrades identified by there ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule upgrades have been successfully activated.",
  • "data": [
    ]
}

Update Scheduled Devices of the Schedule

This API allows to update Scheduled Devices of the Schedule identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

scheduledUpgradeId
required
string

This is a path param for scheduledUpgradeId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedules have been successfully updated.",
  • "data": {
    }
}

Update desired sw versions for schedule

This API allows to update desired sw versions for schedule.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedules have been successfully updated.",
  • "data": {
    }
}

Get the schedules by groups

This API allows to fetch the schedules by groups.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": [
    ]
}

Get the schedules by devices

This API allows to fetch the schedules by devices.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": [
    ]
}

Update setting of callhome interval global

This API allows to 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

Request samples

Content type
application/json
{
  • "callHomeIntervals": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The callHomeIntervalSettingGlobal has been successfully updated",
  • "data": {
    }
}

Get all settings of callhome interval global

This API allows to fetch alls setting of callhome interval global.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": {
    }
}

Update setting of callhome interval

This API allows to update setting of callhome interval.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "callHomeIntervals": {
    },
  • "useGlobalConfig": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The callHomeIntervalSetting has been successfully updated",
  • "data": {
    }
}

Get all settings of callhome interval

This API allows to fetch alls setting of callhome interval.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": {
    }
}

Retrieve networkId settings.

This API is used to get networkId settings.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": {
    }
}

Generate networkId settings.

This API is used to generate networkId settings.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "method": "string",
  • "suppliedKey": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The networkId has been successfully created.",
  • "data": "0xffb4f4ab81173447649f700ec8e14ea6a4"
}

Update strictMode in networkId setting

This API is used to update strictMode.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "strictMode": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The strictMode has been successfully updated.",
  • "data": {
    }
}

Get all assigned commands

This API allows to get all assigned commands in organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": [
    ]
}

Assign commands

This API allows to assign multiple troubleshooting commands in organization

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
deviceSerialNumbers
required
Array of any

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
{
  • "deviceSerialNumbers": [
    ],
  • "commandTimeToNextCallHome": "string",
  • "troubleshootingCmd": {
    }
}

Response samples

Content type
application/json
{
  • "status": 202,
  • "message": "The request to assign commands has been successfully sent."
}

Get all devices to assign commands

This API allows to get all devices to assign commands in organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": [
    ]
}

Get all troubleshooting commands

This API allows to get all troubleshooting commands from DataPond.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": [
    ]
}

License

Get all of licenses following orderId

This API allows to get all of licenses following orderId.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "orderId": "string",
  • "activationCode": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": [
    ]
}

Import licenses to organization

This API allows to link all of licenses following orderId to the organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "orderId": "string",
  • "activationCode": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Import the licenses successfully.",
  • "data": {
    }
}

Get licenses in organization

This API allows to get all of licenses which imported organization.

path Parameters
orgId
required
string

This is a path param for orgId

query Parameters
status
string

"status" is the status of license, ex: "Unlicensed"

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": [
    ]
}

Delete expired licenses in organization

This API allows to delete expired licenses in organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully deleted.",
  • "data": [
    ]
}

Bindings license to device

This API allows to binding licenses to devices.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Request Succeeded.",
  • "statusCode": 200,
  • "data": {
    }
}

Unbindings license to device

This API allows to unbinding licenses to devices.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "All Licenses have been successfully unbound to selected devices",
  • "data": [
    ]
}

Swap devices between 2 licenses

This API allows to swap devices between 2 licenses

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "firstLicense": {
    },
  • "secondLicense": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Swap devices between 2 licenses successfully.",
  • "data": [
    ]
}

Reassign device to new license.

This API allows to reassign device to new license.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "reassignDevice": {
    },
  • "newLicense": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Reassign the devices successfully.",
  • "data": {
    }
}

Reassign license to new device

This API allows to reassign licenses to devices.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "reassignLicense": {
    },
  • "newDevice": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Reassign the licenses successfully.",
  • "data": {
    }
}

Get the licenseMode

This API allows to get the license mode which is used to auto-binding.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": {
    }
}

Get the association between licenses and devices

This API allows to get association between licenses and devices.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "mode": "MANUAL_SELECTION",
  • "serialNumbers": [
    ],
  • "licenseMode": "EXPIRE_LAST"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully deleted.",
  • "data": [
    ]
}

Get the expired licenses from organization.

This API allows to get all of expired licenses from organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": [
    ]
}

Get the number of status in licenses from organization.

This API allows to get number of status in licenses from organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": {
    }
}

Get auto assign license from organization.

This API allows to get auto assign license from ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": {
    }
}

Update auto assign license from organization.

This API allows to update auto assign license from ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "isAutoAssignLicenseForNewDevice": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": {
    }
}

Import subscription licenses from the organization.

This API allows to import subsricption license from the ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "activationCode": "string",
  • "isAutoAssignLicenseForNewDevice": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Import the licenses successfully.",
  • "data": {
    }
}

Get all subscription licenses from the organization.

This API allows to get all subsricption license from ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": {
    }
}

Update license consumption for the devices.

This API allows to update subsricption license from the ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "deviceIdsToAssignLicense": [
    ],
  • "deviceIdsToReleaseLicense": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "The resource has been successfully updated.",
  • "statusCode": 200,
  • "data": {
    }
}

Get subscription license expiration from the organization.

This API allows to get all subsricption license expiration from ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": {
    }
}

Reload subscription licenses from the organization.

This API allows to reload subsricption license from the ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": {
    }
}

Add on subscription licenses from the organization.

This API allows to add on subsricption license from the ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": {
    }
}

Renew subscription licenses from the organization.

This API allows to renew subsricption license from the ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully updated.",
  • "data": {
    }
}

Get subscription licenses validation from the organization.

This API allows to get subsricption license validation from the ogranization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": [
    ]
}

Dynamicpgpskmodule

Get all Dynamic Private Group PSK profiles

This API is used to fetch all Dynamic Private Group PSK profiles inside a given Organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Dynamic Private Group PSK Profiles have been successfully fetched.",
  • "data": {
    }
}

Create Dynamic Private Group PSK profile

This API is used to create Dynamic Private Group PSK profile.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "profileName": "string",
  • "persistencyDays": 0,
  • "pskItems": [
    ],
  • "ssid": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Dynamic Private Group PSK Profile have been successfully created.",
  • "data": {
    }
}

Delete Multiple Dynamic Private Group PSK profiles by IDs

This API is used to delete multiple Dynamic Private Group PSK profiles by it's IDs.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Dynamic Private Group PSK Profile have been successfully deleted.",
  • "data": [
    ]
}

Get Dynamic Private Group PSK profile by ID

This API is used to fetch Dynamic Private Group PSK profile by it's ID.

path Parameters
orgId
required
string

This is a path param for orgId

profileId
required
string

This is a path param for profileId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Dynamic Private Group PSK Profile have been successfully fetched.",
  • "data": {
    }
}

Update Dynamic Private Group PSK profile by ID

This API is used to update the values of Dynamic Private Group PSK profile by ID.

path Parameters
orgId
required
string

This is a path param for orgId

profileId
required
string

This is a path param for profileId

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

Request samples

Content type
application/json
{
  • "persistencyDays": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Dynamic Private Group PSK Profile have been successfully updated.",
  • "data": {
    }
}

Update Dynamic Private Group PSK Items

This API is used to update the values of Dynamic Private Group PSK Items.

path Parameters
orgId
required
string

This is a path param for orgId

profileId
required
string

This is a path param for profileId

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

Request samples

Content type
application/json
{
  • "deleteExistingItems": [
    ],
  • "updateExistingItems": [
    ],
  • "addNewItems": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Dynamic Private Group PSK Profile have been successfully updated.",
  • "data": {
    }
}

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.

path Parameters
orgId
required
string

This is a path param for orgId

profileId
required
string

This is a path param for profileId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "samp.server.getList.success",
  • "data": {
    }
}

Get all Dynamic Private Group MACs

This API is used to fetch all Dynamic Private Group MACs inside a given Organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Dynamic Private Group MAC Profiles have been successfully fetched.",
  • "data": {
    }
}

Delete Multiple Dynamic Private Group MACs by IDs

This API is used to delete multiple Dynamic Private Group MACs by it's IDs.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Dynamic Private Group MAC Profile have been successfully deleted.",
  • "data": [
    ]
}

Get Dynamic Private Group MAC by ID

This API is used to fetch Dynamic Private Group MAC by it's ID.

path Parameters
orgId
required
string

This is a path param for orgId

uuid
required
string

This is a path param for uuid

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Dynamic Private Group MAC Profile have been successfully fetched.",
  • "data": {
    }
}

Employeeaccount

Get all employee accounts

This API is used to get all employee accounts within an organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The employee accounts have been successfully fetched.",
  • "data": {
    }
}

Create an employee account

This API is used to create an employee account.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "username": "string",
  • "telephone": "string",
  • "email": "string",
  • "password": "string",
  • "fullName": "string",
  • "department": "string",
  • "position": "string",
  • "description": "string",
  • "arpName": "string",
  • "plName": "string",
  • "otherAttributesVOs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The employee account has been successfully created.",
  • "data": {
    }
}

Delete multiple employee accounts

This API is used to delete multiple employee accounts by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The employee accounts have been successfully deleted.",
  • "data": [
    ]
}

Get an employee account

This API is used to get an employee account by Id.

path Parameters
orgId
required
string

This is a path param for orgId

employeeAccountId
required
string

This is a path param for employeeAccountId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The employee account has been successfully fetched.",
  • "data": {
    }
}

Update an employee account

This API is used to update an employee account by id.

path Parameters
orgId
required
string

This is a path param for orgId

employeeAccountId
required
string

This is a path param for employeeAccountId

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

Request samples

Content type
application/json
{
  • "telephone": "string",
  • "email": "string",
  • "password": "string",
  • "fullName": "string",
  • "department": "string",
  • "position": "string",
  • "description": "string",
  • "arpName": "string",
  • "plName": "string",
  • "otherAttributesVOs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The employee account has been successfully updated.",
  • "data": {
    }
}

Mass import employee accounts

This API allows to mass import employee accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The employee accounts have been successfully created.",
  • "data": [
    ]
}

Update status for multiple employee accounts

This API is used to update status for multiple employee accounts by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "status": "ENABLED",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The employee accounts have been successfully updated.",
  • "data": [
    ]
}

Get employee accounts global configuration

This API is used to get employee accounts global configuration for a given organisation.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The employee account global configuration has been successfully fetched.",
  • "data": {
    }
}

Update or set employee accounts global configuration

This API is used to update or set employee accounts global configuration for a given organisation.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "passwordEnforcement": "string",
  • "usernamePolicy": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The employee account global configuration has been successfully updated.",
  • "data": {
    }
}

Rolemapping

Create a role mapping

This API is used to create a role mapping.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "priority": 0,
  • "action": "accept",
  • "mappingARPName": "string",
  • "mappingPLName": "string",
  • "conditions": [
    ],
  • "otherAttributesVOs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The role mapping has been successfully created.",
  • "data": {
    }
}

Get all roles mappings

This API is used to get all roles mappings.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The role Mappings have been successfully fetched.",
  • "data": {
    }
}

Delete multiple roles mappings

This API is used to delete multiple roles mappings by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The role mappings have been successfully deleted.",
  • "data": [
    ]
}

Get a role mapping

This API is used to get a role mapping by Id.

path Parameters
orgId
required
string

This is a path param for orgId

roleMappingId
required
string

This is a path param for roleMappingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The role mapping has been successfully fetched.",
  • "data": {
    }
}

Update a role mapping

This API is used to update a role mapping by id.

path Parameters
orgId
required
string

This is a path param for orgId

roleMappingId
required
string

This is a path param for roleMappingId

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

Request samples

Content type
application/json
{
  • "priority": 0,
  • "action": "accept",
  • "mappingARPName": "string",
  • "mappingPLName": "string",
  • "conditions": [
    ],
  • "otherAttributesVOs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The role mapping has been successfully updated."
}

Radiusservercertificate

Create a radius server certificate

This API allows to add a new radius server certificates.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 201,
  • "message": "The External Radius server has been successfully created.",
  • "data": {
    }
}

Delete multiple radius server certificates by their ids

This API allows to Delete multiple radius server certificates.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The RADIUS server certificates have been successfully deleted.",
  • "data": [
    ]
}

Get all the radius server certificates

This API allows to fetch all the radius server certificates.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The radius server certificates have been successfully fetched.",
  • "data": {
    }
}

Get a radius server certificate by Id

This API allows to fetch a radius server certificate.

path Parameters
orgId
required
string

This is a path param for orgId

certificateId
required
string

This is a path param for certificateId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The radius server certificate has been successfully fetched.",
  • "data": {
    }
}

Activate a radius server certificate

This API allows to activate a radius server certificate.

path Parameters
orgId
required
string

This is a path param for orgId

certificateId
required
string

This is a path param for certificateId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Radius server certificate has been successfully activated.",
  • "data": {
    }
}

Registrationprofile

Get all registration profiles.

This API is used to get all registration profiles.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Registration Profile has been successfully fetched.",
  • "data": [
    ]
}

Add a new Registration Profile

This API allows to add a new Registration Profile.

path Parameters
orgId
required
string

This is a path param for orgId

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
boolean
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

Request samples

Content type
application/json
{
  • "description": "string",
  • "dataQuotaStatus": "ENABLED",
  • "timeQuotaStatus": "ENABLED",
  • "timeQuotaMode": "string",
  • "hourQuotaPerDayAmount": 0,
  • "hourQuotaBeforeBlocked": 0,
  • "blockedHours": 0,
  • "maxRememberedDevice": 0,
  • "reducedUpBandwidth": 0,
  • "reducedDownBandwidth": 0,
  • "dataQuotaUrl": "string",
  • "dataQuota": 0,
  • "periodUnit": "Day(s)",
  • "deviceRemember": "ENABLED",
  • "deviceValidityPeriod": 0,
  • "profileName": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Registration Profile has been successfully created.",
  • "data": {
    }
}

Delete multiple Registration Profiles by their ids

This API allows to Delete multiple Registration Profiles.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Get registration profile by id

This API is used to get registration profile by id.

path Parameters
orgId
required
string

This is a path param for orgId

registrationProfileId
required
string

This is a path param for registrationProfileId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Registration Profile has been successfully fetched.",
  • "data": {
    }
}

Update Registration Profile by their id

This API allows to update a Registration Profile by its ID.

path Parameters
orgId
required
string

This is a path param for orgId

registrationProfileId
required
string

This is a path param for registrationProfileId

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
boolean
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

Request samples

Content type
application/json
{
  • "description": "string",
  • "dataQuotaStatus": "ENABLED",
  • "timeQuotaStatus": "ENABLED",
  • "timeQuotaMode": "string",
  • "hourQuotaPerDayAmount": 0,
  • "hourQuotaBeforeBlocked": 0,
  • "blockedHours": 0,
  • "maxRememberedDevice": 0,
  • "reducedUpBandwidth": 0,
  • "reducedDownBandwidth": 0,
  • "dataQuotaUrl": "string",
  • "dataQuota": 0,
  • "periodUnit": "Day(s)",
  • "deviceRemember": "ENABLED",
  • "deviceValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Registration Profile has been successfully updated.",
  • "data": {
    }
}

Externalradiusserver

Get external RADIUS Server by id

This API is used to get external RADIUS Server by id.

path Parameters
orgId
required
string

This is a path param for orgId

externalRadiusServerId
required
string

This is a path param for externalRadiusServerId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The external radius server has been successfully fetched.",
  • "data": {
    }
}

Update external RADIUS Server by their id

This API allows to update a external RADIUS Server by its ID.

path Parameters
orgId
required
string

This is a path param for orgId

externalRadiusServerId
required
string

This is a path param for externalRadiusServerId

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

Request samples

Content type
application/json
{
  • "hostName": "string",
  • "backupHostName": "string",
  • "retries": 0,
  • "timeout": 0,
  • "isRadSecServer": true,
  • "sharedSecret": "string",
  • "confirmSecret": "string",
  • "authenticationPort": 0,
  • "accountingPort": 0,
  • "isPreemptionEnabled": true,
  • "preemptionTimeout": 0,
  • "radSecCertificateId": "string",
  • "radSecTrustCaId": "string",
  • "tlsPort": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The external radius server have been successfully updated.",
  • "data": {
    }
}

Get all external RADIUS Servers.

This API is used to get all external RADIUS Servers.

path Parameters
orgId
required
string

This is a path param for orgId

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The external radius server have been successfully fetched.",
  • "data": {
    }
}

Add a new external RADIUS Server

This API allows to add a new external RADIUS Server.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "serverName": "string",
  • "hostName": "string",
  • "backupHostName": "string",
  • "retries": 0,
  • "timeout": 0,
  • "isRadSecServer": true,
  • "sharedSecret": "string",
  • "confirmSecret": "string",
  • "authenticationPort": 0,
  • "accountingPort": 0,
  • "isPreemptionEnabled": true,
  • "preemptionTimeout": 0,
  • "radSecCertificateId": "string",
  • "radSecTrustCaId": "string",
  • "tlsPort": 0
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The external radius server has been successfully created.",
  • "data": {
    }
}

Delete multiple external RADIUS Servers by their ids

This API allows to Delete multiple external RADIUS Servers.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The external radius servers have been successfully deleted.",
  • "data": [
    ]
}

Get all RadSec Client certificates

This API allows to get all Radsec Client Certificate.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The RadSec Client Certificats has been successfully fetched.",
  • "data": {
    }
}

Delete multiple RadSec Client certificates

This API is used to delete multiple RadSec Client certificates by providing in the body, a list of RadSec Client certificate ids

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The RadSec Client Certificats have been successfully deleted.",
  • "data": [
    ]
}

Create a RadSec Client Certificate

This API is used to upload all the RadSec client certificate files

path Parameters
orgId
required
string

This is a path param for orgId

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
string

The serveur certificate file name.

caFiles
required
string

The certificate of the radius server.

password
required
string

The password of the radius server.

keyFile
required
string

The key file of the radius server.

Responses

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The RadSec Client Certificat has been successfully created.",
  • "data": {
    }
}

Download a RadSec Client Certificate by Id

This API is used to download all the files (cAFiles, serverKeyFile , serverFile) of a certificate ziped.

path Parameters
orgId
required
string

This is a path param for orgId

certificatId
required
string

This is a path param for certificatId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/zip
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Cloudidentity

Get Cloud Identity by id

This API is used to get Cloud Identity by id.

path Parameters
orgId
required
string

This is a path param for orgId

serverId
required
string

This is a path param for serverId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Cloud Identity has been successfully fetched.",
  • "data": {
    }
}

Update a Cloud Identity by id

This API is used to update a Cloud Identity by id.

path Parameters
orgId
required
string

This is a path param for orgId

serverId
required
string

This is a path param for serverId

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

Request samples

Content type
application/json
{
  • "identityName": "string",
  • "identityProvider": "Azure",
  • "identityClientId": "string",
  • "identityClientSecret": "string",
  • "identityTenantId": "string",
  • "identityUsernameSuffix": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Cloud Identity have been successfully updated.",
  • "data": {
    }
}

Get all Cloud Identity

This API allows to fetch all Cloud Identity.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Cloud Identity have been successfully fetched.",
  • "data": [
    ]
}

Add a new Cloud Identity

This API allows to add a new Cloud Identity.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "identityName": "string",
  • "identityProvider": "Azure",
  • "identityClientId": "string",
  • "identityClientSecret": "string",
  • "identityTenantId": "string",
  • "identityUsernameSuffix": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Cloud Identity has been successfully created.",
  • "data": {
    }
}

Delete multiple Cloud Identities by their ids

This API allows to Delete multiple Cloud Identities.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Ldapattribute

Create a LDAP attribute.

This API is used to create an LDAP attribute.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The LDAP attribute has been successfully created.",
  • "data": {
    }
}

Get all LDAP attributes

This API is used to get all LDAP attributes.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The LDAP attributes have been successfully fetched.",
  • "data": {
    }
}

Delete multiple LDAP attributes

This API is used to delete multiple LDAP attribute by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The LDAP attributes have been successfully deleted.",
  • "data": [
    ]
}

Create multiples LDAP attributes

This API is used to create many LDAP attributes by names.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The LDAP attributes have been successfully fetched.",
  • "data": [
    ]
}

Get a LDAP attribute

This API is used to get an LDAP attribute by Id.

path Parameters
orgId
required
string

This is a path param for orgId

ldapAttributeId
required
string

This is a path param for ldapAttributeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The LDAP attribute has been successfully fetched.",
  • "data": {
    }
}

Guestaccount

Get all guest accounts

This API is used to get all guest accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully fetched.",
  • "data": {
    }
}

Create a guest account

This API is used to create a guest account.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "accountValidityPeriod": 0,
  • "company": "string",
  • "description": "string",
  • "email": "string",
  • "fullName": "string",
  • "telephone": "string",
  • "registrationProfile": "string",
  • "serviceLevel": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest account has been successfully created.",
  • "data": {
    }
}

Delete Mulitiple guest accounts

This API is used to delete multiple guest accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully deleted.",
  • "data": [
    ]
}

Create guests account in batch mode

This API is used to create guest accounts in batch mode.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "accountPrefix": "string",
  • "clientNumber": 0,
  • "registrationProfile": "string",
  • "serviceLevel": "string",
  • "accountValidityPeriod": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest accounts have been successfully created.",
  • "data": [
    ]
}

Mass import of guest accounts

This API is used to mass import guest accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest accounts have been successfully created.",
  • "data": [
    ]
}

Get a guest account by id

This API is used to get a guest account by id

path Parameters
orgId
required
string

This is a path param for orgId

guestAccountId
required
string

This is a path param for guestAccountId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest account has been successfully fetched.",
  • "data": {
    }
}

Update a guest account

This API is used to update a guest account by id.

path Parameters
orgId
required
string

This is a path param for orgId

guestAccountId
required
string

This is a path param for guestAccountId

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

Request samples

Content type
application/json
{
  • "password": "string",
  • "company": "string",
  • "description": "string",
  • "email": "string",
  • "fullName": "string",
  • "telephone": "string",
  • "registrationProfile": "string",
  • "serviceLevel": "string",
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest account has been successfully updated.",
  • "data": {
    }
}

Update status for multiple guest accounts

This API is used to update status for multiple guest accounts by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "status": "ENABLED",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully updated.",
  • "data": [
    ]
}

Extend guests account

This API is used to extend guest accounts validity and data quota amount.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "idList": [
    ],
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully extended.",
  • "data": {
    }
}

Extend guest accounts for guest operators

This API is used to extend guest accounts validity and data quota amount for guest operators.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "idList": [
    ],
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully extended.",
  • "data": {
    }
}

Get guest access global configuration

This API is used to get guest access global configuration.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access global configuration has been successfully fetched.",
  • "data": {
    }
}

Update guest access global configuration

This API is used to update guest access global configuration.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "batchCreation": "string",
  • "accountPrefix": "string",
  • "accountValidityPeriod": 0,
  • "periodUnit": "Day(s)",
  • "deletePolicy": 0,
  • "effectiveFirstLogin": "string",
  • "accessCodeLength": 0,
  • "passwordEnforcement": "string",
  • "usernamePolicy": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access global configuration has been successfully updated.",
  • "data": {
    }
}

Get all guest accounts

This API is used by guest operator to get all guest accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully fetched.",
  • "data": {
    }
}

Create a guest account for guest operator

This API is used by guest operator to create a guest account.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "accountValidityPeriod": 0,
  • "company": "string",
  • "description": "string",
  • "email": "string",
  • "fullName": "string",
  • "telephone": "string",
  • "registrationProfile": "string",
  • "serviceLevel": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest account has been successfully created.",
  • "data": {
    }
}

Delete Mulitiple guest accounts for guest operator

This API is used by guest operator to delete multiple guest accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully deleted.",
  • "data": [
    ]
}

Get a guest account by id for guest operator

This API is used by guest operator to get a guest account by id

path Parameters
orgId
required
string

This is a path param for orgId

guestAccountId
required
string

This is a path param for guestAccountId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest account has been successfully fetched.",
  • "data": {
    }
}

Update a guest account for guest operator

This API is used by guest operator to update a guest account by id.

path Parameters
orgId
required
string

This is a path param for orgId

guestAccountId
required
string

This is a path param for guestAccountId

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

Request samples

Content type
application/json
{
  • "password": "string",
  • "company": "string",
  • "description": "string",
  • "email": "string",
  • "fullName": "string",
  • "telephone": "string",
  • "registrationProfile": "string",
  • "serviceLevel": "string",
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest account has been successfully updated.",
  • "data": {
    }
}

Create guests account in batch mode for guest operator

This API is used by guest operator to create guest accounts in batch mode.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "accountPrefix": "string",
  • "clientNumber": 0,
  • "registrationProfile": "string",
  • "serviceLevel": "string",
  • "accountValidityPeriod": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest accounts have been successfully created.",
  • "data": [
    ]
}

Mass import of guest accounts for guest operator

This API is used by guest operator to mass import guest accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest accounts have been successfully created.",
  • "data": [
    ]
}

Get all service levels

This API is used to get all service levels.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The service levels have been successfully fetched.",
  • "data": {
    }
}

Create a service level

This API is used to create a service level.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "description": "string",
  • "periodUnit": "Day(s)",
  • "accountValidityPeriod": 0,
  • "deletePolicy": 0,
  • "registrationProfile": "string",
  • "arpName": "string",
  • "plName": "string",
  • "otherAttributes": [
    ],
  • "serviceName": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The service level has been successfully created.",
  • "data": {
    }
}

Delete multiple service levels

This API is used to delete multiple service levels.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The service levels have been partially deleted.",
  • "data": [
    ]
}

Get service level by id.

This API is used to get service level by id.

path Parameters
orgId
required
string

This is a path param for orgId

servicelevelId
required
string

This is a path param for servicelevelId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The service levels names has been successfully fetched.",
  • "data": {
    }
}

Get service levels names.

This API is used to get service levels names.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The service levels names has been successfully fetched.",
  • "data": [
    ]
}

Update a service level

This API is used to update a service level by id.

path Parameters
orgId
required
string

This is a path param for orgId

serviceLevelId
required
string

This is a path param for serviceLevelId

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

Request samples

Content type
application/json
{
  • "description": "string",
  • "periodUnit": "Day(s)",
  • "accountValidityPeriod": 0,
  • "deletePolicy": 0,
  • "registrationProfile": "string",
  • "arpName": "string",
  • "plName": "string",
  • "otherAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The service level has been successfully updated.",
  • "data": {
    }
}

Guestaccesscode

Get all guest access codes

This API is used to get all guest access codes.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access codes have been successfully fetched.",
  • "data": {
    }
}

Create a guest access code

This API is used to create a guest access code.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "accessCode": "string",
  • "accountValidityPeriod": 0,
  • "serviceLevel": "string",
  • "registrationProfile": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest access code has been successfully created.",
  • "data": {
    }
}

Delete multiple guest access codes

This API is used to delete multiple guest accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully deleted.",
  • "data": [
    ]
}

Get guest access code by id

This API is used to get guest access code by id.

path Parameters
orgId
required
string

This is a path param for orgId

guestAccessCodeId
required
string

This is a path param for guestAccessCodeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access code has been successfully fetched.",
  • "data": {
    }
}

Update a guest access code

This API is used to update a guest access code.

path Parameters
orgId
required
string

This is a path param for orgId

guestAccessCodeId
required
string

This is a path param for guestAccessCodeId

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

Request samples

Content type
application/json
{
  • "serviceLevel": "string",
  • "registrationProfile": "string",
  • "description": "string",
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access code has been successfully updated.",
  • "data": {
    }
}

Mass import of guest access codes

This API is used to mass import guest access codes.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest access codes have been successfully created.",
  • "data": [
    ]
}

Create guest access codes in batch mode

This API is used to create guest access codes in batch mode.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "serviceLevel": "string",
  • "registrationProfile": "string",
  • "description": "string",
  • "clientNumber": 0,
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest access codes have been successfully created.",
  • "data": [
    ]
}

Update status for multiple guest access codes

This API is used to update status for multiple guest access codes by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "status": "ENABLED",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access codes have been successfully updated.",
  • "data": [
    ]
}

Extend guest access codes

This API is used to extend guest access codes validity period.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "idList": [
    ],
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access codes have been successfully extended.",
  • "data": [
    ]
}

Extend guest access codes for guest operators

This API is used to extend guest access codes validity period.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "idList": [
    ],
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access codes have been successfully extended.",
  • "data": [
    ]
}

Get all guest access codes for guest operator

This API is used by guest operator to get all guest access codes.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access codes have been successfully fetched.",
  • "data": {
    }
}

Create a guest access code for guest operator

This API is used by guest operator to get a guest access code by Id.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "accessCode": "string",
  • "accountValidityPeriod": 0,
  • "serviceLevel": "string",
  • "registrationProfile": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest access code has been successfully created.",
  • "data": {
    }
}

Delete multiple guest access codes for guest operator

This API is used by guest operator to delete multiple guest accounts.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest accounts have been successfully deleted.",
  • "data": [
    ]
}

Get guest access code by id for guest operator

This API is used by guest operator to get guest access code by id.

path Parameters
orgId
required
string

This is a path param for orgId

guestAccessCodeId
required
string

This is a path param for guestAccessCodeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access code has been successfully fetched.",
  • "data": {
    }
}

Update a guest access code for guest operator

This API is used by guest operator to update a guest access code.

path Parameters
orgId
required
string

This is a path param for orgId

guestAccessCodeId
required
string

This is a path param for guestAccessCodeId

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

Request samples

Content type
application/json
{
  • "serviceLevel": "string",
  • "registrationProfile": "string",
  • "description": "string",
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access code has been successfully updated.",
  • "data": {
    }
}

Mass import of guest access codes for guest operator

This API is used by guest operator to mass import guest access codes.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest access codes have been successfully created.",
  • "data": [
    ]
}

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.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "serviceLevel": "string",
  • "registrationProfile": "string",
  • "description": "string",
  • "clientNumber": 0,
  • "accountValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest access codes have been successfully created.",
  • "data": [
    ]
}

Guestconfiguration

Get guest ticket template configuration

This API is used to get guest ticket template configuration.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access global configuration has been successfully fetched.",
  • "data": {
    }
}

Update guest ticket template configuration

This API is used to update guest ticket template configuration.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "header": "string",
  • "footer": "string",
  • "logoUrl": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access global configuration has been successfully updated.",
  • "data": {
    }
}

Selfregistrationrequests

Get all guest access self registration requests

This API is used to get all guest access self registration requests.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The self registration requests have been successfully fetched.",
  • "data": {
    }
}

Approve or reject guest access self registration requests

This API is used to approve or reject guest access self registration requests by ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "status": "APPROVED"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The self registration requests have been successfully updated.",
  • "data": [
    ]
}

Delete guest access self registration requests

This API is used to delete guest access self registration requests by ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The self registration requests have been successfully deleted.",
  • "data": [
    ]
}

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.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The self registration requests have been successfully fetched.",
  • "data": {
    }
}

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.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The self registration requests have been successfully deleted.",
  • "data": [
    ]
}

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.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The self registration requests have been successfully updated.",
  • "data": [
    ]
}

Collectsupportinfo

Create Collect Support Info for AP/Switch

This API allows to create collect support information for AP/Switch

path Parameters
orgId
required
string

This is a path param for orgId

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.

required
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

Request samples

Content type
application/json
{
  • "macAddress": "string",
  • "siteId": "string",
  • "type": "string",
  • "serialNumber": "string",
  • "switchDetails": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Collect support info request have been successfully sent.",
  • "data": {
    }
}

Retrieve Collect Support Info for AP/Switch

This API allows to retrieve collect support information for AP/Switch.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Collect support info have been successfully fetched.",
  • "data": [
    ]
}

Delete Collect Support Info for AP/Switch

This API allows to delete collect support information for AP/Switch.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Collect support info request have been successfully deleted.",
  • "data": {
    }
}

Accesspolicy

Get all access policies

This API is used to get all access policies.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The access policies have been successfully fetched.",
  • "data": {
    }
}

Create an access policy

This API is used to create an access policy.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "strategyName": "string",
  • "authenticationAgainst": "None",
  • "serverName": "string",
  • "priority": 0,
  • "conditions": [
    ],
  • "otherAttributesVOs": [
    ],
  • "macCheckEnforcement": {
    },
  • "conditionDemo": 0,
  • "guestStrategy": "string",
  • "byodStrategy": "string",
  • "webAuthentication": "Guest",
  • "defaultARPName": "string",
  • "defaultPLName": "string",
  • "eapTypeRestriction": "DISABLED",
  • "eapType": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The access policy has been successfully created.",
  • "data": {
    }
}

Delete multiple access policies

This API is used to delete multiple access policies.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The access policies have been successfully deleted.",
  • "data": [
    ]
}

Update an access policy

This API is used to update an access policy.

path Parameters
orgId
required
string

This is a path param for orgId

accessPolicyId
required
string

This is a path param for accessPolicyId

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

Request samples

Content type
application/json
{
  • "authenticationAgainst": "None",
  • "serverName": "string",
  • "priority": 0,
  • "conditions": [
    ],
  • "otherAttributesVOs": [
    ],
  • "macCheckEnforcement": {
    },
  • "conditionDemo": 0,
  • "guestStrategy": "string",
  • "byodStrategy": "string",
  • "webAuthentication": "Guest",
  • "defaultARPName": "string",
  • "defaultPLName": "string",
  • "eapTypeRestriction": "DISABLED",
  • "eapType": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The access policy has been successfully updated.",
  • "data": {
    }
}

Get an access policy.

This API is used to get an access policy by Id.

path Parameters
orgId
required
string

This is a path param for orgId

accessPolicyId
required
string

This is a path param for accessPolicyId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The access policy has been successfully fetched.",
  • "data": {
    }
}

Guestaccessstrategy

Get guest access strategies

This API is used to get guest access strategies.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access strategies have been successfully fetched.",
  • "data": {
    }
}

Create a guest access strategy

This API is used to create a guest access strategy.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "strategyName": "string",
  • "redirectionStrategy": "string",
  • "protocolMode": "HTTPS",
  • "fqdnMode": "FQDN",
  • "authenticationResource": "string",
  • "selfRegistrationStrategy": {
    },
  • "postAuthenticationEnforcement": {
    },
  • "loginStrategy": {
    },
  • "socialLoginProfileVo": {
    },
  • "wifi4EUSwitch": "DISABLED",
  • "selfTestModus": "string",
  • "networkIdentifier": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest access strategy has been successfully created.",
  • "data": {
    }
}

Delete multiple guest access strategies

This API is used to delete multiple guest access strategies by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access strategies have been successfully deleted.",
  • "data": [
    ]
}

Get a guest access strategy

This API is used to get a single guest access strategy indetified by id.

path Parameters
orgId
required
string

This is a path param for orgId

guestAccessStrategyId
required
string

This is a path param for guestAccessStrategyId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access strategy has been successfully fetched.",
  • "data": {
    }
}

Update a guest access strategy

This API is used to update a guest access strategy by id.

path Parameters
orgId
required
string

This is a path param for orgId

guestStrategyId
required
string

This is a path param for guestStrategyId

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

Request samples

Content type
application/json
{
  • "redirectionStrategy": "string",
  • "protocolMode": "HTTPS",
  • "fqdnMode": "FQDN",
  • "authenticationResource": "string",
  • "selfRegistrationStrategy": {
    },
  • "postAuthenticationEnforcement": {
    },
  • "loginStrategy": {
    },
  • "socialLoginProfileVo": {
    },
  • "wifi4EUSwitch": "DISABLED",
  • "selfTestModus": "string",
  • "networkIdentifier": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access strategy has been successfully updated.",
  • "data": {
    }
}

Guestemailsmstemplate

Get all SMS or Email template guest access strategy

This API is used to get all SMS or Email template guest access strategy requests.

path Parameters
orgId
required
string

This is a path param for orgId

query Parameters
type
string

Choice the type of template ("SMS" or "EMAIL") to select

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access strategy email or sms templates has been successfully fetched.",
  • "data": [
    ]
}

Get one SMS or Email template guest access strategy

This API is used to get one SMS or Email template guest access strategy by Id.

path Parameters
orgId
required
string

This is a path param for orgId

templateId
required
string

This is a path param for templateId

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access strategy email or sms template has been successfully fetched.",
  • "data": {
    }
}

Update a SMS or a Email template guest access strategy

This API is used to update a SMS or a Email template guest access strategy by id.

path Parameters
orgId
required
string

This is a path param for orgId

templateType
required
string

This is a path param for templateType

templateId
required
string

This is a path param for templateId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest access strategy email or sms template has been successfully updated.",
  • "data": null
}

Companyproperty

Get all company properties.

This API is used to get all company properties.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The company properties have been successfully fetched.",
  • "data": {
    }
}

Create a company property.

This API is used to create a company property.

path Parameters
orgId
required
string

This is a path param for orgId

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
required
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
required
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

Request samples

Content type
application/json
{
  • "deviceFamily": "Alcatel-Lucent Enterprise",
  • "deviceCategory": "Computer",
  • "deviceName": "string",
  • "deviceOS": "Linux",
  • "employeeAccount": "string",
  • "arpName": "string",
  • "plName": "string",
  • "otherAttributes": [
    ],
  • "enableDeviceSpecificPSK": "DISABLED",
  • "deviceSpecificPassphrase": "string",
  • "expireFlag": "Never",
  • "pskValidityPeriod": 0,
  • "deviceMac": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The company property has been successfully created.",
  • "data": {
    }
}

Delete multiple company properties.

This API is used to delete multiple company properties by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The company properties have been successfully deleted.",
  • "data": [
    ]
}

Get a company property.

This API is used to get a company property by Id.

path Parameters
orgId
required
string

This is a path param for orgId

companyPropertyId
required
string

This is a path param for companyPropertyId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The company property has been successfully fetched.",
  • "data": {
    }
}

Update a company property.

This API is used to update a company property by id.

path Parameters
orgId
required
string

This is a path param for orgId

companyPropertyId
required
string

This is a path param for companyPropertyId

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
required
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
required
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

Request samples

Content type
application/json
{
  • "deviceFamily": "Alcatel-Lucent Enterprise",
  • "deviceCategory": "Computer",
  • "deviceName": "string",
  • "deviceOS": "Linux",
  • "employeeAccount": "string",
  • "arpName": "string",
  • "plName": "string",
  • "otherAttributes": [
    ],
  • "enableDeviceSpecificPSK": "DISABLED",
  • "deviceSpecificPassphrase": "string",
  • "expireFlag": "Never",
  • "pskValidityPeriod": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The company property has been successfully updated.",
  • "data": {
    }
}

Send QR Code to Employee Account.

This API is used to Send the QR code to the Employee account's email configured in the company property.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "ssid": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Company Propertie PSK QR Code have been successfully sent.",
  • "data": [
    ]
}

Mass import of company properties.

This API allows to mass import company properties.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The company properties have been successfully created.",
  • "data": [
    ]
}

Nasclients

Get all NAS clients.

This API is used to get all NAS clients.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "NAS Clients list have been successfully fetched.",
  • "data": {
    }
}

Create a NAS client.

This API is used to create a NAS client.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "nasName": "string",
  • "startNasIP": "string",
  • "endNasIP": "string",
  • "shareSecurity": "string",
  • "description": "string",
  • "dmAttributes": [
    ],
  • "coaAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete multiple NAS clients.

This API is used to delete multiple NAS clients by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The NAS clients have been successfully deleted.",
  • "data": [
    ]
}

Get a NAS client.

This API is used to get a NAS client by Id.

path Parameters
orgId
required
string

This is a path param for orgId

nasClientId
required
string

This is a path param for nasClientId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The NAS Client has been successfully fetched.",
  • "data": {
    }
}

Update a NAS client.

This API is used to update a NAS client by id.

path Parameters
orgId
required
string

This is a path param for orgId

nasClientId
required
string

This is a path param for nasClientId

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

Request samples

Content type
application/json
{
  • "description": "string",
  • "shareSecurity": "string",
  • "dmAttributes": [
    ],
  • "coaAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "NAS Client has been successfully updated.",
  • "data": {
    }
}

Byodaccessstrategy

Retrieve BYOD access strategies

This API is used to get BYOD access strategies.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Byod access strategies have been successfully fetched.",
  • "data": {
    }
}

Create a BYOD access strategy

This API is used to create a BYOD access strategy.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "strategyName": "string",
  • "url": "string",
  • "redirectionStrategy": "string",
  • "successRedirectUrl": "string",
  • "authenticationSource": "Local Database",
  • "serverName": "string",
  • "fixedAccessRoleProfile": "string",
  • "fixedPolicyList": "string",
  • "enableRoleMapping": "ENABLED",
  • "protocolMode": "HTTPS",
  • "fqdnMode": "FQDN",
  • "portalUrl": "string",
  • "periodUnit": "Day(s)",
  • "rememberDevice": "ENABLED",
  • "expireFlag": "string",
  • "deviceValidityPeriod": 0,
  • "maxDeviceNumberPerAccount": 0,
  • "otherAttributesVOs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Byod access strategy has been successfully created.",
  • "data": {
    }
}

Delete multiple BYOD access strategies

This API is used to delete multiple BYOD access strategies by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Byod access strategies have been successfully deleted.",
  • "data": [
    ]
}

Get a BYOD access strategy by ID

This API is used to get a BYOD access strategy by its ID.

path Parameters
orgId
required
string

This is a path param for orgId

byodAccessStrategyId
required
string

This is a path param for byodAccessStrategyId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Byod access strategy have been successfully fetched.",
  • "data": {
    }
}

Update a BYOD access strategy

This API is used to update a BYOD access strategy by id.

path Parameters
orgId
required
string

This is a path param for orgId

byodAccessStrategyId
required
string

This is a path param for byodAccessStrategyId

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

Request samples

Content type
application/json
{
  • "url": "string",
  • "redirectionStrategy": "string",
  • "successRedirectUrl": "string",
  • "authenticationSource": "Local Database",
  • "serverName": "string",
  • "fixedAccessRoleProfile": "string",
  • "fixedPolicyList": "string",
  • "enableRoleMapping": "ENABLED",
  • "protocolMode": "HTTPS",
  • "fqdnMode": "FQDN",
  • "portalUrl": "string",
  • "periodUnit": "Day(s)",
  • "rememberDevice": "ENABLED",
  • "expireFlag": "string",
  • "deviceValidityPeriod": 0,
  • "maxDeviceNumberPerAccount": 0,
  • "otherAttributesVOs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BYOD access strategy has been successfully updated.",
  • "data": {
    }
}

Radiusattribute

Retrieve radius attributes of a given scope

This API is used to get all radius attributes of a given scope whithin an organization.

path Parameters
orgId
required
string

This is a path param for orgId

scope
required
string

This is a path param for scope

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The radius attributes have been successfully fetched.",
  • "data": {
    }
}

Byoddevice

Get online BYOD Devices

This API is used to get all online BYOD Devices.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The BYOD Device(s) has been successfully created.",
  • "data": {
    }
}

Kick multiple BYOD devices offline

This API is used to Kick multiple BYOD devices offline by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BYOD device(s) have been successfully kicked off.",
  • "data": [
    ]
}

Get BYOD remember record list

This API is used to get all BYOD remember record list.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 201,
  • "message": "The BYOD remember record list has been successfully fetched..",
  • "data": {
    }
}

Delete multiple BYOD remember devices

This API is used to delete multiple BYOD remember devices by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BYOD remember device(s) have been successfully deleted.",
  • "data": [
    ]
}

Guestdevice

Get online guest devices list

This API is used to get all online guest devices list.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Guest devices have been successfully fetched.",
  • "data": {
    }
}

Kick multiple guest devices offline

This API is used to Kick multiple guest devices offline by their MAC addresses.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest devices have been successfully kicked off.",
  • "data": [
    ]
}

Create Guest Remember Device

This API is used to create a Guest Remember Device.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "account": "string",
  • "deviceMac": "string",
  • "deviceCategory": "string",
  • "deviceOS": "string",
  • "deviceFamily": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Guest remembered device have been successfully created.",
  • "data": {
    }
}

Get guest remembered records list

This API is used to get all guest remembered records list.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Guest remembered devices have been successfully fetched.",
  • "data": {
    }
}

Delete multiple guest remembered devices

This API is used to delete multiple guest remembered devices by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest remembered devices have been successfully deleted.",
  • "data": [
    ]
}

Reset Quota guest remembered devices

This API is used to reset Time Data Quota of a guest remembered device by its Id.

path Parameters
orgId
required
string

This is a path param for orgId

guestDeviceId
required
string

This is a path param for guestDeviceId

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

Request samples

Content type
application/json
{
  • "dataQuotaThreshold": 0,
  • "timeQuotaPerDay": 0,
  • "timeQuotaByHour": 0,
  • "blockedHours": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Guest remembered device Quota have been successfully reseted.",
  • "data": {
    }
}

Authenticationrecord

Get authentication records list

This API is used to get all authentication records list.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Authentication records have been successfully fetched.",
  • "data": {
    }
}

Generate PSK for history authentication records

This API is used to create the DSPSK for the history authentication records by device MAC.

path Parameters
orgId
required
string

This is a path param for orgId

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
{
  • "macs": [
    ],
  • "pskValidityPeriod": 0,
  • "generatePskMode": "DISTINCT"
}

Response samples

Content type
application/json
{
  • "errorCode": 400,
  • "errorMsg": "Bad Request",
  • "errors": [
    ]
}

Get history of authentication records

This API is used to get the history of authentication records.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Authentication records history has been successfully fetched.",
  • "data": {
    }
}

Delete multiple authentication records

This API is used to delete multiple authentication records by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The authentication records have been successfully deleted.",
  • "data": [
    ]
}

Get history authentication records detail

This API is used to get the detail of history authentication record by record Id.

path Parameters
orgId
required
string

This is a path param for orgId

recordId
required
string

This is a path param for recordId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Authentication records history detail has been successfully fetched.",
  • "data": {
    }
}

Get online authentication records detail

This API is used to get the detail of online authentication record by client MAC address.

path Parameters
orgId
required
string

This is a path param for orgId

mac
required
string

This is a path param for mac

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Authentication records history detail has been successfully fetched.",
  • "data": {
    }
}

Classifications

Get all classifications

This API allows you to get all classifications for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Classification has been successfully fetched.",
  • "data": [
    ]
}

Delete multiple classifications by names

This API allows you to delete multiple classifications by names for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Classifications have been successfully removed.",
  • "data": [
    ]
}

Create classifications

This API allows you to create classifications for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "accessClassification": {
    },
  • "assignment": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The classification has been successfully created.",
  • "data": {
    }
}

Update classifications

This API allows you to update classifications for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "accessClassification": {
    },
  • "assignment": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The classification has been successfully updated.",
  • "data": {
    }
}

Get classifications by Id

This API allows you to get classifications by id for a given organization.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Classification has been successfully fetched.",
  • "data": {
    }
}

Guestoperator

get list of Guests operators

This API is used to get list of Guests operators.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{}

Create a new guest operator

This API is used to create new guest operator.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "username": "string",
  • "fullName": "string",
  • "telephone": "string",
  • "password": "string",
  • "email": "string",
  • "description": "string",
  • "location": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Guest operator has been successfully created.",
  • "data": {}
}

Delete multiple guests operators

This API is used to delete multiple guests operators by Ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Guests operators has been successfully deleted.",
  • "data": [
    ]
}

Get guest operator by id

This API is used to get guest operator by id.

path Parameters
orgId
required
string

This is a path param for orgId

guestOperatorId
required
string

This is a path param for guestOperatorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Guest operator have been successfully fetched.",
  • "data": {}
}

Update a guest operator by id

This API is used to update a guest operator by id.

path Parameters
orgId
required
string

This is a path param for orgId

guestOperatorId
required
string

This is a path param for guestOperatorId

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

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "telephone": "string",
  • "password": "string",
  • "email": "string",
  • "description": "string",
  • "location": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest operator has been successfully updated.",
  • "data": {
    }
}

Get guest operator locations

This API is used to get the guest operator list of locations.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest operators locations have been successfuly fetched.",
  • "data": [
    ]
}

Captiveportalaccessrecords

Get all captive portal access records.

This API is used to get all captive portal access records.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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 any

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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The captive portal access records have been successfully fetched.",
  • "data": {
    }
}

Delete multiple captive portal access records

This API is used to delete multiple captive portal access records by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The captive portal access records have been successfully deleted.",
  • "data": [
    ]
}

Globalpolicy

Update the global policy

This API allows to 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

Request samples

Content type
application/json
{
  • "accountLockoutThreshold": 0,
  • "accountLockoutDuration": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The global policy has been successfully updated.",
  • "data": {
    }
}

Get the global policy

This API allows to get global policy

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully fetched.",
  • "data": {
    }
}

Radsecca

Create a radsec CA

This API allows to create new radsec CA in organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 201,
  • "message": "The RadSec CA has been successfully created.",
  • "data": {
    }
}

Get all RadSecs CA

This API allows to get all RadSecs CA of organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The RadSec CAs have been successfully fetched.",
  • "data": {
    }
}

Delete multiple RadSecs CA

This API allows to delete multiple RadSecs CA identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The RadSec CAs have been successfully deleted.",
  • "data": [
    ]
}

Download a radsec CA by id

This API allows to download a radsec CA identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

caId
required
string

This is a path param for caId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/zip
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Radiustrustca

Create a radius CA

This API allows to create new radius trust CA in organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Radius CA has been successfully created.",
  • "data": {
    }
}

Get all Radius CA

This API allows to get all Radius CA of organization.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Radius CAs have been successfully fetched.",
  • "data": {
    }
}

Delete multiple Radius Trust CA

This API allows to delete multiple Radius trust CA identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Radius CAs have been successfully deleted.",
  • "data": [
    ]
}

Download a radius CA by id

This API allows to download a radius CA identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

caId
required
string

This is a path param for caId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/zip
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Trust Radius Certification Authority

This API allows to trust Radius Certification identified by their ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Radius CA has been successfully updated.",
  • "data": [
    ]
}

Untrust Radius Certification Authority

This API allows to untrust Radius Certification Authority by Id

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Radius CA has been successfully updated.",
  • "data": [
    ]
}

Schedulerbackup

Get all Schedules Backups

This API allows to get all Backup Schedulers.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule backup(s) have been successfully fetched.",
  • "data": [
    ]
}

Delete multiple Backup Schedulers

This API allows to delete mutiple Backup Schedulers identified by there ids.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule backup(s) have been successfully deleted.",
  • "data": [
    ]
}

Create a Backup Scheduler

This API is used to create a Backup Scheduler

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "includeSecurityFiles": true,
  • "paused": true,
  • "scope": "site",
  • "scopeId": [
    ],
  • "repeat": "daily",
  • "startDate": "string",
  • "endDate": "string",
  • "dayInWeeks": [
    ],
  • "dayInMonths": [
    ],
  • "hourInDay": 0,
  • "minute": 0
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The schedule backup has been successfully created.",
  • "data": {
    }
}

Get a Backup Scheduler by id

This API allows to fetch one Backup Scheduler identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

backupId
required
string

This is a path param for backupId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule backup(s) have been successfully fetched.",
  • "data": {
    }
}

Update a Backup Scheduler by id

This API allows to update one schedule backup identified by its id.

path Parameters
orgId
required
string

This is a path param for orgId

backupId
required
string

This is a path param for backupId

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "includeSecurityFiles": true,
  • "paused": true,
  • "scope": "site",
  • "scopeId": [
    ],
  • "repeat": "daily",
  • "startDate": "string",
  • "endDate": "string",
  • "dayInWeeks": [
    ],
  • "dayInMonths": [
    ],
  • "hourInDay": 0,
  • "minute": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The schedule backup(s) have been successfully updated.",
  • "data": {
    }
}

Deactivate multiple backup schedulers

This API allows to deactivate multiple backup schedulers by their id.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The deactivation of schedule backup(s) have been successfully registered.",
  • "data": [
    ]
}

Activate multiple backup schedulers

This API allows to activate multiple backup schedulers identified by their id.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The activation of schedule backup(s) have been successfully registered.",
  • "data": [
    ]
}

Configurationbackup

Get all configuration backups

This API is used to get the list of configuration backups created by scope.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The configuration backup(s) have been successfully fetched.",
  • "data": {
    }
}

Delete multiple configuration backups

This API is used to delete multiple configuration backups by providing a list of ids in the body

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The configuration backup(s) have been successfully deleted.",
  • "data": [
    ]
}

Create Instant Backup

This API is used to create Instant Backup for multiple devices

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "serialNumbers": [
    ],
  • "description": "string",
  • "isSecurityFiles": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The configuration backup has been successfully created.",
  • "data": [
    ]
}

Get Configuration backup by Id

This API is used to get the details (including file list) of a given backup by its ID.

path Parameters
orgId
required
string

This is a path param for orgId

backupId
required
string

This is a path param for backupId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The configuration backup has been successfully fetched.",
  • "data": {
    }
}

Get File content of a Configuration backup

This API is used to get get files of configuration backup by backup ID and file Id.

path Parameters
orgId
required
string

This is a path param for orgId

backupId
required
string

This is a path param for backupId

fileId
required
string

This is a path param for fileId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The configuration backup have been successfully fetched.",
  • "data": "Activation Server URL: brqsdqsdest-qsd-qsdsq.dev.activation.ovng.myovcloud.com \nHTTP Proxy Server: \nHTTP Proxy Port:\nHTTP Proxy User Name: \nHTTP Proxy Password:\nActivation Server Port:"
}

Download a Configuration backup by Id

This API is used to download a zip file of a Configuration backup.

path Parameters
orgId
required
string

This is a path param for orgId

id
required
string

This is a path param for id

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/zip
MIIDizCCAnOgAwIBAgIJAOoRIa9d8fTHMA0GCSqGSIb3DQEBCwUAMFwxCzAJBgNVBAYTAlZOMRIwEAYDVQQIDAlIb0NoaU1pbmgxEjAQBgNVBAcMCUhvQ2hpTWluaDEL

Goldenconfig

Enable audit configuration for devices

This API is used to enable audit configuration for multiple devices

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The request to activate Golden configuration(s) have been successfully registered.",
  • "data": [
    ]
}

Disable audit configuration for devices

This API is used to disable audit configuration for multiple devices

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The request to deactivate Golden configuration(s) have been successfully registered.",
  • "data": [
    ]
}

Delete audit configuration for devices

This API is used to delete audit configuration for multiple devices

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

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

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The request to delete Golden configuration(s) have been successfully registered.",
  • "data": [
    ]
}

Mark Golden Configuration for devices

This API is used to Mark Golden configuration and schedule Audit of multiples switches

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "serialNumbers": [
    ],
  • "isSaveConfig": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The request to Golden configuration has been successfully registered.",
  • "data": [
    ]
}

Get all golden configs in organization

This API is used to get all golden configs in organization.

path Parameters
orgId
required
string

This is a path param for orgId

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 any

"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
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 samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Golden configuration(s) have been successfully fetched.",
  • "data": [
    ]
}

Get the golden configuration of a device

This API is used to get the golden configuration of a device identified by its serial number.

path Parameters
orgId
required
string

This is a path param for orgId

serialNumber
required
string

This is a path param for serialNumber

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Golden configuration(s) have been successfully fetched.",
  • "data": {
    }
}

Request Instant Audit Configuration for devices

This API is used to request an instant audit of multiples switches

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "serialNumbers": [
    ],
  • "isSaveConfig": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The instant audit has been successfully created.",
  • "data": [
    ]
}

Pii

Retrieve org PII data

This API allows to 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.

path Parameters
orgId
required
string

This is a path param for orgId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Personal identifiable information have been successfully fetched.",
  • "data": {
    }
}

Delete PII data

This API allows to 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.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "keyType": "string",
  • "keyValues": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Delete PII Keys request has been taken into account and being processed.",
  • "data": {
    }
}

Cancel a delete PII request

This API allows to enable again the storage of Personal Identifiable Information (PII) for a given list of clients.

path Parameters
orgId
required
string

This is a path param for orgId

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

Request samples

Content type
application/json
{
  • "keyType": "string",
  • "keyValues": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Cancel Delete PII request Keys request has been taken into account and being processed.",
  • "data": {
    }
}

Retrieve Access Point PII data

This API allows to 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.

path Parameters
orgId
required
string

This is a path param for orgId

apMac
required
string

This is a path param for apMac

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Personal identifiable information have been successfully fetched.",
  • "data": {
    }
}