Search…
Gateway Service
get
https://localhost:16001/api/v1
/devices
Returns a list of devices.
get
https://localhost:16001/api/v1
/commands
Returns a list of commands.
delete
https://localhost:16001/api/v1
/commands
Delete some commands
get
https://localhost:16001/api/v1
/command/{commandUUID}
Returns a specific command.
delete
https://localhost:16001/api/v1
/command/{commandUUID}
Delete a specific command.
get
https://localhost:16001/api/v1
/default_configurations
Retrieve the lists of all default configurations.
get
https://localhost:16001/api/v1
/default_configuration/{name}
Retrieve a default configuration.
post
https://localhost:16001/api/v1
/default_configuration/{name}
Create a default configuration.
put
https://localhost:16001/api/v1
/default_configuration/{name}
Update a default configuration
delete
https://localhost:16001/api/v1
/default_configuration/{name}
Delete a default default configuration
get
https://localhost:16001/api/v1
/device/{serialNumber}
Retrieve information for a single device.
post
https://localhost:16001/api/v1
/device/{serialNumber}
Create a new device.
put
https://localhost:16001/api/v1
/device/{serialNumber}
Update a device.
delete
https://localhost:16001/api/v1
/device/{serialNumber}
Delete a single device.
get
https://localhost:16001/api/v1
/device/{serialNumber}/logs
Get the latest logs for a given device
delete
https://localhost:16001/api/v1
/device/{serialNumber}/logs
Delete some device logs.
get
https://localhost:16001/api/v1
/device/{serialNumber}/healthchecks
Get the latest health checks for a given device.
delete
https://localhost:16001/api/v1
/device/{serialNumber}/healthchecks
Delete some device health checks.
get
https://localhost:16001/api/v1
/device/{serialNumber}/capabilities
Get the latest capabilities for a given device.
delete
https://localhost:16001/api/v1
/device/{serialNumber}/capabilities
Delete the capabilities for a given device.
get
https://localhost:16001/api/v1
/device/{serialNumber}/statistics
Get the latest statistics for a given device.
delete
https://localhost:16001/api/v1
/device/{serialNumber}/statistics
Get the latest statistics for a given device.
get
https://localhost:16001/api/v1
/device/{serialNumber}/status
Get the latest status for a given device.
post
https://localhost:16001/api/v1
/device/{serialNumber}/command
Post a command to a device
post
https://localhost:16001/api/v1
/device/{serialNumber}/configure
Configure a device.
post
https://localhost:16001/api/v1
/device/{serialNumber}/upgrade
Upgrade a device.
post
https://localhost:16001/api/v1
/device/{serialNumber}/reboot
Reboot a device.
post
https://localhost:16001/api/v1
/device/{serialNumber}/factory
Factory reset a device.
post
https://localhost:16001/api/v1
/device/{serialNumber}/leds
Blink the LEDs on a device.
post
https://localhost:16001/api/v1
/device/{serialNumber}/trace
Launch a trace for a device.
post
https://localhost:16001/api/v1
/device/{serialNumber}/wifiscan
Launch a wifi scan for a device.
post
https://localhost:16001/api/v1
/device/{serialNumber}/request
Request a specific message
post
https://localhost:16001/api/v1
/device/{serialNumber}/eventqueue
Request a list of queued events.
post
https://localhost:16001/api/v1
/device/{serialNumber}/telemetry
Request a telemetry stream.
get
https://localhost:16001/api/v1
/ouis
Get a list of OUIs.
get
https://localhost:16001/api/v1
/device/{serialNumber}/rtty
Get the rtty parameters to initiate a session.
get
https://localhost:16001/api/v1
/file/{uuid}
Get a file from the upload directory.
delete
https://localhost:16001/api/v1
/file/{uuid}
Delete a file from the upload directory.
get
https://localhost:16001/api/v1
/blacklist
Returns a list blacklisted devices.
get
https://localhost:16001/api/v1
/blacklist/{serialNumber}
Returns a blacklist entry.
post
https://localhost:16001/api/v1
/blacklist/{serialNumber}
Create to the blacklist.
put
https://localhost:16001/api/v1
/blacklist/{serialNumber}
Modify to the blacklist.
delete
https://localhost:16001/api/v1
/blacklist/{serialNumber}
Delete from the blacklist.
get
https://localhost:16001/api/v1
/capabilities
Get the list of device types and capabilities.
get
https://localhost:16001/api/v1
/deviceDashboard
Get the last version of the dashboard.
get
https://localhost:16001/api/v1
/system
Retrieve different values from the running service.
post
https://localhost:16001/api/v1
/system
Perform some system wide commands.
Export as PDF
Copy link
On this page
get
/devices
get
/commands
delete
/commands
get
/command/{commandUUID}
delete
/command/{commandUUID}
get
/default_configurations
get
/default_configuration/{name}
post
/default_configuration/{name}
put
/default_configuration/{name}
delete
/default_configuration/{name}
get
/device/{serialNumber}
post
/device/{serialNumber}
put
/device/{serialNumber}
delete
/device/{serialNumber}
get
/device/{serialNumber}/logs
delete
/device/{serialNumber}/logs
get
/device/{serialNumber}/healthchecks
delete
/device/{serialNumber}/healthchecks
get
/device/{serialNumber}/capabilities
delete
/device/{serialNumber}/capabilities
get
/device/{serialNumber}/statistics
delete
/device/{serialNumber}/statistics
get
/device/{serialNumber}/status
post
/device/{serialNumber}/command
post
/device/{serialNumber}/configure
post
/device/{serialNumber}/upgrade
post
/device/{serialNumber}/reboot
post
/device/{serialNumber}/factory
post
/device/{serialNumber}/leds
post
/device/{serialNumber}/trace
post
/device/{serialNumber}/wifiscan
post
/device/{serialNumber}/request
post
/device/{serialNumber}/eventqueue
post
/device/{serialNumber}/telemetry
get
/ouis
get
/device/{serialNumber}/rtty
get
/file/{uuid}
delete
/file/{uuid}
get
/blacklist
get
/blacklist/{serialNumber}
post
/blacklist/{serialNumber}
put
/blacklist/{serialNumber}
delete
/blacklist/{serialNumber}
get
/capabilities
get
/deviceDashboard
get
/system
post
/system