logo
API docs by Redocly

Kaiwoo network management API (2.0)

License: Copyright (C) 2017-2024 Kaiwoo Pte. Ltd.

This API is used as to configure managed devices, networks and organisations.

Organisations

LIST

Returns all organisations

Authorizations:
oAuth
query Parameters
search
string

Fulltext search across all the object's fields.

Responses

Response samples

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

CREATE

Create a new organisation

Authorizations:
oAuth
Request Body schema: application/json

Organisation to be added.

name
required
string <= 128 characters

A name identifying this organisation.

description
string or null <= 1024 characters

A field for additional information about the organisation.

custom_data
string or null <= 4096 characters ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za...

Custom data object for the API user to store data in base64 encoded form.

parent_organisation_id
integer or null >= 1

Unique identifier of the organisation the current organisation belongs to. 'Null' indicates the organisation does not have a parent organisation.

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "custom_data": "string",
  • "parent_organisation_id": 1,
  • "maintenance": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "custom_data": "string",
  • "parent_organisation_id": 1,
  • "maintenance": {
    },
  • "id": 0,
  • "attributes": {
    },
  • "resource_id": "string",
  • "default": {
    }
}

DETAILS

Get an organisation's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "custom_data": "string",
  • "parent_organisation_id": 1,
  • "maintenance": {
    },
  • "id": 0,
  • "attributes": {
    },
  • "resource_id": "string",
  • "default": {
    }
}

DELETE

Deletes the queried organisation

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Responses

CHANGELOG

Get an organisation's changelog

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Responses

Response samples

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

UPDATE

Change an organisation

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Request Body schema: application/json

Properties to change on the queried organisation

name
string <= 128 characters

A name identifying this organisation.

description
string or null <= 1024 characters

A field for additional information about the organisation.

custom_data
string or null <= 4096 characters ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za...

Custom data object for the API user to store data in base64 encoded form.

parent_organisation_id
integer or null >= 1

Unique identifier of the organisation the current organisation belongs to. 'Null' indicates the organisation does not have a parent organisation.

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "custom_data": "string",
  • "parent_organisation_id": 1,
  • "maintenance": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "custom_data": "string",
  • "parent_organisation_id": 1,
  • "maintenance": {
    }
}

CHANGELOG ENTRY

Get a changelog entry's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

entry_id
required
integer <int64> >= 1

The unique identifier of the changelog entry to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "custom_data": "string",
  • "parent_organisation_id": 1,
  • "maintenance": {
    }
}

ACTIVITY LOG

Get an organisation's activity log

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Responses

Response samples

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

Devices

LIST

Returns all devices

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

query Parameters
search
string

Fulltext search across all the object's fields.

network_id
integer

Specify a network id to filter the result by. Should no network id be specified, the query will only return objects with no network assigned.

period
string
Enum: "day" "week" "month"

The time period to limit the query to

ssid_id
integer

specify an SSID id to filter the result by

type
string
Enum: "ap" "switch" "media_converter" "controller"

specify a device type to filter the result by

Responses

Response samples

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

CREATE

Create a new device

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Request Body schema: application/json

Details of the device to add

One of
name
string or null <= 128 characters

Field for a common name allowing easier identification of a device.

description
string or null <= 1024 characters

Field for additional information about the device.

mac_addr
required
string = 17 characters ^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$

The physical address of the device's primary network interface.

network_id
integer or null >= 1

The ID of the network the device is currently part of. 'Null' indicates the device is currently not assigned to any network.

required
object (The configured devie latitude and longitude.)
object
object

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "mac_addr": "stringstringstrin",
  • "network_id": 1,
  • "location": {
    },
  • "floorplan": {
    },
  • "configuration": {
    }
}

Response samples

Content type
application/json
Example
{
  • "type": "ap",
  • "name": "string",
  • "description": "string",
  • "model": "string",
  • "mac_addr": "stringstringstrin",
  • "network_id": 1,
  • "location": {
    },
  • "floorplan": {
    },
  • "serial_number": "string",
  • "configuration": {
    },
  • "provisioned": {
    },
  • "id": 0
}

