Jump to Content
Octave
Technical Reference
Log InOctave
Technical Reference
Log In

Overview

  • Octave API overview

Octave REST API

  • Authentication and security
  • Errors
  • Notifications
  • Versioning
  • Paging
  • Filtering
    • Operator List
    • Fixed Value Comparison
    • Element Value Comparison
    • Modulo
    • Regex
    • IN
    • CONTAINS
    • WITHIN (by distance)
    • WITHIN (bounding box)
    • EXISTS
    • AGE
    • MATCHES
    • NOT
    • Combining filters
  • Getting Started Guides
    • Using the REST API in an External System
    • Setting a Value From a REST API Call
    • REST API Quick Start Guide
  • Octave REST API Tutorials
    • Sending Files
    • Tracking Asynchronous jobs with StepLists
  • Device
    • Send Filepost
  • File
    • Create Filepost
    • Find Fileget
    • Update Fileput
    • Get Fileget
    • Delete Filedelete
    • Count Fileget
  • Operation
    • Get Operationget
  • Step
    • Cancel a Stepput
    • Get Stepget
    • Count Stepget
    • Find Stepget

Cloud JavaScript API

  • Cloud Action Runner Overview
  • Lodash Functions
  • CryptoJS
  • Errors
    • Error Object
  • Device
    • getName()
    • get()
    • find()
    • update()
  • Filters
  • Stream
    • find()
    • get()
  • HTTP (webhook)
    • get()
    • post()
    • put()
    • delete()
  • Event
    • find()
    • findOne()
    • findHash()
    • multifind()
    • aggregate()
    • get()
  • Action
    • find()
    • get()

Edge JavaScript API

  • Edge Action Runner Overview
  • Resource
    • readValue()
    • read()
  • Observation
    • getMax()
    • getMin()
    • getMean()
    • getBuffer()

Octave REST API

  • File
    • Get File Versionget
    • Create Filepost
    • Find Filesget
    • List File Versionsget
    • Count Filesget
    • Update Fileput
    • Get Fileget
    • Delete Filedelete
  • Step List
    • Cancel a StepListput
    • Count Step Listsget
    • Get Step Listget
    • Find Step Listsget
  • Cloud Connector
    • Create Cloud Connectorpost
    • Find Cloud Connectorsget
    • Get Cloud Connector Versionget
    • Update Cloud Connectorput
    • Get Cloud Connectorget
    • Delete Cloud Connectordelete
    • List Cloud Connector Versionsget
    • Count Cloud Connectorsget
  • Device
    • Count Devicesget
    • Remove tags from many Devices in Bulkput
    • Find Devicesget
    • Provision Many Devices in Bulkpost
    • Update Deviceput
    • Get Deviceget
    • Delete Devicedelete
    • Update Device Observationsput
    • Install Firmware on a Devicepost
    • Get all Device tagsget
    • Move Devices to another Companypost
    • Send Filepost
    • Find Device Eventsget
    • Delete Device Observationdelete
    • Update Device Edge Actionput
    • Provision Devicepost
    • Resend Device configpost
    • Add tags to many Devices in Bulkput
  • Token
    • Count Tokensget
    • Update Tokenput
    • Get Tokenget
    • Delete Tokendelete
    • Create Tokenpost
    • Find Tokensget
  • Stream
    • Create Streampost
    • Find Streamsget
    • Update Streamput
    • Get Streamget
    • Delete Streamdelete
    • Count Streamsget
  • Edge Action
    • Get Edge Action Versionget
    • Update Edge Actionput
    • Get Edge Actionget
    • Delete Edge Actiondelete
    • Create Edge Actionpost
    • Find Edge Actionsget
    • List Edge Action Versionsget
    • Count Edge Actionsget
  • Operation
    • Cancel an Operationput
    • Count Operationsget
    • Get Operationget
    • Find Operationsget
  • Cloud Action
    • Count Cloud Actionsget
    • Get Cloud Action Versionget
    • Create Cloud Actionpost
    • Find Cloud Actionsget
    • Simulate a new Cloud Actionpost
    • List Cloud Action Versionsget
    • Update Cloud Actionput
    • Get Cloud Actionget
    • Delete Cloud Actiondelete
    • Simulate an existing Cloud Actionpost
  • Blueprint
    • Update Blueprint From Deviceput
    • List Blueprint Versionsget
    • Update Blueprintput
    • Get Blueprintget
    • Delete Blueprintdelete
    • Create Blueprintpost
    • Find Blueprintsget
    • Get Blueprint Versionget
    • Apply Blueprintput
    • Count Blueprintsget
    • Create Blueprint From Deviceput
  • Identity
    • Get Identityget
    • Find Identitiesget
    • Reset Master Tokenput
  • Event
    • Create Event with Stream ID or pathpost
    • Find Event by Stream Pathget
    • Count Eventsget
    • Create Eventpost
    • Find Event by Stream IDget
    • Bulk Delete all Events in Streamdelete
    • Count Events by Stream pathget
    • Update Eventput
    • Get Eventget
    • Delete Eventdelete
    • Get Event memberget
    • Aggregate Eventpost
  • Company
    • Find Companyget
    • Get Companyget
    • Leave Companyput
    • Join Companyput
  • Group
    • Add a Member Idput
    • Remove a Member Iddelete
    • Create Grouppost
    • Find Groupsget
    • Count Groupsget
    • Update Groupput
    • Get Groupget
    • Delete Groupdelete
  • Firmware
    • Find Firmwaresget
    • Get Firmwareget
  • Share
    • Count Sharesget
    • Create Sharepost
    • Find Sharesget
    • Update Shareput
    • Get Shareget
    • Delete Sharedelete

Octave REST API Tutorials

The following tutorials are available showing how to use the Octave REST API:

  • Sending Files
  • Tracking Asynchronous jobs with StepLists