Gateway Service

PreviousSecurity Service NextFirmware Management Service

Last updated 3 years ago

Was this helpful?

Returns a list of devices.

get

Get a list of devices.

Authorizations

Query parameters

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

serialOnlybooleanoptional

only serial numbers of full device details

countOnlybooleanoptional

return the number of devices

Example: countOnly=true

deviceWithStatusbooleanoptional

Return extra information with the device 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",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "createdTimestamp": 1,
      "lastConfigurationChange": 1,
      "lastConfigurationDownload": 1,
      "firmware": "text",
      "devicePassword": "text"
    }
  ]
}

List devices

Returns a list of commands.

get

Get a list of commands.

Authorizations

Query parameters

serialNumberstringoptional

startDateinteger · int64optional

endDateinteger · int64optional

offsetinteger · int64optional

limitinteger · int64optional

newestbooleanoptional

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

Authorizations

Query parameters

serialNumberstringrequired

startDateinteger · int64optional

endDateinteger · int64optional

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 Content

Successfully deleted commands for the device.

Returns a specific command.

get

Returns a specific command

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

Delete a specific command

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 Content

Delete command success

Retrieve the lists of all default configurations.

get

Retrieve the lists of all 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",
      "modelIds": "text",
      "description": "text",
      "configuration": "text",
      "created": 1,
      "lastModified": 1
    }
  ]
}

List of defautl configurations included

Retrieve a default configuration.

get

Retrieve a default configuration.

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",
  "modelIds": "text",
  "description": "text",
  "configuration": "text",
  "created": 1,
  "lastModified": 1
}

Default configurations included

Delete a default default configuration

delete

Delete a default default configuration

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.

get

Retrieve all the inforamtion about a single device

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",
  "notes": [
    {
      "created": 1,
      "createdBy": "text",
      "note": "text"
    }
  ],
  "createdTimestamp": 1,
  "lastConfigurationChange": 1,
  "lastConfigurationDownload": 1,
  "firmware": "text",
  "devicePassword": "text"
}

Device information

Delete a single device.

delete

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

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64optional

endDateinteger · int64optional

offsetinteger · int64optional

limitinteger · int64optional

logTypeinteger · int64optional

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

newestbooleanoptional

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

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64optional

endDateinteger · int64optional

logTypeinteger · int64optional

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 Content

Successfully deleted logs for the device.

Get the latest health checks for a given device.

get

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64optional

endDateinteger · int64optional

offsetinteger · int64optional

limitinteger · int64optional

newestbooleanoptional

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

lastOnlybooleanoptional

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

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64optional

endDateinteger · int64optional

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 Content

Successfully deleted health checks for the device.

Get the latest capabilities for a given device.

get

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

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 Content

List of logs for this device

Get the latest statistics for a given device.

get

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64optional

endDateinteger · int64optional

offsetinteger · int64optional

limitinteger · int64optional

lifetimebooleanoptional

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

lastOnlybooleanoptional

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

newestbooleanoptional

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

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64optional

endDateinteger · int64optional

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 Content

Array of statistics for this device

Get the latest status for a given device.

get

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

Get a list of OUIs.

get

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 Content

Get the rtty parameters to initiate a session.

get

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

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

binary

Succesfull file retrieval

Delete a file from the upload directory.

delete

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

Get a list of blacklisted devices.

Authorizations

Query parameters

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

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

Get a list of blacklisted devices.

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

Delete from the blacklist.

delete

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

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Successful command execution

Get the last version of the dashboard.

get

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 Content

Retrieve different values from the running service.

get

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Available options:

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

Create a default configuration.

post

Create a default configuration.

Authorizations

Path parameters

namestringrequired

Body

namestringoptional

modelIdsstringoptional

descriptionstringoptional

configurationstringoptional

createdinteger · int64optional

lastModifiedinteger · int64optional

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",
    "modelIds": "text",
    "description": "text",
    "configuration": "text",
    "created": 1,
    "lastModified": 1
  }'

200

403

404

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

The requested operation was performed.

Update a default configuration

put

Update a default configuration

Authorizations

Path parameters

namestringrequired

Body

namestringoptional

modelIdsstringoptional

descriptionstringoptional

configurationstringoptional

createdinteger · int64optional

lastModifiedinteger · int64optional

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",
    "modelIds": "text",
    "description": "text",
    "configuration": "text",
    "created": 1,
    "lastModified": 1
  }'

200

403

404

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

The requested operation was performed.

Create a new device.

post

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

validateOnlybooleanoptional

Body

Definition of uCentral device

ownerstring · uuidoptional

locationstring · uuidoptional

venuestring · uuidoptional

serialNumberstringoptional

deviceTypestring · enumrequiredDefault: APAvailable options:

macAddressstringoptional

manufacturerstringoptional

UUIDinteger · int64optional

configurationstringoptional

notesobject[]optional

createdTimestampinteger · int64optional

lastConfigurationChangeinteger · int64optional

lastConfigurationDownloadinteger · int64optional

firmwarestringoptional

