Gateway Service

PreviousSecurity Service NextFirmware Management Service

Last updated 1 year ago

Was this helpful?

Returns a list of devices.

Get a list of devices.

get

/devices

Authorizations

Query parameters

offsetinteger

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

limitinteger

Maximum number of entries to return (if absent, no limit is assumed)

filterstring

Filter the results

selectstring

Supply a list of devices comma separated

Example: serial1,serial2,serial3

serialOnlyboolean

only serial numbers of full device details

countOnlyboolean

return the number of devices

Example: countOnly=true

deviceWithStatusboolean

Return extra information with the device information

orderBystring

return extended information

Example: serialNumber:a,created:d

orderSpecboolean · default: false

return extended information

connectionStatisticsboolean · default: false

return extended information

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/devices' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "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",
      "UUID": 1,
      "configuration": "text",
      "createdTimestamp": 1,
      "lastConfigurationChange": 1,
      "lastConfigurationDownload": 1,
      "firmware": "text",
      "devicePassword": "text",
      "subscriber": "123e4567-e89b-12d3-a456-426614174000",
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "modified": 1,
      "locale": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ]
    }
  ]
}

List devices

Returns a list of commands.

Get a list of commands.

get

/commands

Authorizations

Query parameters

serialNumberstring

startDateinteger · int64

endDateinteger · int64

offsetinteger · int64

limitinteger · int64

newestboolean

Selecting this option means the newest record will be returned. Use limit to select how many.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/commands' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "commands": [
    {
      "UUID": "123e4567-e89b-12d3-a456-426614174000",
      "command": "text",
      "details": "text",
      "serialNumber": "text",
      "submitted": 1,
      "executed": 1,
      "completed": 1,
      "when": 1,
      "errorText": "text",
      "results": "text",
      "errorCode": 1,
      "submittedBy": "text",
      "status": "text",
      "custom": 1,
      "waitingForFile": 1,
      "attachFile": 1,
      "attachSize": 1,
      "attachType": "text"
    }
  ]
}

List commands

Delete some commands

delete

/commands

Authorizations

Query parameters

serialNumberstringrequired

startDateinteger · int64

endDateinteger · int64

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/commands?serialNumber=text' \
  --header 'Authorization: Bearer JWT'

204

403

404

No body

Successfully deleted commands for the device.

Returns a specific command.

Returns a specific command

get

/command/{commandUUID}

Authorizations

Path parameters

commandUUIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/command/{commandUUID}' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "UUID": "123e4567-e89b-12d3-a456-426614174000",
  "command": "text",
  "details": "text",
  "serialNumber": "text",
  "submitted": 1,
  "executed": 1,
  "completed": 1,
  "when": 1,
  "errorText": "text",
  "results": "text",
  "errorCode": 1,
  "submittedBy": "text",
  "status": "text",
  "custom": 1,
  "waitingForFile": 1,
  "attachFile": 1,
  "attachSize": 1,
  "attachType": "text"
}

List commands

Delete a specific command.

Delete a specific command

delete

/command/{commandUUID}

Authorizations

Path parameters

commandUUIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/command/{commandUUID}' \
  --header 'Authorization: Bearer JWT'

204

403

404

No body

Delete command success

Retrieve the lists of all default configurations.

get

/default_configurations

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/default_configurations' \
  --header 'Authorization: Bearer JWT'

200

403

404

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

List of defautl configurations included

Retrieve a default configuration.

get

/default_configuration/{name}

Authorizations

Path parameters

namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/default_configuration/{name}' \
  --header 'Authorization: Bearer JWT'

200

403

404

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

Default configurations included

Create a default configuration.

post

/default_configuration/{name}

Authorizations

Path parameters

namestringrequired

Body

namestring

descriptionstring

configurationstring

createdinteger · int64

lastModifiedinteger · int64

modelIdsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/default_configuration/{name}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "configuration": "text",
    "created": 1,
    "lastModified": 1,
    "modelIds": [
      "text"
    ]
  }'

200

403

404

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

The requested operation was performed.

Update a default configuration

put

/default_configuration/{name}

Authorizations

Path parameters

namestringrequired

Body

namestring

descriptionstring

configurationstring

createdinteger · int64

lastModifiedinteger · int64

modelIdsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16001/api/v1/default_configuration/{name}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "configuration": "text",
    "created": 1,
    "lastModified": 1,
    "modelIds": [
      "text"
    ]
  }'

200

403

404

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

The requested operation was performed.

Delete a default default configuration

delete

/default_configuration/{name}

Authorizations

Path parameters

namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/default_configuration/{name}' \
  --header 'Authorization: Bearer JWT'

204

403

404

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

The requested operation was performed.

Retrieve information for a single device.

Retrieve all the inforamtion about a single device

get

/device/{serialNumber}

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "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",
  "UUID": 1,
  "configuration": "text",
  "createdTimestamp": 1,
  "lastConfigurationChange": 1,
  "lastConfigurationDownload": 1,
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "modified": 1,
  "locale": "text",
  "notes": [
    {
      "created": 1,
      "createdBy": "text",
      "note": "text"
    }
  ]
}

Device information

Create a new device.

post

/device/{serialNumber}

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

validateOnlyboolean

Body

ownerstring · uuid

locationstring · uuid

venuestring · uuid

serialNumberstring

deviceTypestring · enum · default: APrequired

Options: AP, SWITCH, IOT, MESH

macAddressstring

manufacturerstring

UUIDinteger · int64

configurationstring

createdTimestampinteger · int64

lastConfigurationChangeinteger · int64

lastConfigurationDownloadinteger · int64

firmwarestring

devicePasswordstring

subscriberstring · uuid

entitystring · uuid

modifiedinteger · int64

localestring · min: 2 · max: 2

notesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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",
    "UUID": 1,
    "configuration": "text",
    "createdTimestamp": 1,
    "lastConfigurationChange": 1,
    "lastConfigurationDownload": 1,
    "firmware": "text",
    "devicePassword": "text",
    "subscriber": "123e4567-e89b-12d3-a456-426614174000",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "modified": 1,
    "locale": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ]
  }'

200

403

404

{
  "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",
  "UUID": 1,
  "configuration": "text",
  "createdTimestamp": 1,
  "lastConfigurationChange": 1,
  "lastConfigurationDownload": 1,
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "modified": 1,
  "locale": "text",
  "notes": [
    {
      "created": 1,
      "createdBy": "text",
      "note": "text"
    }
  ]
}

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

Update a device.

put

/device/{serialNumber}

Authorizations

Path parameters

serialNumberstringrequired

Body

ownerstring · uuid

locationstring · uuid

venuestring · uuid

serialNumberstring

deviceTypestring · enum · default: APrequired

Options: AP, SWITCH, IOT, MESH

macAddressstring

manufacturerstring

UUIDinteger · int64

configurationstring

createdTimestampinteger · int64

lastConfigurationChangeinteger · int64

lastConfigurationDownloadinteger · int64

firmwarestring

devicePasswordstring

subscriberstring · uuid

entitystring · uuid

modifiedinteger · int64

localestring · min: 2 · max: 2

notesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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",
    "UUID": 1,
    "configuration": "text",
    "createdTimestamp": 1,
    "lastConfigurationChange": 1,
    "lastConfigurationDownload": 1,
    "firmware": "text",
    "devicePassword": "text",
    "subscriber": "123e4567-e89b-12d3-a456-426614174000",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "modified": 1,
    "locale": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ]
  }'

200

403

404

{
  "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",
  "UUID": 1,
  "configuration": "text",
  "createdTimestamp": 1,
  "lastConfigurationChange": 1,
  "lastConfigurationDownload": 1,
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "modified": 1,
  "locale": "text",
  "notes": [
    {
      "created": 1,
      "createdBy": "text",
      "note": "text"
    }
  ]
}

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

Delete a single device.

delete

/device/{serialNumber}

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}' \
  --header 'Authorization: Bearer JWT'

204

403

404

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

The requested operation was performed.

Get the latest logs for a given device

get

/device/{serialNumber}/logs

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64

endDateinteger · int64

offsetinteger · int64

limitinteger · int64

logTypeinteger · int64

0=any kind of logs (default) 0=normal logs only 1=crash logs only

newestboolean

Selecting this option means the newest record will be returned. Use limit to select how many.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/logs' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "serialNumber": "text",
  "values": [
    {
      "log": "text",
      "recorded": 1,
      "severity": 1,
      "data": "text",
      "logType": 1,
      "UUID": 1
    }
  ]
}

Array of device logs for this device

