The Octave Developer Hub

Welcome to the Octave developer hub. You'll find comprehensive guides and documentation to help you start working with Octave as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Organizing Devices with Tags

A Tag is a key/value pair that is applied to an Octave edge device to allow common actions to be applied to all devices with the same Tag.

Creating a new Tag for your Organization

Follow the steps below to create a new Tag that can be applied to devices:

  1. Navigate to Build > Device > Details.
  2. Select the Add tag dropdown (1):
  1. Click New tag (2). The New tag popup appears.
  2. Select a value from the Category dropdown (3) or enter a new custom Category name:
  1. Enter a Value (4) for that Tag.
  2. Click Add (5).

📘

Note

Once the Tag has been added, it is accessible by all members of your organization to apply to any Device.

Aggregating Device Data with Tags

The following describes how to trigger a Cloud Action from multiple device Streams (this is known as Aggregating Events with Tag Actions:

Consider a group of devices which have the Tag dashboard: true (which can be seen in the screenshot below) and you want to forward your data from each device's /:default Stream to a dashboarding cloud endpoint with a Cloud Action or a connector. Rather than setting up one Cloud Action or connector per device–a process that does not scale with a dynamic fleet–you can create a Cloud Action/Connector with the Source being: Tag is dashboard: true, Stream /:default. All devices with that Tag and Stream will see their data pushed to the expected cloud endpoint.

Managing Device Configurations with Tags

Tags can assist with mass deployment and permissioning (e.g., to apply a Blueprint to all devices tagged with a given name/value pair). This is a way to target specific settings to be applied to a set of devices, based on a Tag as an identifier. In a similar fashion, you can initiate firmware upgrades to a selected set of devices based on Tags*.

📘

Note

An edge device has no knowledge of the Tags which are applied to it. Device Tags are automatically added on the cloud side to all generated Events from tagged devices.

The following steps describe how to create and remove Tags:

  1. Navigate to Build > Device > Details.
  2. Navigate to Identity.
  3. Select a key and value from the Customer (1) and Value (2) dropdowns:
  1. Click Add Tag (3) to add the Tag to the device.
  2. To remove a Tag, click the X button (4) on that Tag.

Managing Tags Through the Octave API

The Octave REST API can be used to add and remove Tags from devices.

📘

Note

In order to invoke the API's endpoints, you must first obtain your master token and user ID. These are both available on the user screen in the Octave Dashboard.

Adding a Tag to a Device

Invoke the company/device/addTags endpoint to add a Tag to a Device. The tags collection in the body specifies the Tag(s) to add. Replace key with the name of a Category and Value with the value to set for the Tag:

Host: octave-api.sierrawireless.io
PUT /v5.0/company/device/addTags HTTP/1.1
X-Auth-User: <your user ID>
X-Auth-Token: <your master token>
 
Content-Type: application/json


{
    "tags": {
        "key": "value"
    },
    "deviceIds": ["device_Id"]
}

Removing a Tag from a Device

Invoke the company/device/removeTags endpoint to remove a Tag from a device. The tags collection in the body specifies the Tag(s) to remove. Replace key with the name of a Category and Value with the value to set for the Tag:

Host: octave-api.sierrawireless.io
PUT /v5.0/company/device/removeTags
 
X-Auth-User: <your user ID>
X-Auth-Token: <your master token>
 
Content-Type: application/json

 
 {
    "tags": {
        "key": "value"
    },
    "deviceIds": ["device_Id"]
}

Updated 14 days ago

Organizing Devices with Tags


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.