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

Creating and Managing Blueprints

A Blueprint captures an Octave edge device's Resources, Observations, Edge Actions, services, and firmware, as a versioned configuration template, that can be applied to other devices. This is useful for applying the same settings to multiple devices.

Creating a Blueprint

A Blueprint is created from an Octave edge device as follows:

  1. Navigate to Build > Device > Blueprint.
  1. Click Create new Blueprint, enter a Blueprint name when prompted, and click Create. The settings from the current device that will be used in the new Blueprint are shown at the bottom of the screen.

Octave "applies" the Blueprint to the current device when the Blueprint is first created. This indicates that the current configuration on the device now corresponds to the Blueprint. This newly created Blueprint becomes Version 1.

The bottom of the Blueprint screen allows you to click on Edge Actions, Resources, Observations, and Services to list the respective items associated with the Blueprint:

Update a Blueprint

To update a Blueprint with the device's current configuration settings, click Save new version:



You can see the list of available Blueprints in the Version dropdown on the Blueprint screen in Octave. This field will be only be available if at least one Blueprint has been created.

Applying a Blueprint to Other Devices

After a Blueprint has been created and saved it can then be applied to one or more devices.

Applying a Blueprint via the Blueprint Screen

Follow the steps below to apply a Blueprint via the Blueprint screen:

  1. While still on the Build > Device > Blueprint screen, click Apply Other Blueprint. The Apply Blueprint screen is displayed:
  1. Select the devices to add (1).
  2. (Optional) Enable Deploy the firmware attached to the blueprint (2). This will deploy the firmware from the current device to selected devices.
  3. Click Blueprint and select the Blueprint (3) to apply.
  4. (Optional) Choose the Blueprint version (4) (the latest is selected by default)
  5. Click Apply Blueprint. This will apply the Blueprint to the selected devices and install any firmware on them, if this was enabled in Step 3.

Applying a Blueprint via the Device Monitoring Screen

You can also apply a Blueprint via the Deploy & Monitor > Devices screen (1) by selecting one or more devices (2) and clicking Apply Blueprint (3):

Applying a Blueprint Programmatically

You can use the /blueprint/apply endpoint to programmatically apply a Blueprint to one more more devices:

curl --request PUT \
  --url \
  --header 'content-type: application/json' \
  --header 'x-auth-token: <Your Master Token>' \
  --header 'x-auth-user: <Your User ID>' \
  --data '{
    "blueprint": {"id": "bxxxxxxxxxxxxxxx", "version": 1},
    "deviceIds": ["dyyyyyyyyyyyyyy","dzzzzzzzzzzzzzzzzzzzz",.....]



  • In order to invoke the endpoints, you must first obtain your master token and user ID. These are both available on the user screen in the Octave Dashboard.
  • Octave supports a maximum Blueprint data size of 100,000 characters including comments and line feeds/carriage returns.

Updated 5 days ago

Creating and Managing Blueprints

Suggested Edits are limited on API Reference Pages

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