Gateway Service

PreviousSecurity Service NextFirmware Management Service

Last updated 3 years ago

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

one ofoptional

Definition of uCentral device list

Definition of uCentral device list including device status.

List of serial numbers.

The number of devices in the DB.

application/json

get

GET /api/v1/devices HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

{
  "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"
    }
  ]
}

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

objectoptional

application/json

get

GET /api/v1/commands HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

{
  "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"
    }
  ]
}

Delete some commands

delete

Authorizations

Query parameters

serialNumberstringrequired

startDateinteger · int64optional

endDateinteger · int64optional

Responses

application/json

anyoptional

The requested operation was performed.

application/json

delete

DELETE /api/v1/commands HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Returns a specific command.

get

Returns a specific command

Authorizations

Path parameters

commandUUIDstring · uuidrequired

Responses

application/json

objectoptional

application/json

get

GET /api/v1/command/{commandUUID} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Delete a specific command.

delete

Delete a specific command

Authorizations

Path parameters

commandUUIDstring · uuidrequired

Responses

application/json

anyoptional

The requested operation was performed.

application/json

delete

DELETE /api/v1/command/{commandUUID} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Retrieve the lists of all default configurations.

get

Retrieve the lists of all default configurations.

Authorizations

Responses

application/json

objectoptional

application/json

get

GET /api/v1/default_configurations HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Retrieve a default configuration.

get

Retrieve a default configuration.

Authorizations

Path parameters

namestringrequired

Responses

application/json

objectoptional

application/json

get

GET /api/v1/default_configuration/{name} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Delete a default default configuration

delete

Delete a default default configuration

Authorizations

Path parameters

namestringrequired

Responses

application/json

objectoptional

application/json

delete

DELETE /api/v1/default_configuration/{name} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Retrieve information for a single device.

get

Retrieve all the inforamtion about a single device

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

objectoptional

Definition of uCentral device

application/json

get

GET /api/v1/device/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Delete a single device.

delete

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

objectoptional

application/json

delete

DELETE /api/v1/device/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

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

objectoptional

application/json

get

GET /api/v1/device/{serialNumber}/logs HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

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

anyoptional

The requested operation was performed.

application/json

delete

DELETE /api/v1/device/{serialNumber}/logs HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

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

objectoptional

application/json

get

GET /api/v1/device/{serialNumber}/healthchecks HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Delete some device health checks.

delete

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64optional

endDateinteger · int64optional

Responses

application/json

anyoptional

The requested operation was performed.

application/json

delete

DELETE /api/v1/device/{serialNumber}/healthchecks HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Get the latest capabilities for a given device.

get

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

objectoptional

Describes the capabilities a device can support.

application/json

get

GET /api/v1/device/{serialNumber}/capabilities HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Delete the capabilities for a given device.

delete

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

anyoptional

The requested operation was performed.

application/json

delete

DELETE /api/v1/device/{serialNumber}/capabilities HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

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

one ofoptional

application/json

get

GET /api/v1/device/{serialNumber}/statistics HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Get the latest statistics for a given device.

delete

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

startDateinteger · int64optional

endDateinteger · int64optional

Responses

application/json

anyoptional

The requested operation was performed.

application/json

delete

DELETE /api/v1/device/{serialNumber}/statistics HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Get the latest status for a given device.

get

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

objectoptional

Current device status.

application/json

get

GET /api/v1/device/{serialNumber}/status HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

{
  "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,"
}

Get a list of OUIs.

get

Authorizations

Query parameters

macListstringrequired

Responses

application/json

get

GET /api/v1/ouis HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Get the rtty parameters to initiate a session.

get

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

objectoptional

application/json

get

GET /api/v1/device/{serialNumber}/rtty HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Get a file from the upload directory.

get

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

serialNumberstringrequired

Responses

application/octet-stream

string · binaryoptional

application/json

get

GET /api/v1/file/{uuid} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

binary

Delete a file from the upload directory.

delete

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

serialNumberstringrequired

Responses

application/json

objectoptional

application/json

delete

DELETE /api/v1/file/{uuid} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

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

objectoptional

application/json

get

GET /api/v1/blacklist HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

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

objectoptional

application/json

get

GET /api/v1/blacklist/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Delete from the blacklist.

delete

Authorizations

Path parameters

serialNumberstringrequired

