Set cloud sync
Turns cloud sync on or off for one profile. When enabling, the client uploads once by default, pushing the profile package and the credential envelope to the cloud.
Reference: POST · verified 2026-11-19.
Request
http
POST /api/setCloudSync
api-key: REPLACE_WITH_LOCAL_API_KEYCopy the local service address and api-key from the client's API page; the port is assigned dynamically and is not the browser CDP port. See Overview and authentication.
JSON body
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Profile ID |
enable | boolean | Yes | true to enable, false to disable |
syncNow | boolean | No | Upload immediately when enabling; defaults to true. Ignored when disabling |
wait | boolean | No | true waits for the upload to finish before responding; keep asynchronous for large profiles |
cURL
bash
BASE_URL='http://127.0.0.1:REPLACE_WITH_API_PORT'
API_KEY='REPLACE_WITH_LOCAL_API_KEY'
curl --request POST "${BASE_URL}/api/setCloudSync" \
--header "api-key: ${API_KEY}" \
--header 'Content-Type: application/json' \
--data '{
"id": 1,
"enable": true,
"syncNow": true,
"wait": false
}'Response
json
{
"success": true,
"data": {
"id": 1,
"enabled": true,
"syncTriggered": true
}
}| Field | Type | Description |
|---|---|---|
data.enabled | boolean | Switch state after the change |
data.syncTriggered | boolean | Whether an immediate upload started; false when syncNow is false or sync is being disabled |
Notes
syncTriggeredmeans the upload task started, not that the cloud copy is complete. Usewait: true, or check list cloud backups later.- Disabling stops further uploads but keeps existing cloud backups. To remove them, call delete cloud backup.
- Signed-out or expired-membership calls return HTTP
403(VIP capability lease is missing or expired); a missing or mistypedid/enablereturns HTTP400. - To inspect state without changing it, use cloud sync status.