DETAILS

Get the device configuration which is changeable via API

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

Response samples

Content type
application/json
Example
{
  • "type": "ap",
  • "name": "string",
  • "description": "string",
  • "model": "string",
  • "mac_addr": "stringstringstrin",
  • "network_id": 1,
  • "location": {
    },
  • "floorplan": {
    },
  • "serial_number": "string",
  • "configuration": {
    },
  • "provisioned": {
    },
  • "id": 0
}

DELETE

Deletes the queried device

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

STATUS

Get the device status sent by the device itself or provided by the cloud

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

query Parameters
period
string
Enum: "day" "week" "month"

The time period to limit the query to

ssid_id
integer

specify an SSID id to filter the result by

Responses

Response samples

Content type
application/json
Example
{
  • "type": "ap",
  • "ip_addr": {
    },
  • "ip6_addr": {
    },
  • "cpu_load": 0,
  • "memory": {
    },
  • "disk": {
    },
  • "temperature": {
    },
  • "uptime": 0,
  • "ports": [
    ],
  • "last_checkin": "string",
  • "persistent_connection": "available",
  • "firmware_version": "string",
  • "download": 0,
  • "upload": 0,
  • "status": {
    },
  • "mesh": {
    },
  • "radio": [
    ],
  • "mac_addrs": {
    }
}

PAIRING

Trigger the cloud to renew the communication's security with the device

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "start_time": "string",
  • "end_time": "string"
}

REBOOT

Trigger the cloud to perform a full reboot of the device

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

query Parameters
dst_mac_addr
string^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$

MAC address of the device, this action shall be executed on.

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "error": "Device is unreachable / offline."
}

UPGRADE

Trigger the cloud to perform a firmware upgrade of the device

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

Response samples

Content type
application/json
{
  • "code": 405,
  • "error": "Device is unreachable / offline."
}

PICTURE GET

Get a device's picture

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

Response samples

Content type
application/json
{
  • "creator": {
    },
  • "creation_date": null,
  • "picture": "string"
}

PICTURE SET

Change a device's picture

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Request Body schema: application/json

Properties to change on the queried device

picture
string or null <= 7864320 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

The picture itself (in base64 format).

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "creator": {
    },
  • "creation_date": null,
  • "picture": "string"
}

CHANGELOG

Get a device's changelog

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

Response samples

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

UPDATE

Change a device

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Request Body schema: application/json

Properties to change on the queried device

One of
name
string or null <= 128 characters

Field for a common name allowing easier identification of a device.

description
string or null <= 1024 characters

Field for additional information about the device.

mac_addr
string = 17 characters ^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$

The physical address of the device's primary network interface.

network_id
integer or null >= 1

The ID of the network the device is currently part of. 'Null' indicates the device is currently not assigned to any network.

object (The configured devie latitude and longitude.)
object
object

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "mac_addr": "stringstringstrin",
  • "network_id": 1,
  • "location": {
    },
  • "floorplan": {
    },
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "start_time": "string",
  • "end_time": "string"
}

MOVE

Move the device to another organisation & network

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Request Body schema: application/json

Properties to change on the queried device

organisation_id
required
integer >= 1

The ID of the organisation the device is should be moved to.

network_id
required
integer >= 1

The ID of the network the device is should be moved to.

Responses

Request samples

Content type
application/json
{
  • "organisation_id": 1,
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "start_time": "string",
  • "end_time": "string"
}

CHANGELOG ENTRY

Get a changelog entry's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

entry_id
required
integer <int64> >= 1

The unique identifier of the changelog entry to query.

Responses

Response samples

Content type
application/json
Example
{
  • "type": "ap",
  • "name": "string",
  • "description": "string",
  • "model": "string",
  • "mac_addr": "stringstringstrin",
  • "network_id": 1,
  • "location": {
    },
  • "floorplan": {
    },
  • "serial_number": "string",
  • "configuration": {
    },
  • "provisioned": {
    },
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z"
}

