v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
blueprints_Background Scripts API

Create a new background script

post/v2/background-scripts/

Request body

namestring required

Name of the background script

scriptstring required

The script content to be executed on devices

interpreterstring

Interpreter used to run the script. Currently only 'powershell' is supported.

always_runboolean required

Whether the script runs continuously. When true, frequency_in_mins must be null.

frequency_in_minsinteger nullable

Interval in minutes between script executions. Required when always_run is false, must be null when always_run is true.

timeout_in_minsinteger

Maximum runtime in minutes before the script is terminated. Must be > 0. Defaults to 60 if omitted.

descriptionstring nullable

Optional description for the background script. Max 300 characters.

Response

Success

messagestring
code201