Post

post

https://api.formant.io/v1/admin/commands

Create a new command instance. Resource: commands Authorized roles: operator

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Command

organizationId

uuid

ID of the organization in which you want to create this new command instance.

deviceId

uuid

required

ID of the device on which this command should run.

userId

uuid | null

ID of the user who issued this command.

commandTemplateId

uuid | null

eventTriggerId

uuid

Used by Formant agent only, ignore.

command

string

required

Function, script, or routine to execute.

parameter

object

required

deliveredAt

date-time | null

Used by Formant agent only, ignore.

canceledAt

date-time | null

Used by Formant agent only, ignore.

respondedAt

date-time | null

Used by Formant agent only, ignore.

success

boolean | null

Used by Formant agent only, ignore.

streamName

string | null

Used by Formant agent only, ignore.

streamType

string | null

enum

Used by Formant agent only, ignore.

tags

object | null

Tags associated with this command instance.

lambdaUri

string | null

expiredAt

date-time | null

retryable

boolean | null

uuid

createdAt

date-time

updatedAt

date-time

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201