Ports

DETAILS

Returns all ports

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

Response samples

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

STATUS

Get a port's status

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

Response samples

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

PORT RESET

Trigger the cloud to perform a reset of the port

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

port_id
required
integer <int64> >= 1

The unique identifier of the port to query.

query Parameters
dst_mac_addr
string^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$

MAC address of the device, this action shall be executed on.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "start_time": "string",
  • "end_time": "string"
}

CHANGELOG

Get a port's changelog

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Responses

Response samples

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

UPDATE

Change a port

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

Request Body schema: application/json

Properties to change on the queried port

Array of GE (object) or SFP (object) [ 1 .. 52 ] items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "ports": [
    ]
}

CHANGELOG ENTRY

Get a changelog entry's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

device_id
required
integer <int64> >= 1

The unique identifier of the device to query.

entry_id
required
integer <int64> >= 1

The unique identifier of the changelog entry to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "ports": [
    ]
}

Splashpages

LIST

Returns all splashpages

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

query Parameters
search
string

Fulltext search across all the object's fields.

Responses

Response samples

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

CREATE

Create a new splashpage

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Request Body schema: application/json

Details of the splashpage to add

name
required
string [ 1 .. 128 ] characters

Field for a common name allowing easier identification of a splashpage.

description
string or null <= 1024 characters

Field for additional information about the splashpage.

splash_html
required
string [ 4 .. 102400 ] characters ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za...

The splashpage HTML displayed when HTTP requests are intercepted by the AccessPoint (base64 encoded). Referenced files such as CSS, images and so on, can be uploaded via splashpage assets.

client_force_timeout
integer >= 1
Default: 1440

Time (in minutes) after which a connected client will be presented with the splashpage again.

success_landing_page
string or null <= 128 characters ^(http|https)://*

The webpage to redirect a connecting user to after successfully completing the splashpage. The client's requested webpage will be shown if this setting is unset.

object
walled_garden
Array of strings[^[a-zA-Z0-9._*-]+$]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "splash_html": "string",
  • "client_force_timeout": 1440,
  • "success_landing_page": "string",
  • "policies": {
    },
  • "walled_garden": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "splash_html": "string",
  • "client_force_timeout": 1440,
  • "success_landing_page": "string",
  • "policies": {
    },
  • "walled_garden": [
    ],
  • "id": 0,
  • "attributes": {
    }
}

DETAILS

Get a splashpage's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "splash_html": "string",
  • "client_force_timeout": 1440,
  • "success_landing_page": "string",
  • "policies": {
    },
  • "walled_garden": [
    ],
  • "id": 0,
  • "attributes": {
    }
}

DELETE

Deletes the queried splashpage

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

Responses

CHANGELOG

Get a splashpage's changelog

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

Responses

Response samples

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

UPDATE

Change a splashpage

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

Request Body schema: application/json

Properties to change on the queried splashpage

name
required
string [ 1 .. 128 ] characters

Field for a common name allowing easier identification of a splashpage.

description
string or null <= 1024 characters

Field for additional information about the splashpage.

splash_html
required
string [ 4 .. 102400 ] characters ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za...

The splashpage HTML displayed when HTTP requests are intercepted by the AccessPoint (base64 encoded). Referenced files such as CSS, images and so on, can be uploaded via splashpage assets.

client_force_timeout
integer >= 1
Default: 1440

Time (in minutes) after which a connected client will be presented with the splashpage again.

success_landing_page
string or null <= 128 characters ^(http|https)://*

The webpage to redirect a connecting user to after successfully completing the splashpage. The client's requested webpage will be shown if this setting is unset.

object
walled_garden
Array of strings[^[a-zA-Z0-9._*-]+$]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "splash_html": "string",
  • "client_force_timeout": 1440,
  • "success_landing_page": "string",
  • "policies": {
    },
  • "walled_garden": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "splash_html": "string",
  • "client_force_timeout": 1440,
  • "success_landing_page": "string",
  • "policies": {
    },
  • "walled_garden": [
    ]
}

