CognitiveX Docs
API

PATCH /api/senses/devices/{device_id}

Patch Device

PATCH /api/senses/devices/{device_id}

Patch Device

Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.

Parameters

NameInTypeRequiredDescription
device_idpathstringYes-
X-Org-IDheaderstring | nullNo-

Request body

A JSON request body is required.

FieldTypeRequiredDescription
device_namestring | nullNo-
capabilitiesstring[] | nullNo-
metadataobject | nullNo-

Example request

curl -X PATCH https://api.cognitivx.io/api/senses/devices/{device_id} \
  -H "Authorization: Bearer icog_..." \
  -H "Content-Type: application/json" \
  -d '{
    "device_name": "production",
    "capabilities": null,
    "metadata": null
  }'

Example response

200 application/json

{}

Responses

StatusDescription
200Success. Returns the response body shown below.
422Request validation failed. detail lists each offending field.