Responses

application/json

objectoptional

application/json

delete

DELETE /api/v1/blacklist/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Get the list of device types and capabilities.

get

Authorizations

Responses

application/json

objectoptional

application/json

get

GET /api/v1/capabilities HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

Get the last version of the dashboard.

get

Authorizations

Responses

application/json

get

GET /api/v1/deviceDashboard HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Retrieve different values from the running service.

get

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Available options:

Responses

application/json

one ofoptional

application/json

get

GET /api/v1/system HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

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

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

objectoptional

application/json

post

POST /api/v1/default_configuration/{name} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 106

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

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

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

objectoptional

application/json

put

PUT /api/v1/default_configuration/{name} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 106

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

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

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

objectoptional

Definition of uCentral device

application/json

post

POST /api/v1/device/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 437

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

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

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

objectoptional

Definition of uCentral device

application/json

put

PUT /api/v1/device/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 437

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

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

Post a command to a device

post

Authorizations

Path parameters

serialNumberstringrequired

Body

commandstringoptional

payloadstringoptional

wheninteger · int64optional

serialNumberstringoptional

Responses

application/json

post

POST /api/v1/device/{serialNumber}/command HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "command": "text",
  "payload": "text",
  "when": 1,
  "serialNumber": "text"
}

No Content

Configure a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

UUIDinteger · int64optional

configurationstringoptional

wheninteger · int64optional

Responses

application/json

post

POST /api/v1/device/{serialNumber}/configure HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "serialNumber": "text",
  "UUID": 1,
  "configuration": "text",
  "when": 1
}

No Content

Upgrade a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

uristringoptional

serialNumberstringoptional

wheninteger · int64optional

Responses

application/json

post

POST /api/v1/device/{serialNumber}/upgrade HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "uri": "text",
  "serialNumber": "text",
  "when": 1
}

No Content

Reboot a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

wheninteger · int64optional

Responses

application/json

post

POST /api/v1/device/{serialNumber}/reboot HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "serialNumber": "text",
  "when": 1
}

No Content

Factory reset a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

wheninteger · int64optional

keepRedirectorbooleanoptional

Responses

application/json

post

POST /api/v1/device/{serialNumber}/factory HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "serialNumber": "text",
  "when": 1,
  "keepRedirector": true
}

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

post

POST /api/v1/device/{serialNumber}/leds HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "serialNumber": "text",
  "when": 1,
  "duration": 1,
  "pattern": "on"
}

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

post

POST /api/v1/device/{serialNumber}/trace HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "serialNumber": "text",
  "when": 1,
  "duration": 1,
  "numberOfPackets": 1,
  "network": "text",
  "interface": "text"
}

No Content

Launch a wifi scan for a device.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringrequired

verbosebooleanoptional

activeScanbooleanoptional

selectorone ofoptional

Responses

application/json

post

POST /api/v1/device/{serialNumber}/wifiscan HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "serialNumber": "text",
  "verbose": true,
  "activeScan": true,
  "selector": {
    "bands": [
      "2"
    ]
  }
}

No Content

Request a specific message

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

wheninteger · int64optional

messagestring · enumoptionalAvailable options:

Responses

application/json

post

POST /api/v1/device/{serialNumber}/request HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "serialNumber": "text",
  "when": 1,
  "message": "state"
}

No Content

Request a list of queued events.

post

Authorizations

Path parameters

serialNumberstringrequired

Body

serialNumberstringoptional

typesstring · enum[]optional

Responses

application/json

post

POST /api/v1/device/{serialNumber}/eventqueue HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "serialNumber": "text",
  "types": [
    "dhcp"
  ]
}

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

post

POST /api/v1/device/{serialNumber}/telemetry HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "serialNumber": "text",
  "interval": "0 - means to stop streaming, values 1-120 in seconds.",
  "types": [
    "dhcp-snooping"
  ],
  "uuid": "only valid when terminating a stream"
}

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

objectoptional

application/json

post

POST /api/v1/blacklist/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39

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

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

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

objectoptional

application/json

put

PUT /api/v1/blacklist/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39

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

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

Perform some system wide commands.

post

Authorizations

Body

one ofoptional

Responses

application/json

one ofoptional

application/json

post

POST /api/v1/system HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "command": "setloglevel",
  "subsystems": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}

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