CHANGELOG ENTRY

Get a changelog entry's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

entry_id
required
integer <int64> >= 1

The unique identifier of the changelog entry to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "splash_html": "string",
  • "client_force_timeout": 1440,
  • "success_landing_page": "string",
  • "policies": {
    },
  • "walled_garden": [
    ]
}

Splashpage Assets

LIST

Returns all splashpage assets

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

query Parameters
search
string

Fulltext search across all the object's fields.

Responses

Response samples

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

CREATE

Create a new splashpage asset

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

Request Body schema: application/json

Splashpage asset to be added.

name
required
string <= 128 characters ^[a-zA-Z0-9][a-zA-Z0-9.\-_]*$

A unique name identifying this splashpage asset.

asset
required
string <= 1048576 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

The asset itself (in base64 format).

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "asset": "string"
}

DETAILS

Get a splashpage asset's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

asset_id
required
integer <int64> >= 1

The unique identifier of the asset to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "asset": "string"
}

UPDATE

Change a splashpage asset

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

asset_id
required
integer <int64> >= 1

The unique identifier of the asset to query.

Request Body schema: application/json

Properties to change on the queried splashpage asset

name
string <= 128 characters ^[a-zA-Z0-9][a-zA-Z0-9.\-_]*$

A unique name identifying this splashpage asset.

asset
string <= 1048576 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

The asset itself (in base64 format).

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "asset": "string"
}

DELETE

Deletes the queried splashpage asset

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

splashpage_id
required
integer <int64> >= 1

The unique identifier of the splashpage to query.

asset_id
required
integer <int64> >= 1

The unique identifier of the asset to query.

Responses

Schedules

LIST

Returns all schedules

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Responses

Response samples

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

CREATE

Create a new schedule

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Request Body schema: application/json

Details of the schedule to add

name
required
string [ 1 .. 128 ] characters

Field for a common name allowing easier identification of a splashpage.

description
string or null <= 1024 characters

Field for additional information about the splashpage.

required
Array of objects

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "schedule": [
    ],
  • "id": 0,
  • "referenced": true,
  • "attributes": {
    }
}

DETAILS

Get a schedule's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

schedule_id
required
integer <int64> >= 1

The unique identifier of the schedule to query.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "schedule": [
    ],
  • "id": 0,
  • "referenced": true,
  • "attributes": {
    }
}

DELETE

Deletes the queried schedule

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

schedule_id
required
integer <int64> >= 1

The unique identifier of the schedule to query.

Responses

CHANGELOG

Get a schedule's changelog

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

schedule_id
required
integer <int64> >= 1

The unique identifier of the schedule to query.

Responses

Response samples

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

UPDATE

Change a schedule

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

schedule_id
required
integer <int64> >= 1

The unique identifier of the schedule to query.

Request Body schema: application/json

Properties to change on the queried schedule

name
required
string [ 1 .. 128 ] characters

Field for a common name allowing easier identification of a splashpage.

description
string or null <= 1024 characters

Field for additional information about the splashpage.

required
Array of objects

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "schedule": [
    ]
}

CHANGELOG ENTRY

Get a changelog entry's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

schedule_id
required
integer <int64> >= 1

The unique identifier of the schedule to query.

entry_id
required
integer <int64> >= 1

The unique identifier of the changelog entry to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "schedule": [
    ]
}

Networks

LIST

Returns all networks

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

query Parameters
search
string

Fulltext search across all the object's fields.

Responses

Response samples

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

CREATE

Add a new network

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

Request Body schema: application/json

Service Profile to add to the network

description
string or null <= 1024 characters

Field for additional information about the network.

address
string or null <= 128 characters

Field for the address of the network.

object
name
required
string <= 128 characters

Field for a common name allowing easier identification of a network.

wifi_ai
boolean
Default: true

The WiFi AI service operates during the configured maintenance window by retrieving WiFi data about the surroundings of each AccessPoint in the network and based on the collected data computes the WiFi channel, HT mode & mesh settings for optimal WiFi throughput throughout the network.

