Create workspace binding
POST
/v1/workspace-bindingsBind 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
| Field | Type | Required | Description |
|---|---|---|---|
| deviceId | string | Yes | — |
| environmentId | string | Yes | Computer ID. |
| projectId | string | No | Project ID. |
| name | string | No | Human-readable name. |
| localPath | string | Yes | — |
| syncRoot | string | No | — |
| ignorePatterns | string[] | No | — |
| syncMode | off | manual | watch | No | — |
| executionMode | legacy_remote | bridge_local | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Workspace binding createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| binding | object | No | — |
| binding.id | string | No | Unique identifier. |
| binding.userId | string | No | User ID. |
| binding.deviceId | string | No | — |
| binding.environmentId | string | No | Computer ID. |
| binding.projectId | string | No | Project ID. |
| binding.name | string | No | Human-readable name. |
| binding.localPath | string | No | — |
| binding.syncRoot | string | No | — |
| binding.ignorePatterns | string[] | No | — |
| binding.syncMode | off | manual | watch | No | — |
| binding.executionMode | legacy_remote | bridge_local | No | — |
| binding.lastPushedSnapshotId | string | No | — |
| binding.lastPulledSnapshotId | string | No | — |
| binding.createdAt | string | No | ISO 8601 timestamp. |
| binding.updatedAt | string | No | ISO 8601 timestamp. |