Gateway Service

Returns a list of devices.

Get a list of devices.

GEThttps://localhost:16001/api/v1/devices

Query parameters

Response

200403404

List devices

Body

application/json

one of

DeviceList (object)DeviceListWithStatus (object)SerialNumberList (object)DeviceCount (object)DeviceConnectionStatistics (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/devices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "devices": [
    {
      "owner": "123e4567-e89b-12d3-a456-426614174000",
      "location": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "123e4567-e89b-12d3-a456-426614174000",
      "serialNumber": "text",
      "deviceType": "AP",
      "macAddress": "text",
      "manufacturer": "text",
      "configuration": "text",
      "notes": [
        {
          "createdBy": "text",
          "note": "text"
        }
      ],
      "firmware": "text",
      "devicePassword": "text",
      "subscriber": "123e4567-e89b-12d3-a456-426614174000",
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "locale": "text"
    }
  ]
}

Returns a list of commands.

Get a list of commands.

GEThttps://localhost:16001/api/v1/commands

Query parameters

Response

200403404

List commands

Body

application/json

commandsarray of CommandInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/commands', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "commands": [
    {
      "UUID": "123e4567-e89b-12d3-a456-426614174000",
      "command": "text",
      "details": "text",
      "serialNumber": "text",
      "errorText": "text",
      "results": "text",
      "submittedBy": "text",
      "status": "text",
      "attachType": "text"
    }
  ]
}

Delete some commands

DELETEhttps://localhost:16001/api/v1/commands

Query parameters

Response

204403404

Successfully deleted commands for the device.

Body

application/json

Success (any)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/commands?serialNumber=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Returns a specific command.

Returns a specific command

GEThttps://localhost:16001/api/v1/command/{commandUUID}

Path parameters

commandUUID*string (uuid)

Response

200403404

List commands

Body

application/json

UUIDstring (uuid)

commandstring

detailsstring

serialNumberstring

submittedinteger (int64)

executedinteger (int64)

completedinteger (int64)

wheninteger (int64)

errorTextstring

resultsstring

errorCodeinteger (int64)

submittedBystring

statusstring

custominteger (int64)

waitingForFileinteger (int64)

attachFileinteger (int64)

attachSizeinteger (int64)

attachTypestring

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/command/{commandUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "UUID": "123e4567-e89b-12d3-a456-426614174000",
  "command": "text",
  "details": "text",
  "serialNumber": "text",
  "errorText": "text",
  "results": "text",
  "submittedBy": "text",
  "status": "text",
  "attachType": "text"
}

Delete a specific command.

Delete a specific command

DELETEhttps://localhost:16001/api/v1/command/{commandUUID}

Path parameters

commandUUID*string (uuid)

Response

204403404

Delete command success

Body

application/json

Success (any)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/command/{commandUUID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve the lists of all default configurations.

Retrieve the lists of all default configurations.

GEThttps://localhost:16001/api/v1/default_configurations

Response

200403404

List of defautl configurations included

Body

application/json

configurationsarray of DefaultConfiguration (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/default_configurations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "configurations": [
    {
      "name": "text",
      "modelIds": [
        "text"
      ],
      "description": "text",
      "configuration": "text"
    }
  ]
}

Retrieve a default configuration.

Retrieve a default configuration.

GEThttps://localhost:16001/api/v1/default_configuration/{name}

Path parameters

name*string

Response

200403404

Default configurations included

Body

application/json

namestring

modelIdsarray of string

descriptionstring

configurationstring

createdinteger (int64)

lastModifiedinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/default_configuration/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "name": "text",
  "modelIds": [
    "text"
  ],
  "description": "text",
  "configuration": "text"
}

Create a default configuration.

Create a default configuration.

POSThttps://localhost:16001/api/v1/default_configuration/{name}

Path parameters

name*string

Body

application/json

Information used to create the new device

namestring

modelIdsarray of string

descriptionstring

configurationstring

createdinteger (int64)

lastModifiedinteger (int64)

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/default_configuration/{name}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Update a default configuration

Update a default configuration

PUThttps://localhost:16001/api/v1/default_configuration/{name}

Path parameters

name*string

Body

application/json

Configuration details

namestring

modelIdsarray of string

descriptionstring

configurationstring

