Save and trigger a command

This API endpoint allows for the creation and saving of a new command. It takes a Command object as the request body which includes the execution condition as set in the reference trigger and returns the unique identifier (commandID) of the newly created command.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The unique identifier for the command.

date-time

The date and time when the command was created.

string

The username of the owner of the command.

string

The domain associated with the command.

commandData

The data associated with the command.

trigger
object

The trigger associated with the command.

string

A description of the command.

string

The ID of the filter associated with the command.

currentDevices
array of strings

The list of devices currently targeted by the command.

currentDevices
string

The state of the command.

notifiedUsers
array of strings, unique

A set of usernames representing users who have been notified about the command.

notifiedUsers
boolean

Flag indicating whether the command has unsaved changes.

date-time

The date and time of the last change to the command.

int32

The count of failures associated with the command.

int32

The count of devices with partial workflow completion (some steps succeeded, some failed).

int32

The count of successful executions of the command.

int32

The count of times the command has been sent.

int32

The count of times the command has been executed.

int32

The count of devices ready to receive the command.

boolean

True when this row's counters come from the sticky outcome projection (distinct-device buckets) rather than the stored legacy counters. Set at read time, never persisted — consumers branch on THIS, not on command type: readyCount means "devices whose sticky outcome is READY" when true, and the legacy "delivered" stand-in when absent.

boolean

Flag indicating whether the command should be persisted for future reference.

string

The ID of the persistent group associated with the command.

string

The name of the persistent group associated with the command.

boolean
props
object

Additional properties associated with the command.

string

The pagination token for the command.

lastCommandStatus
object
Responses

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

503

Service Unavailable

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json