API
POST /api/senses/devices/{device_id}/heartbeat
Heartbeat
POST /api/senses/devices/{device_id}/heartbeat
Heartbeat
Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
device_id | path | string | Yes | - |
X-Org-ID | header | string | null | No | - |
Request body
A JSON request body is required.
| Field | Type | Required | Description |
|---|---|---|---|
status | object | No | Defaults to {}. |
Example request
curl -X POST https://api.cognitivx.io/api/senses/devices/{device_id}/heartbeat \
-H "Authorization: Bearer icog_..." \
-H "Content-Type: application/json" \
-d '{
"status": {}
}'Example response
200 application/json
{}Responses
| Status | Description |
|---|---|
200 | Success. Returns the response body shown below. |
422 | Request validation failed. detail lists each offending field. |