Skip to content

Lightbug Documentation

Search K

Main Navigation

Cloud App lightbug.cloud

Admin App admin.lightbug.cloud

Web APIs api.lightbug.cloud

Chasm Share share.chasm.cloud

On Premise Guides

Appearance

Sidebar Navigation

APIs

Getting Started

Base URLs

Authentication

Rate Limits

Version 2

Authentication

POST Login

POST Logout

POST Refresh token

Access Tokens

GET List personal access tokens

POST Create a new personal access token

DELETE Delete a personal access token

Plans

GET Summary of plans

GET Summary of plans

PUT Sets plans for multiple devices in bulk

GET Gets plans that are available for devices

POST Purchases plans

POST Claims a device

GET Purchased plans

GET User's plans

GET Gets a device plan

PUT Sets a device plan

DELETE Deletes a device plan

Devices

GET Gets devices

GET Gets the current firmware of a device

GET Gets the current update that is queued for a device

POST Requests that a device be updated to the given firmware channel and or version

DELETE Removes a request for a firmware update on a device

GET Gets tags of a device

GET Gets tag of a device

PUT Updates or creates a device tag

DELETE Deletes a tag of a device

GET Timeline of specific type for device

Chasm

GET WebSocket

GET Device WebSocket

Geofences

GET Gets a list of geofences

PUT Creates a new geofence

GET Gets a single geofence

DELETE Deletes a single geofence

Geofence Lists

GET Gets geofence lists

PUT Creates a geofence list

GET Gets a geofence list

DELETE Deletes a geofence list

POST Shares a geofence list

PUT Adds a user to a geofence list

DELETE Removes a user from a geofence list

DELETE Deletes a geofence from a list

PUT Puts a geofence on a list

Version 1

Glossary

Datapoints

sendReason

alertType

ErrorCode

Readings

Device Settings

behaviour

modeControl

modeControl2

Filtering

SDKs

Authentication

POST Login

Devices

GET Get device

GET Queries devices of user.

GET Summary of devices

GET Devices in zone

GET Devices with tag

PUT Update a related item by id for gatewayReadings.

POST Change tags for a device

Device Activation

GET Deactivate device

Device Configuration

GET Retrieve configuration for a device

PUT Update configuration for a device

GET Set flight mode for a device

POST Update safe-zone for device

GET Get safe-zone for device

GET Configure SQS Notifications for a device

GET Set meta item for a device

Points

GET Get device points

GET Get device point by id

DELETE Delete device point by id

Readings

GET Get device reading by id

DELETE Delete device reading by id

GET Get device readings

Gateway readings

GET Get device gateway reading by id

Notifications

GET Get device trigger by id

PUT Update device trigger by id

DELETE Delete device trigger by id

GET Get device triggers

POST Create device trigger

DELETE Delete all device triggers

GET Get recent activity for a user

Geofences

GET Get user geofence by id

PUT Update user geofence by id

DELETE Delete user geofence by id

GET Get user geofences

POST Create user geofence

DELETE Delete all user geofences

Reports

POST Vehicle Summary

POST Device Activity

RTK

GET Retrieve rtk status and config object for a device

GET Get recent log events from rtk service

GET Retrieve a command by messageId to check status

GET Change the update interval

GET Trigger an alert now on the device

GET Trigger a prompt now on the device (response sent via MQTT)

GET Reboot Rtk Module (useful for fixing multipath hysteresis issues)

GET Set point buffer size

GET External BaseStation Status Change

GET Set the NTRIP settings for a device.

Device Misc

GET Queries messages of device.

POST Send a new message to the device

DELETE Delete all messages for a device

GET GET /devices/{id}/nearbyDevices

GET GET /devices/{id}/nearbyDeviceData

On this page

SDKs

You can find some auto generated SDKs for the Version 1 API in various languages on Github.

Javascript (Node)
Javascript (React)
PHP
Python
C#

Pager

Previous pageFiltering

Next page POST Login