Register device

POST/v1/devices

Register a local device for future local execution or workspace sync.

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
None.
Query parameters
None.

Body schema

Content type: application/json · Required

FieldTypeRequiredDescription
namestringYesHuman-readable name.
platformstringNo
hostnamestringNo
appVersionstringNo
daemonVersionstringNo
statusonline | offlineNoCurrent lifecycle status.
capabilitiesobjectNo

What the API returns

Each response code below includes the documented payload shape for the ACP API.

201Device createdapplication/json
FieldTypeRequiredDescription
deviceobjectNo
device.idstringNoUnique identifier.
device.userIdstringNoUser ID.
device.namestringNoHuman-readable name.
device.platformstringNo
device.hostnamestringNo
device.appVersionstringNo
device.daemonVersionstringNo
device.statusonline | offlineNoCurrent lifecycle status.
device.capabilitiesobjectNo
device.lastSeenAtstringNo
device.createdAtstringNoISO 8601 timestamp.
device.updatedAtstringNoISO 8601 timestamp.
Register device
Loading...
Response 201
Loading...
See the ACP quickstart and SDK flow