object
object
object
timezone
required
string <= 128 characters

Field to store the timezone the network is located in.

active (object) or alert (object) or inactive (object)
object or object or object

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "address": "string",
  • "maintenance": {
    },
  • "name": "string",
  • "wifi_ai": true,
  • "wireless": {
    },
  • "protocols": {
    },
  • "policies": {
    },
  • "timezone": "string",
  • "leds": {
    },
  • "ethernet": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "address": "string",
  • "maintenance": {
    },
  • "name": "string",
  • "wifi_ai": true,
  • "wireless": {
    },
  • "protocols": {
    },
  • "policies": {
    },
  • "timezone": "string",
  • "leds": {
    },
  • "ethernet": {
    },
  • "id": 0,
  • "resource_id": "string",
  • "attributes": {
    },
  • "presence_analytics": [
    ],
  • "syslog": [
    ]
}

DETAILS

Get a network's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "address": "string",
  • "maintenance": {
    },
  • "name": "string",
  • "wifi_ai": true,
  • "wireless": {
    },
  • "protocols": {
    },
  • "policies": {
    },
  • "timezone": "string",
  • "leds": {
    },
  • "ethernet": {
    },
  • "id": 0,
  • "resource_id": "string",
  • "attributes": {
    },
  • "presence_analytics": [
    ],
  • "syslog": [
    ]
}

DELETE

Deletes the queried network.

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Responses

CHANGELOG

Get a networks's changelog

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Responses

Response samples

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

UPDATE

Change a network

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Request Body schema: application/json

Properties to change on the queried network

description
string or null <= 1024 characters

Field for additional information about the network.

address
string or null <= 128 characters

Field for the address of the network.

object
name
string <= 128 characters

Field for a common name allowing easier identification of a network.

wifi_ai
boolean
Default: true

The WiFi AI service operates during the configured maintenance window by retrieving WiFi data about the surroundings of each AccessPoint in the network and based on the collected data computes the WiFi channel, HT mode & mesh settings for optimal WiFi throughput throughout the network.

object
object
object
timezone
string <= 128 characters

Field to store the timezone the network is located in.

active (object) or alert (object) or inactive (object)
object or object or object

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "address": "string",
  • "maintenance": {
    },
  • "name": "string",
  • "wifi_ai": true,
  • "wireless": {
    },
  • "protocols": {
    },
  • "policies": {
    },
  • "timezone": "string",
  • "leds": {
    },
  • "ethernet": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "address": "string",
  • "maintenance": {
    },
  • "name": "string",
  • "wifi_ai": true,
  • "wireless": {
    },
  • "protocols": {
    },
  • "policies": {
    },
  • "timezone": "string",
  • "leds": {
    },
  • "ethernet": {
    }
}

CHANGELOG ENTRY

Get a changelog entry's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

entry_id
required
integer <int64> >= 1

The unique identifier of the changelog entry to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "address": "string",
  • "maintenance": {
    },
  • "name": "string",
  • "wifi_ai": true,
  • "wireless": {
    },
  • "protocols": {
    },
  • "policies": {
    },
  • "timezone": "string",
  • "leds": {
    },
  • "ethernet": {
    }
}

NOTIFICATIONS GET

Get a networks's notification settings

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Responses

Response samples

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

NOTIFICATIONS UPDATE

Change a network notification settings

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Request Body schema: application/json

Notification properties to change on the queried network

active (object) or inactive (object)

Responses

Request samples

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

Response samples

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

MOVE

Move the network to another organisation

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Request Body schema: application/json

Properties to change on the queried network

organisation_id
required
integer >= 1

The ID of the organisation the network should be moved to.

Responses

Request samples

Content type
application/json
{
  • "organisation_id": 1
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "start_time": "string",
  • "end_time": "string"
}

WiFi AI

Trigger the cloud to perform a WiFi AI optimisation of the entire network

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "start_time": "string",
  • "end_time": "string"
}

Clients

LIST

Returns all clients

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

query Parameters
period
string
Enum: "day" "week" "month"

