Heartbeat device
POST
/v1/devices/{deviceId}/heartbeatUpdate a registered device's liveness, version metadata, and capabilities.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| deviceId | path | string | Yes | Device ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| appVersion | string | No | — |
| daemonVersion | string | No | — |
| capabilities | object | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Device heartbeat acceptedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| device | object | No | — |
| device.id | string | No | Unique identifier. |
| device.userId | string | No | User ID. |
| device.name | string | No | Human-readable name. |
| device.platform | string | No | — |
| device.hostname | string | No | — |
| device.appVersion | string | No | — |
| device.daemonVersion | string | No | — |
| device.status | online | offline | No | Current lifecycle status. |
| device.capabilities | object | No | — |
| device.lastSeenAt | string | No | — |
| device.createdAt | string | No | ISO 8601 timestamp. |
| device.updatedAt | string | No | ISO 8601 timestamp. |
404Resource not foundapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |