Update Command

📘
Use the hub_url received in the registration response as your base URL.

📘
This API requires the device to authenticate, see Device Authentication.

Update the server on the status of execution of a command.

Request Data

Name	Type	Required	Description
status	string	Yes	Current command status: in_progress - update server on a long-running command done - command completed failed - failed to run command
message	string		Optional: Message providing details on the status update. It is strongly recommended to provide a message in case of failure, to allow the operator to understand the error's cause.
id	string	Yes	id* included in the response from the Get Command API

Name

Type

Required

Description

status

string

Yes

Current command status:

message

string

Optional: Message providing details on the status update.

It is strongly recommended to provide a message in case of failure, to allow the operator to understand the error's cause.

string

Yes

Request Sample

{
    "status": "done",
    "message": "success!",
    "id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}