Create workspace binding

POST/v1/workspace-bindings

Bind a local folder on a registered device to an ACP environment.

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
deviceIdstringYes—
environmentIdstringYesComputer ID.
projectIdstringNoProject ID.
namestringNoHuman-readable name.
localPathstringYes—
syncRootstringNo—
ignorePatternsstring[]No—
syncModeoff | manual | watchNo—
executionModelegacy_remote | bridge_localNo—

What the API returns

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

201Workspace binding createdapplication/json
FieldTypeRequiredDescription
bindingobjectNo—
binding.idstringNoUnique identifier.
binding.userIdstringNoUser ID.
binding.organizationIdstringNo—
binding.createdByUserIdstringNo—
binding.deviceIdstringNo—
binding.environmentIdstringNoComputer ID.
binding.projectIdstringNoProject ID.
binding.namestringNoHuman-readable name.
binding.localPathstringNo—
binding.syncRootstringNo—
binding.ignorePatternsstring[]No—
binding.syncModeoff | manual | watchNo—
binding.executionModelegacy_remote | bridge_localNo—
binding.lastPushedSnapshotIdstringNo—
binding.lastPulledSnapshotIdstringNo—
binding.createdAtstringNoISO 8601 timestamp.
binding.updatedAtstringNoISO 8601 timestamp.
Create workspace binding
Loading...
Response 201
Loading...
See the ACP quickstart and SDK flow