The time period to limit the query to

ssid_id
integer

specify an SSID id to filter the result by

type
string
Default: "connected"
Enum: "connected" "settings"

Either return connected clients in selected time period or all client settings.

Responses

Response samples

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

CREATE

Create new client settings

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Request Body schema: application/json

Client settings to be added.

mac_addr
required
string = 17 characters ^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$

The physical address of the client's primary network interface.

custom_name
string or null <= 128 characters

The user defined client name.

Array of splashpage bypass (object) or blocked with message (object)

Responses

Request samples

Content type
application/json
{
  • "mac_addr": "stringstringstrin",
  • "custom_name": "string",
  • "ssids": [
    ]
}

Response samples

Content type
application/json
{
  • "custom_name": "string",
  • "ssids": [
    ],
  • "id": 0,
  • "mac_addr": "stringstringstrin",
  • "has_settings": true,
  • "last_connected_to": 0,
  • "last_seen": "string",
  • "vendor": "string",
  • "hostname": "string",
  • "ipv4": {
    },
  • "os": "string",
  • "download": 0,
  • "upload": 0,
  • "link": {
    },
  • "throttle": {
    },
  • "splashpage": {
    }
}

DETAILS

Get a client's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

client_id
required
integer <int64> >= 1

The unique identifier of the client to query.

query Parameters
period
string
Enum: "day" "week" "month"

The time period to limit the query to

ssid_id
integer

specify an SSID id to filter the result by

Responses

Response samples

Content type
application/json
{
  • "custom_name": "string",
  • "ssids": [
    ],
  • "id": 0,
  • "mac_addr": "stringstringstrin",
  • "has_settings": true,
  • "last_connected_to": 0,
  • "last_seen": "string",
  • "vendor": "string",
  • "hostname": "string",
  • "ipv4": {
    },
  • "os": "string",
  • "download": 0,
  • "upload": 0,
  • "link": {
    },
  • "throttle": {
    },
  • "splashpage": {
    }
}

UPDATE

Change a client settings

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

client_id
required
integer <int64> >= 1

The unique identifier of the client to query.

query Parameters
period
string
Enum: "day" "week" "month"

The time period to limit the query to

ssid_id
integer

specify an SSID id to filter the result by

Request Body schema: application/json

Properties to change on the queried client

custom_name
string or null <= 128 characters

The user defined client name.

Array of splashpage bypass (object) or blocked with message (object)

Responses

Request samples

Content type
application/json
{
  • "custom_name": "string",
  • "ssids": [
    ]
}

Response samples

Content type
application/json
{
  • "custom_name": "string",
  • "ssids": [
    ],
  • "id": 0,
  • "mac_addr": "stringstringstrin",
  • "has_settings": true,
  • "last_connected_to": 0,
  • "last_seen": "string",
  • "vendor": "string",
  • "hostname": "string",
  • "ipv4": {
    },
  • "os": "string",
  • "download": 0,
  • "upload": 0,
  • "link": {
    },
  • "throttle": {
    },
  • "splashpage": {
    }
}

DELETE

Deletes all client settings

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

client_id
required
integer <int64> >= 1

The unique identifier of the client to query.

query Parameters
period
string
Enum: "day" "week" "month"

The time period to limit the query to

ssid_id
integer

specify an SSID id to filter the result by

Responses

Network Topology

Layer 2

Get the Layer 2 network topology

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Responses

Response samples

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

MESH

Get the mesh network topology

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Responses

Response samples

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

WiFi

Get the WiFi network topology

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

query Parameters
device_id
integer

specify an device id to filter the result by

Responses

Response samples

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

RF Interference

Get the RF interference topology

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

query Parameters
device_id
integer

specify an device id to filter the result by

Responses

Response samples

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

Ssids

LIST

Returns all SSIDs in the queried network

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

query Parameters
search
string

Fulltext search across all the object's fields.

Responses

Response samples

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

CREATE

Create a new SSID

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Request Body schema: application/json

Details of the SSID to add