Delete some device logs.

delete

/device/{serialNumber}/logs

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64

endDateinteger · int64

logTypeinteger · int64

0=any kind of logs (default) 1=normal logs only 2=crash logs only

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/logs' \
  --header 'Authorization: Bearer JWT'

204

403

404

No body

Successfully deleted logs for the device.

Get the latest health checks for a given device.

get

/device/{serialNumber}/healthchecks

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64

endDateinteger · int64

offsetinteger · int64

limitinteger · int64

newestboolean

Selecting this option means the newest record will be returned. Use limit to select how many.

lastOnlyboolean

Selecting this option means the last healthcheck will be returned. All other parameters will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/healthchecks' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "serialNumber": "text",
  "values": [
    {
      "UUID": 1,
      "sanity": 1,
      "data": "text",
      "recorded": 1
    }
  ]
}

Array of device health checks for this device

Delete some device health checks.

delete

/device/{serialNumber}/healthchecks

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64

endDateinteger · int64

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/healthchecks' \
  --header 'Authorization: Bearer JWT'

204

403

404

No body

Successfully deleted health checks for the device.

Get the latest capabilities for a given device.

get

/device/{serialNumber}/capabilities

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/capabilities' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "serialNumber": "text",
  "capabilities": "text",
  "lastUpdate": 1,
  "firstUpdate": 1
}

List of logs for this device

Delete the capabilities for a given device.

delete

/device/{serialNumber}/capabilities

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/capabilities' \
  --header 'Authorization: Bearer JWT'

204

403

404

No body

List of logs for this device

Get the latest statistics for a given device.

get

/device/{serialNumber}/statistics

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64

endDateinteger · int64

offsetinteger · int64

limitinteger · int64

lastOnlyboolean

Selecting this option means the Last Statistics block

newestboolean

Selecting this option means the newest record will be returned. Use limit to select how many.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/statistics' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "serialNumber": "text",
  "values": [
    {
      "serialNumber": "text",
      "recorded": 1,
      "UUID": 1,
      "data": "text"
    }
  ]
}

Array of statistics for this device

Get the latest statistics for a given device.

delete

/device/{serialNumber}/statistics

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64

endDateinteger · int64

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/statistics' \
  --header 'Authorization: Bearer JWT'

204

403

404

No body

Array of statistics for this device

Get the latest status for a given device.

get

/device/{serialNumber}/status

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/status' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "serialNumber": "text",
  "ipAddress": "text",
  "txBytes": 1,
  "rxBytes": 1,
  "messageCount": 1,
  "UUID": 1,
  "connected": true,
  "lastContact": 1,
  "firmware": "text",
  "associations_2G": 1,
  "associations_5G": 1,
  "verifiedCertificate": "NO_CERTIFICATE,"
}

Status for the given device

Post a command to a device

post

/device/{serialNumber}/command

Authorizations

Path parameters

serialNumberstringrequired

Body

commandstring

payloadstring

wheninteger · int64

serialNumberstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/command' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "command": "text",
    "payload": "text",
    "when": 1,
    "serialNumber": "text"
  }'

200

403

404

No body

Configure a device.

post

/device/{serialNumber}/configure

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

UUIDinteger · int64

configurationstring

wheninteger · int64

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/configure' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "UUID": 1,
    "configuration": "text",
    "when": 1
  }'

200

403

404

No body

Configure a device.

post

/device/{serialNumber}/ping

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/ping' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text"
  }'

200

403

404

{
  "serialNumber": "text",
  "currentUTCTime": 1,
  "deviceUTCTime": 1,
  "latency": 1,
  "configurationUUID": 1
}

Successfull ping os a device

Upgrade a device.

post

/device/{serialNumber}/upgrade

Authorizations

Path parameters

serialNumberstringrequired

Body

uristring

serialNumberstring

wheninteger · int64

keepRedirectorboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/upgrade' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "uri": "text",
    "serialNumber": "text",
    "when": 1,
    "keepRedirector": true
  }'

200

403

404

No body

Reboot a device.

post

/device/{serialNumber}/reboot

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

wheninteger · int64

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/reboot' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "when": 1
  }'

200

403

404

No body

Debug a device.

post

/device/{serialNumber}/script

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

timeoutinteger · int64 · default: 30

scriptstring

scriptIdstring · uuid

