For AI agents: visit https://dev.edgeiq.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
EdgeIQ
HomeGuidesAPI ReferenceChangelog
v1.0

Log InEdgeIQ
API Reference
Log In
v1.0

platform

  • Authentication
    • API Token Resetpost
    • Get Temporary API Tokenpost
  • Commands
    • List all Commands visible to the authorized user.get
    • Creates a Commandpost
    • Get Command by IDget
    • Updates a Commandput
    • Deletes a Commanddel
    • List all command executions by command id.get
    • Deletes multiple Commandsdel
  • Companies
    • List all Companiesget
    • Creates a Companypost
    • Get Company by IDget
    • Updates a Companyput
    • Deletes a Companydel
    • Get File of Company by IDget
    • Upload Company logopost
  • Bulk Commands
  • Device
    • Get Device Fleetsget
    • Device Events
      • Creates a Device Eventpost
      • Creates multiple Device Eventpost
    • Device Configs
      • List all Device Configsget
      • Creates a Device Configpost
      • Get Device Config by IDget
      • Updates a Device Configput
      • Deletes a Device Configdel
      • Deletes multiple Device Configsdel
    • Device Location Observations
      • List all device location observationsget
      • 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 IDget
      • Method Not Allowedput
      • Deletes a device location observationdel
    • Device Templates
      • List all Device Templatesget
      • Creates a Device Templatepost
      • Get Device Template by IDget
      • Updates a Device Templateput
      • Deletes a Device Templatedel
    • Device Transfer Requests
      • List all Device Transfer Requestsget
      • Creates a Device Transfer Requestpost
      • Get Device Transfer Request by IDget
      • Updates a Device Transfer Requestput
      • Deletes a Device Transfer Requestdel
      • Initiate Device Transferpost
      • Deletes multiple Device Transfer Requestsdel
    • Device Types
      • List all Device Typesget
      • Creates a Device Typepost
      • Get Device Type by IDget
      • Updates a Device Typeput
      • Deletes a Device Typedel
      • Get the list of available file URLsget
      • Deletes multiple Device Typesdel
    • Device Types - Commands
      • List Command(s) on Device Typeget
      • Attach Command to Device Typeput
      • Detach Command from Device Typedel
    • Device Types - Configurations
      • List Configuration(s) on Device Typeget
      • Attach Configuration to Device Typeput
      • Detach Configuration from Device Typedel
    • Device Types - Ingestors
      • List Ingestor(s) on Device Typeget
      • Attach Ingestor to Device Typeput
      • Detach Ingestor from Device Typedel
    • Device Types - Pollable Attributes
      • List Pollable Attribute(s) on Device Typeget
      • Attach Pollable Attribute to Device Typeput
      • Detach Pollable Attribute from Device Typedel
    • Device Types - Settings
      • List Settings(s) on Device Typeget
      • Attach Setting to Device Typeput
      • Detach Setting from Device Typedel
    • Device Types - Rules
      • List Rule(s) on Device Typeget
      • Attach Rule to Device Typeput
      • Detach Rule from Device Typedel
  • Devices
    • Devices Bulk
      • Creates multiple Devices via Device Templatepost
      • Creates multiple Devicespost
      • Updates multiple Devicesput
      • Deletes multiple Devicesdel
      • Bulk Execute Command on multiple devicespost
      • Download devices' info via CSV file.get
      • Bulk Create/Edit/Delete devices via CSV filepost
      • Validate CSV file before bulk uploadpost
      • Bulk Execute Gateway Command via CSV filepost
    • Devices Certificates
      • Revoke a device certificatepost
      • Activate a device certificatepost
    • Devices Commands
      • Execute Command on a devicepost
      • List Command(s) on Deviceget
      • Attach Command to Deviceput
      • Detach Command from Devicedel
    • Devices Command Executions
      • List Command Executions(s) on Deviceget
    • Devices Configurations
      • Get Configurations on Deviceget
      • Update Last Reported Setting for a Configuration on Devicepost
    • Devices Events
      • List all Devices Eventsget
    • Devices Gateway Commands
      • Execute Gateway Command on a devicepost
    • Devices Ingestors
      • List Ingestor(s) on Deviceget
      • Attach Ingestor to Deviceput
      • Detach Ingestor from Devicedel
    • Devices Network Monitoring
      • Get latest network interface info for each interface of a deviceget
      • Get latest network performance reports for each interface and server of a deviceget
      • Get latest network latency reports for each interface and host of a deviceget
      • Get consolidated network connectivity information for a deviceget
      • Get network latency reports of the deviceget
      • Create a network performance report for a device interfacepost
      • Get network performance reports of the deviceget
      • Create a network performance report for a device interfacepost
      • Get network interfaces reports of the deviceget
      • Create a network interfaces report for a devicepost
      • Get network interface infos collected as part of a network interfaces report of the deviceget
      • Create a network interface info recordpost
    • Devices Rules
      • List Rule(s) on Deviceget
      • Attach Rule to Deviceput
      • Detach Rule from Devicedel
    • Devices Settings
      • List Settings(s) on Deviceget
      • Attach Setting to Deviceput
      • Detach Setting from Devicedel
    • List all Devicesget
    • Creates a Devicepost
    • Get Device by IDget
    • Updates a Deviceput
    • Deletes a Devicedel
    • Get File of Device by IDget
    • Get AWS Thing Groups associated with a Device by IDget
    • Device geographic location relation with regionget
    • N device geographic location relations with respect to geographic regionget
    • List all devices with errorsget
    • List all devices within geographic bounding boxget
    • List all device locationsget
    • Get counts and names of devices by status by locationget
    • Get counts and names of devices by statusget
    • Find if a unique id exists in the systemget
  • Commands Bulk
  • Escrow Devices
    • List all Escrow Devicesget
    • Creates an Escrow Devicepost
    • Get Escrow Device by IDget
    • Updates a Escrow Deviceput
    • Deletes a Escrow Devicedel
    • Deletes multiple Escrow Devicesdel
  • Fleets
    • List all Fleetsget
    • Create a Fleetpost
    • Get Fleet by IDget
    • Update a Fleetput
    • Delete a Fleetdel
    • List Available Fleet Actionsget
    • Execute Fleet Actionpost
    • Get Fleet Analyticsget
    • List Available Commands for Fleetget
    • List Available Configurations for Fleetget
    • List Fleet Commandsget
    • Add Commands to Fleetpost
    • Remove Commands from Fleetdel
    • List Fleet Configurationsget
    • Add Configurations to Fleetpost
    • Remove Configurations from Fleetdel
    • List Fleet Devicesget
    • Add Devices to Fleetpost
    • Remove Devices from Fleetdel
    • Import Devices to Fleetpost
    • List Fleet Eventsget
    • Export Fleet Devicespost
    • List Fleet Rulesget
    • Add Rules to Fleetpost
    • Remove Rules from Fleetdel
    • List Scheduled Jobs associated with a Fleetget
    • Add Scheduled Jobs to Fleetpost
    • Remove Scheduled Jobs from Fleetdel
  • Gateway Commands
    • List all Gateway Commands visible to the authorized user.get
    • Creates a Gateway Commandpost
    • Get Gateway Command by IDget
    • Updates a Gateway Commandput
    • Deletes a Gateway Commanddel
    • Retry a gateway commandput
    • Creates multiple Gateway Commandspost
    • Deletes multiple Gateway Commandsdel
  • Ingestors
    • List all Ingestorsget
    • Creates a Ingestorpost
    • Get Ingestor by IDget
    • Updates an Ingestorput
    • Deletes an Ingestordel
    • Deletes multiple Ingestorsdel
  • Integrations
    • List all Integrationsget
    • Creates an Integrationpost
    • Get Integration by IDget
    • Updates an Integrationput
    • Deletes an Integrationdel
    • Get AWS Thing Groups associated with an Integration by IDget
    • Deletes multiple Integrationsdel
  • Reports
    • List all Hearbeat Reportsget
    • List all Reportsget
    • Creates a Reportpost
    • Get Report by IDget
  • Rules
    • List all Rulesget
    • Get Rule by IDget
    • Get devices for a ruleget
    • Creates a Rulepost
    • Updates a Ruleput
    • Deletes a Ruledel
    • Deletes multiple Rulesdel
  • Rules Conditions
    • Lists available rule conditionsget
  • Rules Actions
    • Lists available rule actionsget
  • SIMs
    • List all SIMsget
    • Create a SIMpost
    • Get a SIM by ID or ICCIDget
    • Update a SIMput
    • Delete a SIMdel
    • Get distinct SIM field valuesget
  • Scheduled Jobs
    • Deletes associated device types from a Scheduled Jobdel
    • Associates bulk device types to a Scheduled Jobput
    • Deletes associated devices from a Scheduled Jobdel
    • List all Scheduled Jobsget
    • Creates a Scheduled Jobpost
    • Get Scheduled Job by IDget
    • Updates a Scheduled Jobput
    • Deletes a Scheduled Jobdel
    • List all Devices associated with a Scheduled Jobget
    • Associates bulk devices to a Scheduled Jobput
    • Associates a device to a Scheduled Jobput
    • Deletes associate device from a Scheduled Jobdel
    • List all Device Types associated with a Scheduled Jobget
    • Associates a device to a Scheduled Jobput
    • Deletes associate device type from a Scheduled Jobdel
    • List Fleets associated with a Scheduled Jobget
    • Bulk attach Fleets to a Scheduled Jobput
    • Bulk detach Fleets from a Scheduled Jobdel
    • Attach a Fleet to a Scheduled Jobput
    • Detach a Fleet from a Scheduled Jobdel
  • Software Updates
    • List all Software Updates visible to the authorized user.get
    • Creates a Software Updatepost
    • Get Software Update by IDget
    • Updates a Software Updateput
    • Deletes a Software Updatedel
    • Add files to software update.post
    • Deletes multiple Software Updatesdel
  • Time Series
    • Query Generic Time Series Dataget
  • Translators
    • List all Translatorsget
    • Creates a Translatorpost
    • Get Translator by IDget
    • Updates a Translatorput
    • Deletes a Translatordel
    • Deletes multiple Translatorsdel
  • User Types
    • List all User Typesget
    • Creates a User Typepost
    • Get User Type by IDget
    • Updates a User Typeput
    • Deletes a User Typedel
  • Users
    • List all Usersget
    • Creates a Userpost
    • Get User by IDget
    • Updates a Userput
    • Deletes a Userdel
    • Deletes multiple Usersdel
    • Returns current userget
  • Notifications
    • List all Notificationsget
    • Create a Notificationpost
    • Get a Notificationget
    • Update a Notificationput
  • User Notifications
    • List the current user's notification watchesget
    • Create a notification watchpost
    • Delete a notification watchdel
    • List the current user's notification inboxget
    • Get the current user's inbox summaryget
    • Dismiss an inbox itemdel
  • Bootstrap
    • Get MQTT configurationget
  • User Events
    • List all User Eventsget
    • Get User Event by IDget
  • Bulk
    • Get bulk responsesget
    • Get bulk responsesget
  • Certificate Revocation Lists
    • List all Certificate Revocation Lists visible to the authorized user.get
    • Creates a Certificate Revocation Listpost
    • Updates a Certificate Revocation Listput
    • Get Certificate Revocation List by IDget
    • Deletes a Certificate Revocation Listdel
  • Configurations
    • Link Command to a Configurationput
    • List all Configurationsget
    • Creates a Configurationpost
    • Get Configuration by IDget
    • Updates a Configurationput
    • Deletes a Configurationdel
    • Get Device Types associated with a Configurationget
    • Get Commands associated with a Configurationget
    • Link Command to a Configurationput
    • Get Settings associated with a Configurationget
    • Creates a Setting within a Configurationpost
    • List Settings Versions for a Settingget
    • Creates a new version of a settingpost
    • Get Settings Version by Settings ID and Versionget
    • Update a Setting Versionput
    • Delete a Setting Versiondel
  • 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 executionput
  • Settings
    • Creates a Setting.post
    • Get Devices associated with a Settingget
    • Get Device Types associated with a Settingget
    • Deletes a Settingdel
    • Get Settings by IDget
    • List all Settingsget
    • Updates a Settingput
  • Files
    • List all Filesget
    • Creates a Filepost
    • Get File by IDget
    • Updates a Fileput
    • Uploads a file to specific file id.post
    • Deletes a Filedel
    • Download File by IDget
  • Heartbeats
    • Create a device heartbeatpost
  • Logo
    • Retrieves Company Logoget
  • Pollable Attributes
    • List all Pollable Attributes visible to the authorized user.get
    • Creates a Pollable Attributepost
    • Get Pollable Attribute by IDget
    • Updates a Pollable Attributeput
    • Deletes a Pollable Attributedel
  • Regions
    • List all Regionsget
    • Creates a Regionpost
    • Get Region by IDget
    • Deletes a Regiondel
  • Secrets
    • List all Secrets visible to the authorized user.get
    • Creates a Secretpost
    • Get Secret by IDget
    • Deletes a Secretdel
  • SettingsApplicationRecord
    • Historical list all Settings applied which are visible to the authorized user.get
  • Software Version
    • List all Software Version visible to the authorized user.get
    • Creates a Software Versionpost
    • Get Software Version by IDget
    • Updates a Software Versionput
    • Deletes a Software Versiondel
    • Get distinct software versions based on nameget
Powered by 

Commands Bulk

Updated about 2 months ago


Find if a unique id exists in the system
Escrow Devices
Did this page help you?

Updated about 2 months ago


Find if a unique id exists in the system
Escrow Devices
Did this page help you?