createdinteger (int64)

lastModifiedinteger (int64)

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/default_configuration/{name}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete a default default configuration

Delete a default default configuration

DELETEhttps://localhost:16001/api/v1/default_configuration/{name}

Path parameters

name*string

Response

204403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/default_configuration/{name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve information for a single device.

Retrieve all the inforamtion about a single device

GEThttps://localhost:16001/api/v1/device/{serialNumber}

Path parameters

serialNumber*string

Response

200403404

Device information

Body

application/json

ownerstring (uuid)

locationstring (uuid)

venuestring (uuid)

serialNumberstring

deviceType*DeviceType (enum)

APSWITCHIOTMESH

macAddressstring

manufacturerstring

UUIDinteger (int64)

configurationstring

notesarray of NoteInfo (object)

createdTimestampinteger (int64)

lastConfigurationChangeinteger (int64)

lastConfigurationDownloadinteger (int64)

firmwarestring

devicePasswordstring

subscriberstring (uuid)

entitystring (uuid)

modifiedinteger (int64)

localestring

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "owner": "123e4567-e89b-12d3-a456-426614174000",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "serialNumber": "text",
  "deviceType": "AP",
  "macAddress": "text",
  "manufacturer": "text",
  "configuration": "text",
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ],
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "locale": "text"
}

Create a new device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}

Path parameters

serialNumber*string

Query parameters

Body

application/json

Information used to create the new device

ownerstring (uuid)

locationstring (uuid)

venuestring (uuid)

serialNumberstring

deviceType*DeviceType (enum)

APSWITCHIOTMESH

macAddressstring

manufacturerstring

UUIDinteger (int64)

configurationstring

notesarray of NoteInfo (object)

createdTimestampinteger (int64)

lastConfigurationChangeinteger (int64)

lastConfigurationDownloadinteger (int64)

firmwarestring

devicePasswordstring

subscriberstring (uuid)

entitystring (uuid)

modifiedinteger (int64)

localestring

Response

200403404

Successful device creation will return the device record with the proper device ID

Body

application/json

ownerstring (uuid)

locationstring (uuid)

venuestring (uuid)

serialNumberstring

deviceType*DeviceType (enum)

APSWITCHIOTMESH

macAddressstring

manufacturerstring

UUIDinteger (int64)

configurationstring

notesarray of NoteInfo (object)

createdTimestampinteger (int64)

lastConfigurationChangeinteger (int64)

lastConfigurationDownloadinteger (int64)

firmwarestring

devicePasswordstring

subscriberstring (uuid)

entitystring (uuid)

modifiedinteger (int64)

localestring

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deviceType": "AP"
    }),
});
const data = await response.json();

Response

200

{
  "owner": "123e4567-e89b-12d3-a456-426614174000",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "serialNumber": "text",
  "deviceType": "AP",
  "macAddress": "text",
  "manufacturer": "text",
  "configuration": "text",
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ],
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "locale": "text"
}

Update a device.

PUThttps://localhost:16001/api/v1/device/{serialNumber}

Path parameters

serialNumber*string

Body

application/json

Information used to create the new device

ownerstring (uuid)

locationstring (uuid)

venuestring (uuid)

serialNumberstring

deviceType*DeviceType (enum)

APSWITCHIOTMESH

macAddressstring

manufacturerstring

UUIDinteger (int64)

configurationstring

notesarray of NoteInfo (object)

createdTimestampinteger (int64)

lastConfigurationChangeinteger (int64)

lastConfigurationDownloadinteger (int64)

firmwarestring

devicePasswordstring

subscriberstring (uuid)

entitystring (uuid)

modifiedinteger (int64)

localestring

Response

200403404

Successful device creation will return the device record with the proper device ID

Body

application/json

ownerstring (uuid)

locationstring (uuid)

venuestring (uuid)

serialNumberstring

deviceType*DeviceType (enum)

APSWITCHIOTMESH

macAddressstring

manufacturerstring

UUIDinteger (int64)

configurationstring

notesarray of NoteInfo (object)

createdTimestampinteger (int64)

lastConfigurationChangeinteger (int64)

lastConfigurationDownloadinteger (int64)

firmwarestring

devicePasswordstring

subscriberstring (uuid)

entitystring (uuid)

