Jump to Content
Home
Guides
API Reference
Changelog
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Gateway Commands
All
Pages
Start typing to search…
JUMP TO
platform
Authentication
API Token Reset
post
Get Temporary API Token
post
Commands
List all Commands visible to the authorized user.
get
Creates a Command
post
Get Command by ID
get
Updates a Command
put
Deletes a Command
del
List all command executions by command id.
get
Deletes multiple Commands
del
Companies
List all Companies
get
Creates a Company
post
Get Company by ID
get
Updates a Company
put
Deletes a Company
del
Get File of Company by ID
get
Upload Company logo
post
Device Configs
List all Device Configs
get
Creates a Device Config
post
Get Device Config by ID
get
Updates a Device Config
put
Deletes a Device Config
del
Deletes multiple Device Configs
del
Device Transfer Requests
List all Device Transfer Requests
get
Creates a Device Transfer Request
post
Get Device Transfer Request by ID
get
Updates a Device Transfer Request
put
Deletes a Device Transfer Request
del
Initiate Device Transfer
post
Deletes multiple Device Transfer Requests
del
Device Location Observations
List all device location observations
get
Creates a device location observation. Note that creating a location observation will trigger the associated device's last known location. When creating a device location observation, you may set `device_id` to either the system id or the device's unique id. If you use the device's unique id you must also specify the device's company in the `company_id` field so that the system can uniquely identify the device. After creation, `device_id` will always contain the device's system id.
post
Get device location observation by ID
get
Method Not Allowed
put
Deletes a device location observation
del
Device Types
List all Device Types
get
Creates a Device Type
post
Get Device Type by ID
get
Updates a Device Type
put
Deletes a Device Type
del
Get the list of available file URLs
get
Deletes multiple Device Types
del
Device Types - Rules
List Rule(s) on Device Type
get
Attach Rule to Device Type
put
Detach Rule from Device Type
del
Devices
List all Devices
get
Creates a Device
post
Get Device by ID
get
Updates a Device
put
Deletes a Device
del
Get File of Device by ID
get
Get AWS Thing Groups associated with a Device by ID
get
Device geographic location relation with region
get
N device geographic location relations with respect to geographic region
get
List all devices with errors
get
List all devices within geographic bounding box
get
List all device locations
get
Get counts and names of devices by status by location
get
Get counts and names of devices by status
get
Find if a unique id exists in the system
get
Devices - Bulk
Creates multiple Devices via Device Template
post
Creates multiple Devices
post
Updates multiple Devices
put
Deletes multiple Devices
del
Bulk Execute Command on multiple devices
post
Download devices' info via CSV file.
get
Bulk Create/Edit/Delete devices via CSV file
post
Bulk Execute Gateway Command via CSV file
post
Devices - Commands
Execute Command on a device
post
List Command(s) on Device
get
Attach Command to Device
put
Detach Command from Device
del
Devices - Gateway Commands
Execute Gateway Command on a device
post
Devices - Rules
List Rule(s) on Device
get
Attach Rule to Device
put
Detach Rule from Device
del
Escrow Devices
List all Escrow Devices
get
Creates an Escrow Device
post
Get Escrow Device by ID
get
Updates a Escrow Device
put
Deletes a Escrow Device
del
Deletes multiple Escrow Devices
del
Gateway Commands
List all Gateway Commands visible to the authorized user.
get
Creates a Gateway Command
post
Get Gateway Command by ID
get
Updates a Gateway Command
put
Deletes a Gateway Command
del
Retry a gateway command
put
Creates multiple Gateway Commands
post
Deletes multiple Gateway Commands
del
Ingestors
List all Ingestors
get
Creates a Ingestor
post
Get Ingestor by ID
get
Updates an Ingestor
put
Deletes an Ingestor
del
Deletes multiple Ingestors
del
Integrations
List all Integrations
get
Creates an Integration
post
Get Integration by ID
get
Updates an Integration
put
Deletes an Integration
del
Get AWS Thing Groups associated with an Integration by ID
get
Deletes multiple Integrations
del
Reports
List all Hearbeat Reports
get
List all Reports
get
Creates a Report
post
Get Report by ID
get
Rules
List all Rules
get
Creates a Rule
post
Get Rule by ID
get
Updates a Rule
put
Deletes a Rule
del
Get devices for a rule
get
Deletes multiple Rules
del
Rules - Conditions
Lists available rule conditions
get
Rules - Actions
Lists available rule actions
get
Scheduled Jobs
List all Scheduled Jobs
get
Creates a Scheduled Job
post
Get Scheduled Job by ID
get
Updates a Scheduled Job
put
Deletes a Scheduled Job
del
List all Devices associated with a Scheduled Job
get
Associates bulk devices to a Scheduled Job
put
Associates a device to a Scheduled Job
put
Deletes associate device from a Scheduled Job
del
List all Device Types associated with a Scheduled Job
get
Associates a device to a Scheduled Job
put
Deletes associate device type from a Scheduled Job
del
Software Updates
List all Software Updates visible to the authorized user.
get
Creates a Software Update
post
Get Software Update by ID
get
Updates a Software Update
put
Deletes a Software Update
del
Add files to software update.
post
Deletes multiple Software Updates
del
Time Series
Query Generic Time Series Data
get
Translators
List all Translators
get
Creates a Translator
post
Get Translator by ID
get
Updates a Translator
put
Deletes a Translator
del
Deletes multiple Translators
del
User Types
List all User Types
get
Creates a User Type
post
Get User Type by ID
get
Updates a User Type
put
Deletes a User Type
del
Users
List all Users
get
Creates a User
post
Get User by ID
get
Updates a User
put
Deletes a User
del
Deletes multiple Users
del
Returns current user
get
Notifications
List all Notifications
get
Create a Notification
post
Get a Notification
get
Update a Notification
put
User Events
List all User Events
get
Get User Event by ID
get
Bulk Responses
Bulk
Get bulk responses
get
Get bulk responses
get
Bulk Commands
Certificate Revocation Lists
List all Certificate Revocation Lists visible to the authorized user.
get
Creates a Certificate Revocation List
post
Updates a Certificate Revocation List
put
Get Certificate Revocation List by ID
get
Deletes a Certificate Revocation List
del
Configurations
Link Command to a Configuration
put
List all Configurations
get
Creates a Configuration
post
Get Configuration by ID
get
Updates a Configuration
put
Deletes a Configuration
del
Get Device Types associated with a Configuration
get
Get Commands associated with a Configuration
get
Link Command to a Configuration
put
Get Settings associated with a Configuration
get
Creates a Setting within a Configuration
post
List Settings Versions for a Setting
get
Creates a new version of a setting
post
Get Settings Version by Settings ID and Version
get
Update a Setting Version
put
Delete a Setting Version
del
CommandExecutions
List all CommandExecutions visible to the authorized user.
get
List all Command Executions Statuses by command execution id.
get
Retry the command associated with this command execution
put
Device Events
Creates a Device Event
post
Creates multiple Device Event
post
Settings
List all Settings
get
Creates a Setting.
post
Get Settings by ID
get
Updates a Setting
put
Deletes a Setting
del
Get Devices associated with a Setting
get
Get Device Types associated with a Setting
get
Devices Events
List all Devices Events
get
Device Templates
List all Device Templates
get
Creates a Device Template
post
Get Device Template by ID
get
Updates a Device Template
put
Deletes a Device Template
del
Device Types - Ingestors
List Ingestor(s) on Device Type
get
Attach Ingestor to Device Type
put
Detach Ingestor from Device Type
del
Device Types - Configurations
List Configuration(s) on Device Type
get
Attach Configuration to Device Type
put
Detach Configuration from Device Type
del
Device Types - Settings
List Settings(s) on Device Type
get
Attach Setting to Device Type
put
Detach Setting from Device Type
del
Device Types - Commands
List Command(s) on Device Type
get
Attach Command to Device Type
put
Detach Command from Device Type
del
Device Types - Pollable Attributes
List Pollable Attribute(s) on Device Type
get
Attach Pollable Attribute to Device Type
put
Detach Pollable Attribute from Device Type
del
Devices - Certificates
Revoke a device certificate
post
Activate a device certificate
post
Commands - Bulk
Devices - Ingestors
List Ingestor(s) on Device
get
Attach Ingestor to Device
put
Detach Ingestor from Device
del
Devices - Command Executions
List Command Executions(s) on Device
get
Devices - Settings
List Settings(s) on Device
get
Attach Setting to Device
put
Detach Setting from Device
del
Devices - Configurations
Get Configurations on Device
get
Update Last Reported Setting for a Configuration on Device
post
Devices - Network Monitoring
Get latest network interface info for each interface of a device
get
Get latest network performance reports for each interface and server of a device
get
Get latest network latency reports for each interface and host of a device
get
Get consolidated network connectivity information for a device
get
Get network latency reports of the device
get
Create a network performance report for a device interface
post
Get network performance reports of the device
get
Create a network performance report for a device interface
post
Get network interfaces reports of the device
get
Create a network interfaces report for a device
post
Get network interface infos collected as part of a network interfaces report of the device
get
Create a network interface info record
post
Heartbeats
Create a device heartbeat
post
Files
List all Files
get
Creates a File
post
Get File by ID
get
Updates a File
put
Uploads a file to specific file id.
post
Deletes a File
del
Download File by ID
get
Pollable Attributes
List all Pollable Attributes visible to the authorized user.
get
Creates a Pollable Attribute
post
Get Pollable Attribute by ID
get
Updates a Pollable Attribute
put
Deletes a Pollable Attribute
del
Logo
Retrieves Company Logo
get
Scheduled jobs
Deletes associated devices from a Scheduled Job
del
Associates bulk device types to a Scheduled Job
put
Deletes associated device types from a Scheduled Job
del
Regions
List all Regions
get
Creates a Region
post
Get Region by ID
get
Deletes a Region
del
Software Version
List all Software Version visible to the authorized user.
get
Creates a Software Version
post
Get Software Version by ID
get
Updates a Software Version
put
Deletes a Software Version
del
Get distinct software versions based on name
get
Secrets
List all Secrets visible to the authorized user.
get
Creates a Secret
post
Get Secret by ID
get
Deletes a Secret
del
SettingsApplicationRecord
Historical list all Settings applied which are visible to the authorized user.
get
Bootstrap
Get MQTT configuration
get
Powered by
Gateway Commands
Ask AI