enable
boolean
Default: true

This setting activates or deactivates the SSID.

schedule_id
integer or null >= 1

When a schedule is configured, the SSID will only be enabled according to the schedule.

name
required
string [ 1 .. 32 ] characters

The default broadcast name for both 2.4GHz and 5GHz bands.

object or object
object
required
object or object or object
disabled (object) or enabled (object)
disabled (object) or service (object)
disabled (object) or object

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "schedule_id": 1,
  • "name": "string",
  • "wan": {
    },
  • "wifi": {
    },
  • "captive_portal": {
    },
  • "throttle": {
    },
  • "dns": {
    },
  • "vpn": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "enable": true,
  • "schedule_id": 1,
  • "name": "string",
  • "wan": {
    },
  • "wifi": {
    },
  • "captive_portal": {
    },
  • "throttle": {
    },
  • "dns": {
    },
  • "vpn": {
    }
}

DETAILS

Get an SSID's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

ssid_id
required
integer <int64> >= 1

The unique identifier of the SSID to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "enable": true,
  • "schedule_id": 1,
  • "name": "string",
  • "wan": {
    },
  • "wifi": {
    },
  • "captive_portal": {
    },
  • "throttle": {
    },
  • "dns": {
    },
  • "vpn": {
    }
}

DELETE

Deletes the queried SSID

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

ssid_id
required
integer <int64> >= 1

The unique identifier of the SSID to query.

Responses

CHANGELOG

Get an SSID's changelog

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

ssid_id
required
integer <int64> >= 1

The unique identifier of the SSID to query.

Responses

Response samples

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

UPDATE

Change an SSID

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

ssid_id
required
integer <int64> >= 1

The unique identifier of the SSID to query.

Request Body schema: application/json

Properties to change on the queried SSID

enable
boolean
Default: true

This setting activates or deactivates the SSID.

schedule_id
integer or null >= 1

When a schedule is configured, the SSID will only be enabled according to the schedule.

name
string [ 1 .. 32 ] characters

The default broadcast name for both 2.4GHz and 5GHz bands.

object or object
object
object or object or object
disabled (object) or enabled (object)
disabled (object) or service (object)
disabled (object) or object

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "schedule_id": 1,
  • "name": "string",
  • "wan": {
    },
  • "wifi": {
    },
  • "captive_portal": {
    },
  • "throttle": {
    },
  • "dns": {
    },
  • "vpn": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "enable": true,
  • "schedule_id": 1,
  • "name": "string",
  • "wan": {
    },
  • "wifi": {
    },
  • "captive_portal": {
    },
  • "throttle": {
    },
  • "dns": {
    },
  • "vpn": {
    }
}

CHANGELOG ENTRY

Get a changelog entry's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

ssid_id
required
integer <int64> >= 1

The unique identifier of the SSID to query.

entry_id
required
integer <int64> >= 1

The unique identifier of the changelog entry to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "enable": true,
  • "schedule_id": 1,
  • "name": "string",
  • "wan": {
    },
  • "wifi": {
    },
  • "captive_portal": {
    },
  • "throttle": {
    },
  • "dns": {
    },
  • "vpn": {
    }
}

Vlans

LIST

Returns all VLANs in the queried network

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

query Parameters
search
string

Fulltext search across all the object's fields.

Responses

Response samples

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

CREATE

Create a new VLAN

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Request Body schema: application/json

Details of the VLAN to add

enable
boolean
Default: true

This setting activates or deactivates the VLAN.

name
required
string [ 1 .. 128 ] characters

A name identifying this VLAN.

tags
required
Array of integers [ 1 .. 4094 ] items [ items [ 1 .. 4094 ] ]

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "name": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "enable": true,
  • "name": "string",
  • "tags": [
    ]
}

DETAILS

Get an VLAN's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

vlan_id
required
integer <int64> >= 1

The unique identifier of the VLAN to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "enable": true,
  • "name": "string",
  • "tags": [
    ]
}

DELETE

Deletes the queried VLAN

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

vlan_id
required
integer <int64> >= 1