wheninteger · int64 · default: 0

typestring · enum

Options: uci, ucode, shell

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/script' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "timeout": 30,
    "script": "text",
    "scriptId": "123e4567-e89b-12d3-a456-426614174000",
    "when": 0,
    "type": "uci"
  }'

200

403

404

No body

Factory reset a device.

post

/device/{serialNumber}/factory

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

wheninteger · int64

keepRedirectorboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/factory' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "when": 1,
    "keepRedirector": true
  }'

200

403

404

No body

Blink the LEDs on a device.

post

/device/{serialNumber}/leds

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

wheninteger · int64

durationinteger · int64

only applies to the blink pattern

patternstring · enum

Options: on, off, blink

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/leds' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "when": 1,
    "duration": 1,
    "pattern": "on"
  }'

200

403

404

No body

Launch a trace for a device.

post

/device/{serialNumber}/trace

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

wheninteger · int64

durationinteger · int64

numberOfPacketsinteger · int64

networkstring

interfacestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/trace' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "when": 1,
    "duration": 1,
    "numberOfPackets": 1,
    "network": "text",
    "interface": "text"
  }'

200

403

404

No body

Launch a wifi scan for a device.

post

/device/{serialNumber}/wifiscan

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringrequired

verboseboolean

activeScanboolean

iesinteger[]

selectorone of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/wifiscan' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "verbose": true,
    "activeScan": true,
    "ies": [
      1
    ],
    "selector": {
      "bands": [
        "2"
      ]
    }
  }'

200

403

404

No body

Request a specific message

post

/device/{serialNumber}/request

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

wheninteger · int64

messagestring · enum

Options: state, healthcheck

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/request' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "when": 1,
    "message": "state"
  }'

200

403

404

No body

The command was submitted succesfully.

Request a list of queued events.

post

/device/{serialNumber}/eventqueue

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstring

typesstring · enum[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/eventqueue' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "types": [
      "dhcp"
    ]
  }'

200

403

404

No body

Request a telemetry stream.

post

/device/{serialNumber}/telemetry

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

statusOnlyboolean · default: false

Body

serialNumberstring

intervalinteger

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

lifetimeinteger · int64

how long should the telemetry run

kafkaboolean · default: false

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

uuidstring · uuid

only valid when terminating a stream

typesstring · enum[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/telemetry' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "interval": 1,
    "lifetime": 1,
    "kafka": false,
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "types": [
      "dhcp-snooping"
    ]
  }'

200

403

404

No body

Get a list of OUIs.

get

/ouis

Authorizations

Query parameters

macListstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/ouis?macList=text' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Get the rtty parameters to initiate a session.

get

/device/{serialNumber}/rtty

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/device/{serialNumber}/rtty' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "serialNumber": "text",
  "server": "text",
  "port": 1,
  "token": "text",
  "timeout": 1,
  "connectionId": "text",
  "started": 1,
  "commandUUID": "text",
  "viewport": 1,
  "password": "text"
}

Session information

Get a file from the upload directory.

get

/file/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

serialNumberstringrequired

Responses

application/octet-stream

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/file/{uuid}?serialNumber=text' \
  --header 'Authorization: Bearer JWT'

200

403

404

text

Succesfull file retrieval

Delete a file from the upload directory.

delete

/file/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

serialNumberstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/file/{uuid}?serialNumber=text' \
  --header 'Authorization: Bearer JWT'

204

403

404

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

The requested operation was performed.

Returns a list blacklisted devices.

Get a list of blacklisted devices.

get

/blacklist

Authorizations

Query parameters

offsetinteger

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

limitinteger

Maximum number of entries to return (if absent, no limit is assumed)

filterstring

Filter the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/blacklist' \
  --header 'Authorization: Bearer JWT'

200

403

404

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

List blacklisted devices

Returns a blacklist entry.

Get a list of blacklisted devices.

get

/blacklist/{serialNumber}

Authorizations

Path parameters

serialNumberstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/blacklist/{serialNumber}' \
  --header 'Authorization: Bearer JWT'

200

403

404

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

List blacklisted devices

Create to the blacklist.

post

/blacklist/{serialNumber}

Authorizations

Path parameters

serialNumberstringrequired

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

Body

serialNumberstring

createdinteger · int64

authorstring

reasonstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/blacklist/{serialNumber}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "created": 1,
    "author": "text",
    "reason": "text"
  }'