modifiedinteger (int64)

localestring

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deviceType": "AP"
    }),
});
const data = await response.json();

Response

200

{
  "owner": "123e4567-e89b-12d3-a456-426614174000",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "serialNumber": "text",
  "deviceType": "AP",
  "macAddress": "text",
  "manufacturer": "text",
  "configuration": "text",
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ],
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "locale": "text"
}

Delete a single device.

DELETEhttps://localhost:16001/api/v1/device/{serialNumber}

Path parameters

serialNumber*string

Response

204403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

403404

{
  "ErrorCode": 0,
  "ErrorDetails": "text",
  "ErrorDescription": "text"
}

Get the latest logs for a given device

GEThttps://localhost:16001/api/v1/device/{serialNumber}/logs

Path parameters

serialNumber*string

Query parameters

Response

200403404

Array of device logs for this device

Body

application/json

serialNumberstring

valuesarray of DeviceLog (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "serialNumber": "text",
  "values": [
    {
      "log": "text",
      "data": "text"
    }
  ]
}

Delete some device logs.

DELETEhttps://localhost:16001/api/v1/device/{serialNumber}/logs

Path parameters

serialNumber*string

Query parameters

Response

204403404

Successfully deleted logs for the device.

Body

application/json

Success (any)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/logs', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get the latest health checks for a given device.

GEThttps://localhost:16001/api/v1/device/{serialNumber}/healthchecks

Path parameters

serialNumber*string

Query parameters

Response

200403404

Array of device health checks for this device

Body

application/json

serialNumberstring

valuesarray of HealthCheck (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/healthchecks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "serialNumber": "text",
  "values": [
    {
      "data": "text"
    }
  ]
}

Delete some device health checks.

DELETEhttps://localhost:16001/api/v1/device/{serialNumber}/healthchecks

Path parameters

serialNumber*string

Query parameters

Response

204403404

Successfully deleted health checks for the device.

Body

application/json

Success (any)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/healthchecks', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get the latest capabilities for a given device.

GEThttps://localhost:16001/api/v1/device/{serialNumber}/capabilities

Path parameters

serialNumber*string

Response

200403404

List of logs for this device

Body

application/json

serialNumberstring

capabilitiesstring

lastUpdateinteger (int64)

firstUpdateinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/capabilities', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "serialNumber": "text",
  "capabilities": "text"
}

Delete the capabilities for a given device.

DELETEhttps://localhost:16001/api/v1/device/{serialNumber}/capabilities

Path parameters

serialNumber*string

Response

204403404

List of logs for this device

Body

application/json

Success (any)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/capabilities', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get the latest statistics for a given device.

GEThttps://localhost:16001/api/v1/device/{serialNumber}/statistics

Path parameters

serialNumber*string

Query parameters

Response

200403404

Array of statistics for this device

Body

application/json

one of

StatisticsRecords (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/statistics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "serialNumber": "text",
  "values": [
    {
      "serialNumber": "text",
      "data": "text"
    }
  ]
}

Get the latest statistics for a given device.

DELETEhttps://localhost:16001/api/v1/device/{serialNumber}/statistics

Path parameters

serialNumber*string

Query parameters

Response

204403404

Array of statistics for this device

Body

application/json

Success (any)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/statistics', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get the latest status for a given device.

GEThttps://localhost:16001/api/v1/device/{serialNumber}/status

Path parameters

serialNumber*string

Response

200403404

Status for the given device

Body

application/json

serialNumberstring

ipAddressstring

txBytesinteger (int64)

rxBytesinteger (int64)

messageCountinteger (int64)

UUIDinteger (int64)

connectedboolean

lastContactinteger (int64)

firmwarestring

associations_2Ginteger (int64)

associations_5Ginteger (int64)

verifiedCertificateenum

NO_CERTIFICATE,VALID_CERTIFICATE,MISMATCH_SERIAL,VERIFIED

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "serialNumber": "text",
  "ipAddress": "text",
  "connected": false,
  "firmware": "text",
  "verifiedCertificate": "NO_CERTIFICATE,"
}

Post a command to a device

POSThttps://localhost:16001/api/v1/device/{serialNumber}/command

Path parameters

serialNumber*string

Body

application/json

Command details

commandstring

payloadstring

wheninteger (int64)

