Skip to main content
POST
Run a script on one device
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

deviceId
string
required

Body

application/json
script
object
required

What to run: { "scriptId": 12 } for a script from the catalog, or { "contents": "..." } to send the source inline. An inline run may only target a single device.

Response

default - application/json
id
string
required
script
object
required
target
object
required

The target as submitted.

platforms
enum<string>[]
required
Available options:
macos,
windows,
linux
contents
string
required

Full source of the script as executed.

totalExecutions
number
required

Number of devices the run resolved to.

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
executions
object[]
required

One execution per resolved device, all pending at creation. Poll getScriptRun or getScriptRunExecutions for outcomes.