200

403

404

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

The requested operation was performed.

Modify to the blacklist.

put

/blacklist/{serialNumber}

Authorizations

Path parameters

serialNumberstringrequired

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

Body

serialNumberstring

createdinteger · int64

authorstring

reasonstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16001/api/v1/blacklist/{serialNumber}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "serialNumber": "text",
    "created": 1,
    "author": "text",
    "reason": "text"
  }'

200

403

404

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

The requested operation was performed.

Delete from the blacklist.

delete

/blacklist/{serialNumber}

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/blacklist/{serialNumber}' \
  --header 'Authorization: Bearer JWT'

204

403

404

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

The requested operation was performed.

Get the list of device types and capabilities.

get

/capabilities

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/capabilities' \
  --header 'Authorization: Bearer JWT'

200

403

404

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

Successful command execution

Retrieve RADIUS Proxy configuration.

get

/radiusProxyConfig

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/radiusProxyConfig' \
  --header 'Authorization: Bearer JWT'

200

403

No body

Modify RADIUS Proxy configuration.

put

/radiusProxyConfig

Authorizations

Body

poolsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16001/api/v1/radiusProxyConfig' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "pools": [
      {
        "name": "text",
        "description": "text",
        "authConfig": {
          "monitor": false,
          "strategy": "random",
          "monitorMethod": "none",
          "methodParameters": [
            "text"
          ],
          "servers": [
            {
              "name": "text",
              "ip": "text",
              "port": 1,
              "weight": 1,
              "secret": "text",
              "certificate": "text",
              "radsec": false,
              "radsecPort": 1,
              "radsecSecret": "text",
              "radsecCert": "text",
              "radsecKey": "text",
              "ignore": false,
              "radsecCacerts": [
                "text"
              ],
              "radsecRealms": [
                "text"
              ]
            }
          ]
        },
        "acctConfig": {
          "monitor": false,
          "strategy": "random",
          "monitorMethod": "none",
          "methodParameters": [
            "text"
          ],
          "servers": [
            {
              "name": "text",
              "ip": "text",
              "port": 1,
              "weight": 1,
              "secret": "text",
              "certificate": "text",
              "radsec": false,
              "radsecPort": 1,
              "radsecSecret": "text",
              "radsecCert": "text",
              "radsecKey": "text",
              "ignore": false,
              "radsecCacerts": [
                "text"
              ],
              "radsecRealms": [
                "text"
              ]
            }
          ]
        },
        "coaConfig": {
          "monitor": false,
          "strategy": "random",
          "monitorMethod": "none",
          "methodParameters": [
            "text"
          ],
          "servers": [
            {
              "name": "text",
              "ip": "text",
              "port": 1,
              "weight": 1,
              "secret": "text",
              "certificate": "text",
              "radsec": false,
              "radsecPort": 1,
              "radsecSecret": "text",
              "radsecCert": "text",
              "radsecKey": "text",
              "ignore": false,
              "radsecCacerts": [
                "text"
              ],
              "radsecRealms": [
                "text"
              ]
            }
          ]
        }
      }
    ]
  }'

200

403

No body

Delete RADIUS Proxy configuration.

delete

/radiusProxyConfig

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/radiusProxyConfig' \
  --header 'Authorization: Bearer JWT'

204

403

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

The requested operation was performed.

Get the last version of the dashboard.

get

/deviceDashboard

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/deviceDashboard' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Get the country code for an IP address

get

/iptocountry

Authorizations

Query parameters

ipliststringrequired

Example: 10.2.2.2,10.3.4.3

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/iptocountry?iplist=10.2.2.2%2C10.3.4.3' \
  --header 'Authorization: Bearer JWT'

200

403

404

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

List of country codes.

Retrieve different values from the running service.

get

/system

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Options: info

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/system?command=info' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "version": "text",
  "uptime": 1,
  "start": 1,
  "os": "text",
  "processors": 1,
  "hostname": "text",
  "certificates": [
    {
      "filename": "text",
      "expires": 1
    }
  ]
}

Successful command execution

Perform some system wide commands.

post

/system

Authorizations

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/system' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "command": "setloglevel",
    "subsystems": [
      {
        "tag": "text",
        "value": "text"
      }
    ]
  }'

200

403

404

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

Successful command execution