API Guide
1min
Our swagger docs is available for you to try out all our available API endpoints.
Everything you are able to do in UI is available as an API endpoint. Each request is titled according to the resource it will help you fetch.
Step 1: Go to the URL
Swagger docs page
Step 2: Set the headers
Set the headers required by clicking the Authorize button.
Copy paste an api key in value section of x-bytebeam-api-key from settings-> API Keys from the portal and click authorize. Then add corresponding tenant name to value section of x-bytebeam-tenant-name and click authorize.
API Keys Section in portal
API keys can be removed by clicking Logout button.
Step 3: You can try out the requests under each section.
Note: Please feel free to edit the body as per your requirements.