devicePasswordstringoptional

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",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "createdTimestamp": 1,
    "lastConfigurationChange": 1,
    "lastConfigurationDownload": 1,
    "firmware": "text",
    "devicePassword": "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",
  "notes": [
    {
      "created": 1,
      "createdBy": "text",
      "note": "text"
    }
  ],
  "createdTimestamp": 1,
  "lastConfigurationChange": 1,
  "lastConfigurationDownload": 1,
  "firmware": "text",
  "devicePassword": "text"
}

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

Update a device.

put

Authorizations

Path parameters

serialNumberstringrequired

Body

Definition of uCentral device

ownerstring · uuidoptional

locationstring · uuidoptional

venuestring · uuidoptional

serialNumberstringoptional

deviceTypestring · enumrequiredDefault: APAvailable options:

macAddressstringoptional

manufacturerstringoptional

UUIDinteger · int64optional

configurationstringoptional

notesobject[]optional

createdTimestampinteger · int64optional

lastConfigurationChangeinteger · int64optional

lastConfigurationDownloadinteger · int64optional

firmwarestringoptional

devicePasswordstringoptional

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",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "createdTimestamp": 1,
    "lastConfigurationChange": 1,
    "lastConfigurationDownload": 1,
    "firmware": "text",
    "devicePassword": "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",
  "notes": [
    {
      "created": 1,
      "createdBy": "text",
      "note": "text"
    }
  ],
  "createdTimestamp": 1,
  "lastConfigurationChange": 1,
  "lastConfigurationDownload": 1,
  "firmware": "text",
  "devicePassword": "text"
}

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

Post a command to a device

post

Authorizations

Path parameters

serialNumberstringrequired

Body

commandstringoptional

payloadstringoptional

wheninteger · int64optional

serialNumberstringoptional

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 Content

Configure a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

UUIDinteger · int64optional

configurationstringoptional

wheninteger · int64optional

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 Content

Upgrade a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

uristringoptional

serialNumberstringoptional

wheninteger · int64optional

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

200

403

404

No Content

Reboot a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

wheninteger · int64optional

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 Content

Factory reset a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

wheninteger · int64optional

keepRedirectorbooleanoptional

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 Content

Blink the LEDs on a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

wheninteger · int64optional

durationinteger · int64optional

only applies to the blink pattern

patternstring · enumoptionalAvailable options:

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 Content

Launch a trace for a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

wheninteger · int64optional

durationinteger · int64optional

numberOfPacketsinteger · int64optional

networkstringoptional

interfacestringoptional

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 Content

Launch a wifi scan for a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringrequired

verbosebooleanoptional

activeScanbooleanoptional

selectorone ofoptional

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,
    "selector": {
      "bands": [
        "2"
      ]
    }
  }'

200

403

404

No Content

Request a specific message

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

wheninteger · int64optional

messagestring · enumoptionalAvailable options:

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 Content

The command was submitted succesfully.

Request a list of queued events.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

typesstring · enum[]optional

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 Content

Request a telemetry stream.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

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

typesstring · enum[]optional

uuidstringoptionalExample: only valid when terminating a stream

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": "0 - means to stop streaming, values 1-120 in seconds.",
    "types": [
      "dhcp-snooping"
    ],
    "uuid": "only valid when terminating a stream"
  }'

200

403

404

No Content

Create to the blacklist.

post

Authorizations

Path parameters

serialNumberstringrequired

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

Body

serialNumberstringoptional

createdinteger · int64read-onlyoptional

authorstringread-onlyoptional

reasonstringoptional

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",
    "reason": "text"
  }'

200

403

404

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

The requested operation was performed.

Modify to the blacklist.

put

Authorizations

Path parameters

serialNumberstringrequired

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

Body

serialNumberstringoptional

createdinteger · int64read-onlyoptional

authorstringread-onlyoptional

reasonstringoptional

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",
    "reason": "text"
  }'

200

403

404

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

The requested operation was performed.

Perform some system wide commands.

post

Authorizations

Body

one ofoptional

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

Returns a list of devices.

Returns a list of commands.

Delete some commands

Returns a specific command.

Delete a specific command.

Retrieve the lists of all default configurations.

Retrieve a default configuration.

Delete a default default configuration

Retrieve information for a single device.

Delete a single device.

Get the latest logs for a given device

Delete some device logs.

Get the latest health checks for a given device.

Delete some device health checks.

Get the latest capabilities for a given device.

Delete the capabilities for a given device.

Get the latest statistics for a given device.

Get the latest statistics for a given device.

Get the latest status for a given device.

Get a list of OUIs.

Get the rtty parameters to initiate a session.

Get a file from the upload directory.

Delete a file from the upload directory.

Returns a list blacklisted devices.

Returns a blacklist entry.

Delete from the blacklist.

Get the list of device types and capabilities.

Get the last version of the dashboard.

Retrieve different values from the running service.

Create a default configuration.

Update a default configuration

Create a new device.

Show child attributes

Update a device.

Show child attributes

Post a command to a device

Configure a device.

Upgrade a device.

Reboot a device.

Factory reset a device.

Blink the LEDs on a device.

Launch a trace for a device.

Launch a wifi scan for a device.

Show child attributes

Show child attributes

Request a specific message

Request a list of queued events.

Show child attributes

Request a telemetry stream.

Show child attributes

Create to the blacklist.

Modify to the blacklist.

Perform some system wide commands.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes