Sign in
workspaces

Enable Workspace Sync

Enable sync for a workspace.

This endpoint is designed to be called from the web UI. It:

  1. Sends an RPC request to the user's machine to enable sync
  2. The machine daemon will upload the base ref bundle
  3. The machine daemon will sync all worktree checkpoints
  4. The machine daemon will update the workspace config to enable sync

Returns immediately after sending the RPC request. The actual sync operation happens asynchronously on the machine.

Args: workspace_id: The workspace to enable sync for machine_id: Optional machine ID to target. If not provided, will use the first online machine that has this workspace.

post/api/v1/workspaces/{workspace_id}/sync/enable

Path parameters

workspace_idstring required

Query parameters

machine_idstring nullable

Response

Successful Response

object required

Changes

No recorded changes to this endpoint across all 1 revision of this API.