/oauth2. Once you obtain
access-token, you will need to pass it in the headers under
Authorization: Bearer <place your token here>.
default_configurations. To retrieve a list of
devicesto know what is available and then use the endpoint
deviceto access all device specific information. To retrieve
default_configurationsfollow those endpoints. Most operations rely on the
serialNumberof a device. That
serialNumberis unique and generated on the device. Serial Number matches the device's MAC address.
devices: The list of all devices in the system. This maybe very large, pagination is recommended.
commands: The list of commands issued by the system. This list could also be large.
default_configurations: A list of default configurations used to supply existing devices.
logs: Specific for a device. Logs originate from the device or associated with the device by some mechanism.
healthchecks: Reports from the device coming periodically after device self tests.
statistics: Periodically produced by the devices and document actual state data from each device.
capabilities: This details the actual data model supported by the device.
deviceentry point is also used to query about the
statusof the device and used to inject certain commands for a specific device. Commands supported for each device:
reboot: This will force the device to reboot.
configure: Configure sends a new configuration to a device.
factory: Forces the device to perform a factory-reset.
upgrade: Forces the device to do a firmware upgrade.
leds: Ask the device to flash its LEDs or turn them on or off.
trace: Performs a remove LAN trace. Once the trace is completed, the produced file may be removed using the
command: Performs a proprietary command. The meaning depends on the device.
request: Request an immediate message of type
fileend point is used to retrieve and remove files produced by the Gateway. Currently this is limited to the results of a
tracecommand. The file name will always match the
uuidof the command that produced it. If several files are needed, the files will be named
whenparameter to suggest to the device when to perform the command. This is a suggestion only. The device may decide to perform the command when it is optimal for itself. It maybe busy doing something and decline to do a reboot for several minutes for example. The device may reply with the actual
whenit will perform the command.