MODE Developer Central
MODE Developer Central
Overview
  • BizStack Overview
  • Use Case: Sensor Maker
  • Use Case: Facility Management
Data Platform
  • Entity Concept and Management
  • Data Routing
Device Development
  • Device Provisioning
  • Device API Keys
  • How to handle device events and commands
  • How to connect to MODE by MQTT
  • How to use device data proxy
  • Firmware Bundles & OTA Updates
  • How to use device configuration schema
MODE API
  • Introduction
  • Making Requests
  • Server Response
  • Rate limiting
  • Client Authentication
    • Get authentication state
    • Authentication by sudo
    • Initiate sudo authentication
    • Authenticate a user
    • Activate user account
    • Complete two-factor authentication
    • Verify user email address
    • Initiate user email verification
    • Verify new user email
    • Complete authentication by OpenID Connect
    • Initiate authentication by OpenID Connect
    • Reset user password
    • Initiate password reset for user
    • Initiate user auth with SMS
  • User Session
    • Terminate user session
    • Get user session info
    • Listen to events
  • Users
    • Get all users
    • Create a user
    • Delete a user
    • Get a user
    • Update a user
    • Activate two-factor authentication
    • Start activating 2FA
    • Deactivate two-factor authentication for another user
    • Proxy DELETE request to app server
    • Proxy GET request to app server
    • Proxy PATCH request to app server
    • Proxy POST request to app server
    • Proxy PUT request to app server
    • Change email address
    • Deactivate two-factor authentication
    • Get HTTP Access Log Entries
    • Get key-value pairs
    • Delete a key-value pair
    • Find a key-value pair
    • Create or update a key-value
    • Get Log Entries
    • Get user permissions
  • Service Accounts
    • Get service accounts
    • Create a service account
    • Delete a service account
    • Get a service account
    • Update a service account
    • Get service account tokens
    • Create a service account token
    • Revoke a service account token
    • Suspend or reactivate a service account token
  • Projects
    • Proxy DELETE request to app server
    • Proxy GET request to app server
    • Proxy PATCH request to app server
    • Proxy POST request to app server
    • Proxy PUT request to app server
    • Get a list of BizStack Apps available for the project
    • Create Log Collection
    • Delete a Log Collection
    • Get Log Entries
    • Create Log Entries
    • Delete Log Entry
    • Get Log Entry
    • Update Log Entry
    • Get custom log distinct values
    • Get list of data filters
    • Create data filters
    • Delete data filter
    • Get data filter
    • Update data filter
    • Get Data Source Catalog Items
    • Get Data Source Catalog Item
    • Get list of device classes
    • Get device class
    • Get list of entity instances
    • Create entity instance
    • Get list of entity classes
    • Create entity class
    • Delete entity class
    • Get entity class
    • Update entity class
    • Get metrics data for entity class
    • Get project files
    • Delete a project file
    • Get project file metadata
    • Update project file metadata
    • Get Project Log Entries
    • Create Tenant
    • Delete the Tenant
    • Update the Tenant information
    • List TSDBv2 schemas
    • Create TSDBv2 Schema
    • Delete TSDBv2 Schema
    • Get TSDBv2 Schema
    • Get TSDBv2 Metrics
    • Create TSDBv2 Metric
    • Update TSDBv2 Metric Tags
    • Upload a file
  • Project Public Profiles
    • Get project public profile
    • Get configuration of an app
    • List alternative user authentication methods
    • Get a user authentication method
  • Homes
    • Get all homes
    • Create a home
    • Delete a home
    • Get a home
    • Update a home
    • Proxy DELETE request to app server
    • Proxy GET request to app server
    • Proxy PATCH request to app server
    • Proxy POST request to app server
    • Proxy PUT request to app server
    • Post data
    • Get list of data routes
    • Create data route
    • Delete data route
    • Get data route
    • Update data route
    • Get all data sources
    • Add a data source
    • Delete a data source
    • Get a data source
    • Update a data source
    • Manage data source media
    • Get list of data upload jobs
    • Create data upload job
    • Get data upload job
    • Cancel data upload job
    • Begin processing data upload job
    • Initiate on-demand device provisioning
    • Send event to a home
    • Get HTTP Access Log Entries
    • Get list of integration module configurations
    • Create integration module configuration
    • Delete integration module configuration
    • Get integration module configuration
    • Update integration module configuration
    • Get the list of integration module jobs
    • Complete Integration Module OAuth Flow
    • Start Integration Module OAuth Flow
    • Trigger Integration Module's refresh operation
    • Get key-value pairs
    • Delete a key-value pair
    • Find a key-value pair
    • Create or update a key-value
    • Get Log Entries
    • Get all home members
    • Add a home member
    • Remove a home member
    • Get a home member
    • Update home member role
    • Get all smart modules
    • Get a smart module
  • Entities
    • Delete entity instance
    • Get entity instance
    • Update entity instance
    • Get alert rules
    • Create an alert rule
    • Delete an alert rule
    • Get an alert rule
    • Update an alert rule
    • Get alerts
    • Get alert
    • Recover an alert
    • Get alert schedules
    • Create an alert schedule
    • Delete an alert schedule
    • Get an alert schedule
    • Update an alert schedule
    • Proxy DELETE request to app server
    • Proxy GET request to app server
    • Proxy PATCH request to app server
    • Proxy POST request to app server
    • Proxy PUT request to app server
    • Get assistants
    • Create an assistant
    • Delete an assistant
    • Get an assistant
    • Update an assistant
    • Get Direct rooms
    • Get event subscriptions
    • Create event subscription
    • Delete an event subscription
    • Get an event subscription
    • Update an event subscription
    • Get MSTeams teams
    • Get Slack channels
    • Get custom log definition
    • Get custom log data
    • Post custom log records
    • Delete log record entry
    • Get log record entry
    • Update log record entry
    • Export custom log data
    • Get custom log distinct values
    • Send event to an entity
    • Get entity files
    • Delete an entity file
    • Get entity file metadata
    • Update entity file metadata
    • Delete location
    • Get location metadata
    • Update location
    • Delete location data
    • Get location data
    • Post location data
    • Delete object counter history
    • Get object counter history
    • Manage entity media
    • Delete metric
    • Get metrics definition
    • Update metric
    • Delete metrics data
    • Get metrics data
    • Post metrics data
    • Export metrics data
    • Get entity scheduled reports
    • Create entity scheduled report
    • Delete an entity scheduled report
    • Get an entity scheduled report
    • Update an entity scheduled report
    • Run entity scheduled report manually
    • Upload a file
    • Get video feeds
    • Create a video feed
    • Delete a video feed
    • Get a video feed
    • Update a video feed
    • Get a video feed file
    • Get a live stream data of a video feed
    • Open a WebRTC signaling session for a video feed
    • Get the VOD stream of a video feed
    • Get entity workflows
    • Create an entity workflow
    • Delete an entity workflow
    • Get an entity workflow
    • Update an entity workflow
    • Get entity workflow runs
    • Create run
    • Delete run
    • Get an entity workflow run
    • Update run
  • Devices
    • Get all devices
    • Add device to a home
    • Delete a device
    • Get device info
    • Update device info
    • Proxy DELETE request to app server
    • Proxy GET request to app server
    • Proxy PATCH request to app server
    • Proxy POST request to app server
    • Proxy PUT request to app server
    • Receive commands
    • Send command to device
    • Get device configuration schemas
    • Post data
    • Send device event to cloud
    • Record firmware installation
    • Get HTTP Access Log Entries
    • Get key-value pairs (and receive updates)
    • Delete a key-value pair
    • Look up a key-value pair
    • Create or update a key-value pair
    • Get Log Entries
    • Get Device Log Requests
    • Request Device Logs
    • Delete Device Log Request
    • Get Device Log Request
    • Update the device tag
  • Device Registration
    • Update device claimable state
  • Device Logger
    • Report Status of Device Log Request
    • Initiate Upload Session
    • Get Upload Session Status
    • Commit Upload Session
  • Firmware Bundles
    • Get firmware bundles
  • Firmware Channels
    • Get firmware channels
  • Alerts
    • Get alerts
    • Get an alert
    • Recover an alert
  • Alert Rules
    • Get alert rules
    • Create an alert rule
    • Delete an alert rule
    • Get an alert rule
    • Update an alert rule
  • Alert Schedules
    • Get alert schedules
    • Create an alert schedule
    • Delete an alert schedule
    • Get an alert schedule
    • Update an alert schedule
  • Assistant Instances
    • Get AI Assistant instances
    • Create AI Assistant instance
    • Delete an AI Assistant instance
    • Get an AI Assistant instance
    • Update an AI Assistant instance
    • Get Direct rooms
    • Get event subscriptions
    • Create event subscription
    • Delete an event subscription
    • Get an event subscription
    • Update an event subscription
    • Get MSTeams teams
    • Get Slack channels
  • Access Control Groups
    • Get access control groups
    • Create an access control group
    • Delete an access control group
    • Get an access control group
    • Update an access control group
    • Manage the membership of group
  • Permissions
    • Get permissions
    • Create a permission
    • Delete a permission
    • Get a permission
    • Update a permission
  • Permission Resource Types
    • Get resource types
    • Create permissionResourceType
  • Scheduled Reports
    • Get scheduled reports
    • Create scheduled report
    • Delete a scheduled report
    • Get a scheduled report
    • Update a scheduled report
    • Run scheduled report manually
  • Workflow
    • Get workflow node types
    • Get a workflow node type schema
    • Get workflow trigger types
    • Get a workflow trigger type schema
  • Integration Modules
    • Get integration module configurations
  • Bizstack App Installations
    • Get Bizstack App installations
    • Install a Bizstack App installation to a specified tenant (home)
    • Uninstall a Bizstack App installation
    • Get a Bizstack App installation
  • Deprecated: TSDB Smart Module
    • Get all time series collections
    • Create a time series collection
    • Delete time series collection
    • Get time series collection
    • Delete collection data
    • Get collection data
    • Get time range of collection data
    • Export time series data
    • Get all incidents in a home
    • Get all monitors for a home
    • Create a monitor for a home
    • Delete a monitor for a home
    • Get a monitor for a home
    • Update a monitor for a home
    • Get all time series
    • Create a time series
    • Delete time series
    • Get time series
    • Delete time series data
    • Get time series data
    • Get time series time range
  • Deprecated: GeoTSDB Smart Module
    • Get all geospatial time series collections
    • Delete geospatial time series collection
    • Get geospatial time series collection
    • Update collection
    • Create a geospatial time series collection
    • Delete historical counted time series data
    • Get historical counted time series data
    • Delete collection data
    • Get GeoJSON formatted geospatial data
    • Create data
    • Delete count
    • Get the current number of objects in an areas
    • Get object counter configs
    • Delete object counter config
    • Get object counter config
    • Update object counter config
    • Create object counter config
MODE API Reference

Firmware Bundles

1 operations.

Data models for Firmware Bundles

Operations

  • GET /bundles — Get firmware bundles