Introduction to API Keys

Bytebeam Docs

A guide on how to get started with Bytebeam Cloud.

Signup

Welcome to the Bytebeam Platform Guide

Steps on how to set up and start using Bytebeam Arduino SDK.

Setting up BytebeamArduino SDK

Learn how you can push data to Bytebeam console.

Pushing data to Bytebeam

Learn how to create action handlers and map them to specific actions in the Bytebeam platform with this comprehensive document. It includes a code snippet for creating a handler for the "ToggleLED" action and mapping it. Additionally, discover three usefu

Receiving actions

Guide that covers everything you need to know about Over the Air Firmware Upgrades with Bytebeam Arduino.

Integrate Over the Air Updates

Guide will show you how to setup your project for GSM connectivity.

Setting up BytebeamArduino for GSM Connectivity

Customise the SDK as per your requirements by configuring the Bytebeam Aurdino via begin method

Advanced SDK Configurations

Learn how to easily install the bytebeam-esp-idf-sdk using PlatformIO with this comprehensive document. Follow step-by-step instructions using either the intuitive PlatformIO GUI or the convenient PlatformIO Core CLI. Ensure a smooth installation by choos

PlatformIO Integration

Learn how to connect your device to the Bytebeam cloud with this step-by-step guide. Start by creating an account on Bytebeam, then download the device configuration JSON file. Rename the file to "device.json" and store it in the "download" partition of y

Connect to Bytebeam cloud

Learn how to push temperature data from your device to the Bytebeam cloud with step-by-step instructions in this document. It includes Python and JavaScript scripts, diagrams, and screenshots along with examples. The code provided consists of a combinatio

Learn about streams and device shadows in client applications with this document. Discover how default parameters like timestamp and sequence number are pushed to the device shadow stream. Explore the possibility of creating custom device shadow streams w

Customising device shadow

Learn how to effectively use the actions feature of Bytebeam cloud on your Linux device with this comprehensive guide. Discover step-by-step instructions on creating a "reboot" action and gaining control over the uplink through essential commands. Harness

Receiving Actions

Learn how to access the Linux device shell via Bytebeam cloud using tunshell tool. Follow our guide to easily navigate to the Bytebeam cloud, select your preferred device, and effortlessly access the remote shell option under the Operations section. Gain

Remote login to your Linux device

Learn how to update the configuration of your device using Bytebeam cloud with this comprehensive guide. Follow the step-by-step instructions to access the device management section, create a new device config, and confirm your selection. Use the provided

Integrate Config Updates

Learn how to effectively view journalctl logs on Bytebeam cloud with this comprehensive document. Discover the step-by-step instructions on setting up streams and dashboards, adding logging to devices, and configuring logging from the cloud. Detailed scre

Push application logs

Learn how to setup our device sdk on your android devices

Device Setup

Learn how to push data to streams using ByteBeam Client with this comprehensive document. Includes a Rust code example for publishing data, emphasizing the need for JSON serialization. Discover the best practices, including omitting "id" and "timestamp" f

Integrate config updates

Connecting to Bytebeam cloud

Implementing over the air updates

Get the list of devices - paginated.

Return the count of devices for pagination

Allows update status of a device

Find devices by device state keys

Trigger an action on a bunch of devices.

Get action for device

Get params for an action

Return stats about the progress of various devices this action was triggered on

Return logs of actions per device

Return paginated progress of actions per device

Request to trigger actions; someone with permission will approve

Approve an action

Mark all actions for devices matching the filters as completed

Mark a subset of devices for an action as completed

Attempt cancelling this action

Get apiv1actions error stats

Post apiv1actions device latencies

Get apiv1actions device latenciesstates

Retry an action on some devices

Return all pending actions for devices matching the given filters

Returns a list of all action types

Creates a new action-type

Updates an existing action type

Delete an action-type

Update metadata(s) for a device(s)

