Commands

Update command definition

Replace an existing command definition on a digital device.

Required scope: commands:write

patch/api/v2/devices/{id}/commands/{commandId}

Request

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

Path parameters

idstring required

Digital device ID

commandIdstring required

Command ID

Request body

organizationIdstring required

Organization ID

Response

Command updated (HTTP 200)

idstring
namestring
descriptionstring
mode'direct' | 'encoded'
paramsSchemaobject

Per-parameter JSON Schema subset, keyed by parameter name.

encodedParamsTemplateobject
directPayloadstring
customEncoderstring
fPortinteger
mqttTopicstring
confirmedboolean
verificationStrategy'no_verification' | 'wait_next_uplink' | 'query_after_ack'
queryCommandIdstring
convergenceTimeoutinteger
suitableAsQueryboolean
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "name": "Set temperature"
}

Changes

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