GET /rest/db/status

Returns information about the current status of a folder.

Parameters: folder, the ID of a folder.

  1. {
  2.   "globalBytes": 0,
  3.   "globalDeleted": 0,
  4.   "globalDirectories": 0,
  5.   "globalFiles": 0,
  6.   "globalSymlinks": 0,
  7.   "globalTotalItems": 0,
  8.   "ignorePatterns": false,
  9.   "inSyncBytes": 0,
  10.   "inSyncFiles": 0,
  11.   "invalid": "",
  12.   "localBytes": 0,
  13.   "localDeleted": 0,
  14.   "localDirectories": 0,
  15.   "localFiles": 0,
  16.   "localSymlinks": 0,
  17.   "localTotalItems": 0,
  18.   "needBytes": 0,
  19.   "needDeletes": 0,
  20.   "needDirectories": 0,
  21.   "needFiles": 0,
  22.   "needSymlinks": 0,
  23.   "needTotalItems": 0,
  24.   "pullErrors": 0,
  25.   "receiveOnlyChangedBytes": 0,
  26.   "receiveOnlyChangedDeletes": 0,
  27.   "receiveOnlyChangedDirectories": 0,
  28.   "receiveOnlyChangedFiles": 0,
  29.   "receiveOnlyChangedSymlinks": 0,
  30.   "receiveOnlyTotalItems": 0,
  31.   "sequence": 0,
  32.   "state": "idle",
  33.   "stateChanged": "2018-08-08T07:04:57.301064781+02:00",
  34.   "version": 0
  35. }

The various fields have the following meaning:

global*:

Data in the cluster latest version.

inSync*:

Data that is locally the same as the cluster latest version.

local*:

Data that is locally present, regardless of whether it’s the same or different version as the cluster latest version.

need*:

Data that is needed to become up to date with the cluster latest version (i.e., data that is out of sync).

receiveOnlyChanged*:

Data that has changed locally in a receive only folder, and thus not been sent to the cluster.

invalid:

Deprecated, always empty.

pullErrors:

The number of files that failed to sync during the last sync operations.

sequence:

The current folder sequence number.

state:

The current folder state.

stateChanged:

When the folder state last changed.

version:

Deprecated, equivalent to the sequence number.

Note

This is an expensive call, increasing CPU and RAM usage on the device. Use sparingly.