Takes a csv file and updates the metadata for a device

Mark an existing metadata-key as serial number

Returns a csv file template for updating metadata for a device

Get a list of metadata-keys

Create a metadata-key

Delete a metadata-key

Provision a device. returns cert & keys

Download cert for a device given device-id

Return the list of all firmwares

Create firmware version

Updates firmware version to be activated or deactivated 

Download a firmware by version

HEAD endpoint to check metadata about file download

Download a firmware by component name and version

Return the list of firmwares for components

Return the list of all firmware versions of given component

Get the list of Device Configurations

Create new Device Configuration

Get device config by version name

Get apiv1devicesstate keys

Search device by metadata

Updates the status of the action triggered on the device

Get metadata key and available options

Get device actions given device id

Returns available filters for searching actions of a device

Mark all device actions given device id as completed

Get all device components

Show overall progress of actions triggered

Takes a filter and returns parameters matching that filter

Get apiv1firmware bundles

Post apiv1firmware bundles

Get apiv1firmware bundlesid

Put apiv1firmware bundlesid

Delete apiv1firmware bundlesid

Get apiv1firmware bundlesversion

Put apiv1firmware bundlesversion

Delete apiv1firmware bundlesversion

Get apiv1firmware bundles artifact

Head apiv1firmware bundles artifact

Returns list of tenants

Create a new tenant

Get auth details given tenant id

Store tenant's end user authentication method

Request authorization for tenant

Get list of timezones supported by dashboard CSV export

Get apiv1log tags

Detailed data for micelio stats panel

Get share options for the user

Get tables and columns available for querying

Get all alert types

Get all alert rules

Create alert rule

Get all alert groups

Get alert notification rule

Update alert notification rule

Delete alert notification rule

Create alert notification rule

Test alert notification rule

Update alert rule

Delete alert rule

Start alert rule

Stop alert rule

Get all session types

Create session type

Start session type

Stop session type

Delete session type

Called by dkron repeatedly for a scheduled action until it is finished. It retries failed actions if needed and updates schedule status

append fixed-list phase to a schedule

get schedule for an action

Get all DBCs for tenant

Creates a DBC

Post apiv1dbcs diff

Put apiv1dbcs update

Get info about a single DBC given id

Update DBC settings

Delete a single DBC given id

Get dbc file for a DBC given id

Get parsed version of a DBC given id

Start Parser

Stop Parser

Just a test route

Get all audit Logs

Get all the Dashboard logs

Get logs of a specific dashboard

Get all the Metadata logs

Get Metadata log for a key

Get all Role logs

Get logs of a role

Get mockapiv1actions

Post mockapiv1actions

Post mockapiv2actions

Get logout

Ping-pong end point

Get metrics

Return the list of all uploaded files (respects RBAC)

Create a new file (respects RBAC)

The Endpoint the device hits to download the file (respects RBAC)

Get dashboards API

Create dashboard API

Get dashboard API

Update dashboard

Delete dashboard API

Get data for panels given in body

Get data for a single panel given in the body

Get current User object

Get settings

Update user settings

Update tenant settings

Get users and their roles

Create a new user

Get user given existing id

Update a user given existing id

Delete a user given existing id

Get list of roles

Create role

Get a single role given role-id

Update role given role-id

Delete role given role-id

Get all existing streams in clickhouse database

Creates a stream on clickhouse database

Get all fields given existing stream name in clickhouse database

Delete a stream on clickhouse database

Delete a field given existing stream name in clickhouse database

Create a field given a existing stream name in clickhouse database

Rename a stream field

Update an existing field's type

Post apiv1streamsfixprotobuff

Get apiv1streamsqueries

Get apiv1streamsqueries 1

Return protobuff for all streams in clickhouse database

Creates computed stream

Return full detail of streams with fields including if they are computed, along with their code and parent streams

Platform Guide

Introduction to API Keys

Create an API Key

Delete an API Key