website logo
BlogPlansAbout UsCareersLogin
⌘K
Introduction
Getting started on Bytebeam Cloud
Concepts
Projects
Streams
Device Shadow
Device Metadata
Actions
Module Integration Guides
ESP32
Arduino
Console Guides
API Keys
Device Management
Dashboards
Streams (Tables)
Actions
Users
Roles
API Guide
Release Notes
R14 15-Sep-2023
R13 03-Aug-2023
R12 21-July-2023
R11 21-June-2023
R10 24-May-2023
R9 10-May-2023
R8 26-Apr-2023
R7 05-Apr-2023
R6 22-Mar-2023
R5 08-Mar-2023
R4 22-Feb-2023
R3 10-Feb-2023
R2 01-Feb-2023
R1 19-Jan-2023
Docs powered by
Archbee

API Guide

2min

Our Postman collection is available for you to try out all our available API endpoints.

Everything you are able to do in UI, is available as API endpoint. Each postman request titled according to the resource it will help you fetch.

Step 1: fork the collection to your own workspace

Document image


Step 2: Once you have added your API key, you can also change the host variable to the correct Bytebeam url.

For example, if you have a tenant in https://cloud.bytebeam.io then set the host variable to https://cloud.bytebeam.io. Ensure that the API Key you add to the collection variable is available in your tenant in https://cloud.bytebeam.io

Step 3: You can try out the requests under each section.

Note: Every request in the collection is automated to some extent. Please feel free to edit the body as per your requirements.

Updating your forked collection

We continuously add new API endpoints and make available new examples. As you have forked our collection, you may need to download changes from our collection. See how to Pull Changes from a postman collection.

Updated 13 Sep 2023
Did this page help you?
PREVIOUS
Developer API keys
NEXT
R14 15-Sep-2023
Docs powered by
Archbee
TABLE OF CONTENTS
Updating your forked collection
Docs powered by
Archbee