Commands

Execute command

Trigger execution of a stored command on a device. Returns 202 when accepted for asynchronous delivery, or 200 when an identical execution is already in flight (duplicate).

Required scope: commands:write

post/api/v2/devices/{id}/actuator-executions

Request

  • Base URL: https://api.chirpwireless.io
  • URL: https://api.chirpwireless.io/api/v2/devices/{id}/actuator-executions
  • Auth: API key in header X-API-Key and API key in header X-Organization-Id

Path parameters

idstring required

Digital device ID

Request body

organizationIdstring required

Organization ID

commandIdstring required

ID of the stored command to execute.

paramsobject

Parameter values validated against the command's paramsSchema.

Response

Execution accepted for asynchronous delivery (HTTP 202), or an identical execution is already in flight (HTTP 200 with duplicate=true).

acceptedboolean
duplicateboolean

Changes

No recorded changes to this operation across all 1 revision of this API.