serialNumberstring

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/command', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Configure a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/configure

Path parameters

serialNumber*string

Body

application/json

Command details

serialNumberstring

UUIDinteger (int64)

configurationstring

wheninteger (int64)

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/configure', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Configure a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/ping

Path parameters

serialNumber*string

Body

application/json

Command details

serialNumberstring

Response

200403404

Successfull ping os a device

Body

application/json

serialNumberstring

currentUTCTimeinteger (int64)

deviceUTCTimeinteger (int64)

latencynumber

configurationUUIDinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/ping', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "serialNumber": "text",
  "latency": 0
}

Upgrade a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/upgrade

Path parameters

serialNumber*string

Body

application/json

Command details

uristring

serialNumberstring

wheninteger (int64)

keepRedirectorboolean

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/upgrade', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Reboot a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/reboot

Path parameters

serialNumber*string

Body

application/json

Command details

serialNumberstring

wheninteger (int64)

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/reboot', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Debug a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/script

Path parameters

serialNumber*string

Body

application/json

Command details

serialNumberstring

timeoutinteger (int64)

typeenum

uciucodeshell

scriptstring

scriptIdstring (uuid)

wheninteger (int64)

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/script', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Factory reset a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/factory

Path parameters

serialNumber*string

Body

application/json

Command details

serialNumberstring

wheninteger (int64)

keepRedirectorboolean

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/factory', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Blink the LEDs on a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/leds

Path parameters

serialNumber*string

Body

application/json

Command details

serialNumberstring

wheninteger (int64)

durationinteger (int64)

only applies to the blink pattern

patternenum

onoffblink

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/leds', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Launch a trace for a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/trace

Path parameters

serialNumber*string

Body

application/json

Command details

serialNumberstring

wheninteger (int64)

durationinteger (int64)

numberOfPacketsinteger (int64)

networkstring

interfacestring

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/trace', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Launch a wifi scan for a device.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/wifiscan

Path parameters

serialNumber*string

Body

application/json

Scan details

serialNumber*string

verboseboolean

activeScanboolean

selectorone of

WifiBands (object)WifiChannels (object)

iesarray of integer

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/wifiscan', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "serialNumber": "text"
    }),
});
const data = await response.json();

Request a specific message

POSThttps://localhost:16001/api/v1/device/{serialNumber}/request

Path parameters

serialNumber*string

Body

application/json

Message request details

serialNumberstring

wheninteger (int64)

messageenum

statehealthcheck

Response

200403404

The command was submitted succesfully.

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/request', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Request a list of queued events.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/eventqueue

Path parameters

serialNumber*string

Body

application/json

Message request details

serialNumberstring

typesarray of enum

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/eventqueue', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Request a telemetry stream.

POSThttps://localhost:16001/api/v1/device/{serialNumber}/telemetry

Path parameters

serialNumber*string

Query parameters

Body

application/json

Message request details

serialNumberstring

intervalinteger

0 - means to stop streaming, values 1-120 in seconds.

lifetimeinteger (int64)

how long should the telemetry run

kafkaboolean

set to true to start kafka telemetry, false to start websocket telemetry

typesarray of enum

uuidstring (uuid)

only valid when terminating a stream

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/telemetry', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get a list of OUIs.

GEThttps://localhost:16001/api/v1/ouis

Query parameters

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/ouis?macList=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get the rtty parameters to initiate a session.

GEThttps://localhost:16001/api/v1/device/{serialNumber}/rtty

Path parameters

serialNumber*string

Response

200403404

Session information

Body

application/json

serialNumberstring

serverstring

portinteger (int32)

tokenstring

timeoutinteger (int32)

connectionIdstring

startedinteger (int64)

commandUUIDstring

viewportinteger (int32)

passwordstring

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/rtty', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "serialNumber": "text",
  "server": "text",
  "token": "text",
  "connectionId": "text",
  "commandUUID": "text",
  "password": "text"
}

Get a file from the upload directory.

GEThttps://localhost:16001/api/v1/file/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

200403404

Succesfull file retrieval

Body

application/octet-stream

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/file/{uuid}?serialNumber=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

binary

Delete a file from the upload directory.

DELETEhttps://localhost:16001/api/v1/file/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