The unique identifier of the VLAN to query.

Responses

CHANGELOG

Get an VLAN's changelog

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

vlan_id
required
integer <int64> >= 1

The unique identifier of the VLAN to query.

Responses

Response samples

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

UPDATE

Change an VLAN

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

vlan_id
required
integer <int64> >= 1

The unique identifier of the VLAN to query.

Request Body schema: application/json

Properties to change on the queried VLAN

enable
boolean
Default: true

This setting activates or deactivates the VLAN.

name
string [ 1 .. 128 ] characters

A name identifying this VLAN.

tags
Array of integers [ 1 .. 4094 ] items [ items [ 1 .. 4094 ] ]

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "name": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "enable": true,
  • "name": "string",
  • "tags": [
    ]
}

CHANGELOG ENTRY

Get a changelog entry's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

vlan_id
required
integer <int64> >= 1

The unique identifier of the VLAN to query.

entry_id
required
integer <int64> >= 1

The unique identifier of the changelog entry to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "creator": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "enable": true,
  • "name": "string",
  • "tags": [
    ]
}

Floorplans

LIST

Returns all floorplans

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

query Parameters
search
string

Fulltext search across all the object's fields.

Responses

Response samples

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

CREATE

Create a new floorplan

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

Request Body schema: application/json

Floorplan to be added.

name
required
string <= 128 characters

A unique name identifying this floorplan.

description
string or null <= 1024 characters

Field for additional information about the floorplan.

object
order
integer or null >= 0

The order number can be assigned arbitrarily by the API user, allowing for differentiation of display order beyond alphabetical name sorting.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "location": {
    },
  • "order": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "location": {
    },
  • "order": 0
}

DETAILS

Get a floorplan's details

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

floorplan_id
required
integer <int64> >= 1

The unique identifier of the floorplan to query.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "location": {
    },
  • "order": 0
}

UPDATE

Change a floorplan

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

floorplan_id
required
integer <int64> >= 1

The unique identifier of the floorplan to query.

Request Body schema: application/json

Properties to change on the queried floorplan

name
string <= 128 characters

A unique name identifying this floorplan.

description
string or null <= 1024 characters

Field for additional information about the floorplan.

object
order
integer or null >= 0

The order number can be assigned arbitrarily by the API user, allowing for differentiation of display order beyond alphabetical name sorting.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "location": {
    },
  • "order": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "location": {
    },
  • "order": 0
}

DELETE

Deletes the queried floorplan

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

floorplan_id
required
integer <int64> >= 1

The unique identifier of the floorplan to query.

Responses

IMAGE GET

Get a floorplans's image

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

floorplan_id
required
integer <int64> >= 1

The unique identifier of the floorplan to query.

Responses

Response samples

Content type
application/json
{
  • "creator": {
    },
  • "creation_date": null,
  • "image": "string"
}

IMAGE SET

Change a floorplan's image

Authorizations:
oAuth
path Parameters
organisation_id
required
integer <int64> >= 1

The unique identifier of the organisation to query.

network_id
required
integer <int64> >= 1

The unique identifier of the network to query.

floorplan_id
required
integer <int64> >= 1

The unique identifier of the floorplan to query.

Request Body schema: application/json

Properties to change on the queried floorplan

image
string or null <= 7864320 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

The floorplan image (in base64 format).

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "creator": {
    },
  • "creation_date": null,
  • "image": "string"
}

Lookup

DEVICES

device details for provided MAC addresses

Authorizations:
oAuth
Request Body schema: application/json

list of MAC addresses

required
Array of objects non-empty

Responses

Request samples

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

Response samples

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

OUI

vendor details for provided OUIs

Authorizations:
oAuth
Request Body schema: application/json

list of OUIs

required
Array of objects non-empty

Responses

Request samples

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

Response samples

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

FIRMWARE LABELS

Available firmware labels

Authorizations:
oAuth

Responses

Response samples

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

TIMEZONES

Supported timezones

Authorizations:
oAuth

Responses

Response samples

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