Skip to content

Lightbug Documentation

Search K

Main Navigation Home Basics Devices

On Premise Guides

Appearance

Sidebar Navigation

APIs

Getting Started

Base URLs

Authentication

Rate Limits

Version 2

Authentication

POST Login

POST Logout

POST Refresh token

Users

POST Purchases plans

POST Claims a device

GET Summary of plans

Devices

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

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

POST Change tags for a 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 Set SQS forwarding 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

PUT Update 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

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

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

MQTT

GET MQTT Credentials

Device Misc

GET Queries messages of device.

POST Send a new message to the device

DELETE Delete all messages for a device

GET Queries transients of device.

GET GET /devices/id/nearbyDevices

GET GET /devices/id/nearbyDeviceData

Base URLs

Both APIs are accessible using the base URL https://api.lightbug.cloud.

Version 1 API, accessible at /api
Version 2 API, accessible at /v2

Pager