Bytebeam Docs home pagelight logodark logo
  • Support
  • Get Access
  • Get Access
Getting Started
Platform Guide
MCU Integration
Linux Integration
Android Integration
Custom Integration
API Reference
Release Notes
  • Bytebeam
  • Community
  • Blog
  • devices
    • GET
      Get the list of devices - paginated.
    • GET
      Return the count of devices for pagination
    • PUT
      Allows update status of a device
    • GET
      Find devices by device state keys
    • POST
      Trigger an action on a bunch of devices.
    • GET
      Get action for device
    • GET
      Get params for an action
    • GET
      Return stats about the progress of various devices this action was triggered on
    • GET
      Return logs of actions per device
    • GET
      Return paginated progress of actions per device
    • POST
      Request to trigger actions; someone with permission will approve
    • PUT
      Approve an action
    • PUT
      Mark all actions for devices matching the filters as completed
    • PUT
      Mark a subset of devices for an action as completed
    • POST
      Attempt cancelling this action
    • GET
      Get apiv1actions error stats
    • POST
      Post apiv1actions device latencies
    • GET
      Get apiv1actions device latenciesstates
    • POST
      Retry an action on some devices
    • POST
      Return all pending actions for devices matching the given filters
    • GET
      Returns a list of all action types
    • POST
      Creates a new action-type
    • PUT
      Updates an existing action type
    • PUT
      Updates an existing action type
    • DEL
      Delete an action-type
    • POST
      Update metadata(s) for a device(s)
    • POST
      Takes a csv file and updates the metadata for a device
    • PUT
      Mark an existing metadata-key as serial number
    • PUT
      Mark an existing metadata-key as serial number
    • GET
      Returns a csv file template for updating metadata for a device
    • GET
      Get a list of metadata-keys
    • POST
      Create a metadata-key
    • DEL
      Delete a metadata-key
    • POST
      Provision a device. returns cert & keys
    • GET
      Download cert for a device given device-id
    • GET
      Return the list of all firmwares
    • POST
      Create firmware version
    • PUT
      Updates firmware version to be activated or deactivated
    • PUT
      Updates firmware version to be activated or deactivated
    • GET
      Download a firmware by version
    • HEAD
      Head endpoint to check metadata about file download
    • GET
      Download a firmware by component name and version
    • HEAD
      Head endpoint to check metadata about file download 1
    • GET
      Return the list of firmwares for components
    • GET
      Return the list of all firmware versions of given component
    • GET
      Get the list of Device Configurations
    • POST
      Create new Device Configuration
    • GET
      Get device config by version name
    API Reference
    • GET
      Get apiv1devicesstate keys
    • POST
      Search device by metadata
    • POST
      Updates the status of the action triggered on the device
    • GET
      Get metadata key and available options
    • GET
      Get device actions given device id
    • GET
      Returns available filters for searching actions of a device
    • PUT
      Mark all device actions given device id as completed
    • GET
      Get all device components
    • GET
      Show overall progress of actions triggered
    • GET
      Takes a filter and returns parameters matching that filter
    • GET
      Get apiv1firmware bundles
    • POST
      Post apiv1firmware bundles
    • GET
      Get apiv1firmware bundlesid
    • PUT
      Put apiv1firmware bundlesid
    • DEL
      Delete apiv1firmware bundlesid
    • GET
      Get apiv1firmware bundlesversion
    • PUT
      Put apiv1firmware bundlesversion
    • DEL
      Delete apiv1firmware bundlesversion
    • GET
      Get apiv1firmware bundles artifact
    • HEAD
      Head apiv1firmware bundles artifact
    • GET
      Returns list of tenants
    • POST
      Create a new tenant
    • GET
      Get auth details given tenant id
    • PUT
      Store tenant's end user authentication method
    • POST
      Request authorization for tenant
    • GET
      Get list of timezones supported by dashboard CSV export
    • GET
      Get apiv1log tags
    • POST
      Detailed data for micelio stats panel
    • GET
      Get share options for the user
    • GET
      Get tables and columns available for querying
    • GET
      Get all alert types
    • GET
      Get all alert rules
    • POST
      Create alert rule
    • GET
      Get all alert groups
    • GET
      Get alert notification rule
    • PUT
      Update alert notification rule
    • DEL
      Delete alert notification rule
    • POST
      Create alert notification rule
    • POST
      Test alert notification rule
    • PUT
      Update alert rule
    • DEL
      Delete alert rule
    • PUT
      Start alert rule
    • PUT
      Stop alert rule
    • GET
      Get all session types
    • POST
      Create session type
    • PUT
      Start session type
    • PUT
      Stop session type
    • DEL
      Delete session type
    • POST
      Called by dkron repeatedly for a scheduled action until it is finished. It retries failed actions if needed and updates schedule status
    • POST
      append fixed-list phase to a schedule
    • GET
      get schedule for an action
    • GET
      Get all DBCs for tenant
    • POST
      Creates a DBC
    • POST
      Post apiv1dbcs diff
    • PUT
      Put apiv1dbcs update
    • GET
      Get info about a single DBC given id
    • PUT
      Update DBC settings
    • DEL
      Delete a single DBC given id
    • GET
      Get dbc file for a DBC given id
    • GET
      Get parsed version of a DBC given id
    • PUT
      Start Parser
    • PUT
      Stop Parser
    • GET
      Get the list of devices - paginated.
    • GET
      Find devices by device state keys
    • GET
      Just a test route
    • GET
      Get all audit Logs
    • GET
      Get all the Dashboard logs
    • GET
      Get logs of a specific dashboard
    • GET
      Get all the Metadata logs
    • GET
      Get Metadata log for a key
    • GET
      Get all Role logs
    • GET
      Get logs of a role
    • GET
      Get mockapiv1actions
    • POST
      Post mockapiv1actions
    • POST
      Post mockapiv2actions
    • GET
      Get logout
    • GET
      Ping-pong end point
    • GET
      Get metrics
    data
    • GET
      Return the list of all uploaded files (respects RBAC)
    • POST
      Create a new file (respects RBAC)
    • GET
      The Endpoint the device hits to download the file (respects RBAC)
    • GET
      Get dashboards API
    • POST
      Create dashboard API
    • GET
      Get dashboard API
    • POST
      Update dashboard
    • DEL
      Delete dashboard API
    • POST
      Get data for panels given in body
    • POST
      Get data for a single panel given in the body
    admin
    • GET
      Get current User object
    • GET
      Get settings
    • PUT
      Update user settings
    • PUT
      Update tenant settings
    • GET
      Get users and their roles
    • POST
      Create a new user
    • GET
      Get user given existing id
    • PUT
      Update a user given existing id
    • DEL
      Delete a user given existing id
    • GET
      Get list of roles
    • POST
      Create role
    • GET
      Get a single role given role-id
    • PUT
      Update role given role-id
    • DEL
      Delete role given role-id
    • GET
      Get all existing streams in clickhouse database
    • POST
      Creates a stream on clickhouse database
    • GET
      Get all fields given existing stream name in clickhouse database
    • DEL
      Delete a stream on clickhouse database
    • DEL
      Delete a field given existing stream name in clickhouse database
    • POST
      Create a field given a existing stream name in clickhouse database
    • PUT
      Rename a stream field
    • POST
      Update an existing field's type
    • POST
      Post apiv1streamsfixprotobuff
    • GET
      Get apiv1streamsqueries
    • GET
      Get apiv1streamsqueries 1
    • GET
      Return protobuff for all streams in clickhouse database
    • POST
      Creates computed stream
    • GET
      Return full detail of streams with fields including if they are computed, along with their code and parent streams
    • GET
      Get all apikeys
    • POST
      Create a new apikey
    • DEL
      Deactivate an apikey; soft-delete
    logs
    • GET
      Logs for device certifactes
    • GET
      Logs for device certifactes by device id
    devices

    Get params for an action

    GET
    /
    api
    /
    v1
    /
    actions
    /
    {id}
    /
    params
    Get action for deviceReturn stats about the progress of various devices this action was triggered on
    githublinkedin
    Powered by Mintlify
    Assistant
    Responses are generated using AI and may contain mistakes.