Skip to content

Cloud sync status ​

Returns the cloud-sync switch and account state for one profile. The call reads locally stored state only — it never contacts OSS or WebDAV — so it is safe inside polling or health checks.

Reference: GET · verified 2026-11-19.

Request ​

http
GET /api/getCloudSyncStatus?id=1
api-key: REPLACE_WITH_LOCAL_API_KEY

The client must be running and signed in. Copy 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.

Query parameters ​

ParameterTypeRequiredDescription
idintegerYesProfile ID; read it from the profile list

cURL ​

bash
BASE_URL='http://127.0.0.1:REPLACE_WITH_API_PORT'
API_KEY='REPLACE_WITH_LOCAL_API_KEY'
curl --get "${BASE_URL}/api/getCloudSyncStatus" \
  --header "api-key: ${API_KEY}" \
  --data-urlencode 'id=1'

Response ​

json
{
  "success": true,
  "data": {
    "id": 1,
    "enabled": true,
    "cloudId": "0f1e2d3c-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "provider": "oss",
    "loggedIn": true,
    "vip": true,
    "hasSyncPassword": true
  }
}
FieldTypeDescription
data.enabledbooleanWhether cloud sync is enabled for this profile
data.cloudIdstringCloud profile ID; empty for profiles that have never been uploaded
data.providerstringStorage provider used by the profile: oss or webdav
data.loggedInbooleanWhether the client is currently signed in
data.vipbooleanWhether the account holds an active membership; cloud sync requires one
data.hasSyncPasswordbooleanWhether a sync password is set; without one, backups cannot be restored by password

Notes ​

  • enabled reports the switch only — it does not prove a backup exists. Use list cloud backups for that.
  • A missing or non-positive id returns HTTP 400.
  • Signed-out or expired-membership calls still succeed, but loggedIn / vip come back false; enabling sync then fails with HTTP 403 (VIP capability lease is missing or expired).
  • To change the switch, use set cloud sync.