Apply Blueprint

put

https://octave-api.sierrawireless.io/v5.0/{company}/blueprint/apply

Applies a Blueprint to a number of Devices. The contents of the Blueprint configuraiton will be copied and sent to
each one of the Devices.

Optionally, any Firmware attached to the Blueprint can be marked for installation, and any Files can be sent.

Devices can be specified using a list of IDs, a Tag, or a Filter Language Query. An
Operation object will be returned, which can be used to track the
progress of the Files sent to each Device.

Permissions required:

Path / Role	Permission	Description
`BLUEPRINT_READ` Role	-	Global role enabling the reading of Blueprints
Device.path or Device.tag	Write	Write access to the Device(s) included in the request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company

string

required

The company name

Body Params

A method of selecting Devices. Choose only one

deviceIds

array of strings

length between 0 and 500

List of Device IDs which the File(s) should be sent to.

deviceIds

query

string

Filters objects using the Octave Filter Language

tag

string

A Tag selecting the Devices to send the File(s) to.

blueprintId

object

required

description

string

length ≤ 20000

A free-form description of the Operation. Supplied by the user as part of
the request which creates the Operation

enableFiles

boolean

Defaults to false

If true, any Files assigned to the Blueprint will be sent to the Device

enableFota

boolean

Defaults to false

If true, any Firmware assigned to the Blueprint (when different from
the Device Firmware) will be installed on Device

Responses

201Success

400Request Error

403Unauthorized

404Resource not found