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

NameTypeDescription
statusstringCurrent command status:
_ in_progress - update server on a long-running command
_ done - command completed
* failed - failed to run command
messagestringOptional: 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.
idstringid included in the response from the Get Command API

Request Sample

{
    "status": "done",
    "message": "success!",
    "id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!