Logo

Command Status

APIs to view, filter, and manage command requests.

Get status list for command request

API to get and filter command request status

SecurityapiKey
Request
query Parameters
request
string

Filter status result by command request IDs. Accepts comma separated values.

device
string

Filter status result by device IDs. Accepts comma separated values.

state
string

Filter by command state

Enum: "Command Queued" "Command Initiated" "Command Acknowledged" "Command In Progress" "Command TimeOut" "Command Success" "Command Failure" "Command Scheduled" "Command Cancelled"
exclude_internal_commands
boolean
Default: false

Filter to exclude internal commands

limit
number
offset
number
Responses
200

Status list for a command request

401

Authorization information is missing or invalid.

500

Internal server error

get/commands/v0/status/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get a command status
API to get a command status


SecurityapiKey 
Request 
path Parameters
id
required
string
ID of the command status object


 
Responses 
200
Command status information


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/commands/v0/status/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Update command status
API to update a command status state


SecurityapiKey 
Request 
path Parameters
id
required
string
ID of the command status object


 
Request Body schema: application/json
required
state
string
Command state to update


 Enum: "Command Acknowledged" "Command In Progress" "Command TimeOut" "Command Success" "Command Failure" "Command Scheduled" "Command Cancelled"  
reason
string
State change reason to update


 
Responses 
200
Command status successfully updated.


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


put/commands/v0/status/{id}/
Request samples 
application/json
{
  • "state": "Command Acknowledged",
  • "reason": "string"
}
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get Queued commands to be executed by the physical device
API to get Queued Commands for a Device


SecurityapiKey 
Request 
query Parameters
device_id
required
string
Filter status result by device IDs.


 
Responses 
200
List of Queued Command Status


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


get/v2/command-inbox/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
➔ Next to Converge