204403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/file/{uuid}?serialNumber=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Returns a list blacklisted devices.

Get a list of blacklisted devices.

GEThttps://localhost:16001/api/v1/blacklist

Query parameters

Response

200403404

List blacklisted devices

Body

application/json

devicesarray of BlackDeviceInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/blacklist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "devices": [
    {
      "serialNumber": "text",
      "author": "text",
      "reason": "text"
    }
  ]
}

Returns a blacklist entry.

Get a list of blacklisted devices.

GEThttps://localhost:16001/api/v1/blacklist/{serialNumber}

Path parameters

serialNumber*string

Pagination start (starts at 1. If not specified, 1 is assumed)

Response

200403404

List blacklisted devices

Body

application/json

serialNumberstring

createdinteger (int64)

authorstring

reasonstring

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/blacklist/{serialNumber}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "serialNumber": "text",
  "author": "text",
  "reason": "text"
}

Create to the blacklist.

POSThttps://localhost:16001/api/v1/blacklist/{serialNumber}

Path parameters

serialNumber*string

Pagination start (starts at 1. If not specified, 1 is assumed)

Body

application/json

Add blacklisted device

serialNumberstring

createdinteger (int64)

authorstring

reasonstring

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/blacklist/{serialNumber}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Modify to the blacklist.

PUThttps://localhost:16001/api/v1/blacklist/{serialNumber}

Path parameters

serialNumber*string

Pagination start (starts at 1. If not specified, 1 is assumed)

Body

application/json

Add blacklisted devices

serialNumberstring

createdinteger (int64)

authorstring

reasonstring

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/blacklist/{serialNumber}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete from the blacklist.

DELETEhttps://localhost:16001/api/v1/blacklist/{serialNumber}

Path parameters

serialNumber*string

Response

204403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/blacklist/{serialNumber}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404

{
  "ErrorDetails": "text",
  "ErrorDescription": "text"
}

Get the list of device types and capabilities.

GEThttps://localhost:16001/api/v1/capabilities

Response

200403404

Successful command execution

Body

application/json

device_typesarray of CapabilitiesModel (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/capabilities', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "device_types": [
    {
      "deviceType": "text",
      "capabilities": "text"
    }
  ]
}

Retrieve RADIUS Proxy configuration.

GEThttps://localhost:16001/api/v1/radiusProxyConfig

Response

200403

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/radiusProxyConfig', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Modify RADIUS Proxy configuration.

PUThttps://localhost:16001/api/v1/radiusProxyConfig

Body

application/json

Change RADIUS configuration pool config

poolsarray of RadiusProxyPool (object)

Response

200403

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/radiusProxyConfig', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete RADIUS Proxy configuration.

DELETEhttps://localhost:16001/api/v1/radiusProxyConfig

Response

204403

The requested operation was performed.

Body

application/json

Operationstring

Detailsstring

Codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/radiusProxyConfig', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

204403

{
  "Operation": "text",
  "Details": "text"
}

Get the last version of the dashboard.

GEThttps://localhost:16001/api/v1/deviceDashboard

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/deviceDashboard', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get the country code for an IP address

GEThttps://localhost:16001/api/v1/iptocountry

Query parameters

Response

200403404

List of country codes.

Body

application/json

enabledboolean

countryCodesarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/iptocountry?iplist=10.2.2.2%2C10.3.4.3', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "enabled": false,
  "countryCodes": [
    "text"
  ]
}

Retrieve different values from the running service.

GEThttps://localhost:16001/api/v1/system

Query parameters

Response

200403404

Successful command execution

Body

application/json

one of

SystemInfoResults (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/system?command=info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "version": "text",
  "os": "text",
  "hostname": "text",
  "certificates": [
    {
      "filename": "text"
    }
  ]
}

Perform some system wide commands.

POSThttps://localhost:16001/api/v1/system

Body

application/json

Command details

one of

SystemCommandSetLogLevel (object)SystemCommandReload (object)SystemCommandGetLogLevels (object)SystemCommandGetLogLevelNames (object)SystemCommandGetSubsystemNames (object)

Response

200403404

Successful command execution

Body

application/json

one of

SystemGetLogLevelsResult (object)SystemCommandGetLogLevelNamesResult (object)SystemGetSubSystemNamesResult (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16001/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}