Skip to main content

SyncStatusDto

Sync status response for a user plugin

conflictsinteger,null<int32>nullable

Number of entries with conflicts on both sides (only with ?live=true)

Possible values: >= 0

connectedbooleanrequired

Whether the plugin is connected and ready to sync

enabledbooleanrequired

Whether the plugin is currently enabled

externalCountinteger,null<int32>nullable

Number of entries tracked on the external service (only with ?live=true)

Possible values: >= 0

failureCountinteger<int32>required

Number of consecutive failures

healthStatusstringrequired

Health status

lastFailureAtstring,null<date-time>nullable

Last failure timestamp

lastSuccessAtstring,null<date-time>nullable

Last successful operation timestamp

lastSyncAtstring,null<date-time>nullable

Last successful sync timestamp

liveErrorstring | nullnullable

Error message if ?live=true was requested but the plugin could not be queried

pendingPullinteger,null<int32>nullable

Number of external entries that need to be pulled (only with ?live=true)

Possible values: >= 0

pendingPushinteger,null<int32>nullable

Number of local entries that need to be pushed (only with ?live=true)

Possible values: >= 0

pluginIdstring<uuid>required

Plugin ID

pluginNamestringrequired

Plugin name

SyncStatusDto
{
"conflicts": 0,
"connected": true,
"enabled": true,
"externalCount": 0,
"failureCount": 0,
"healthStatus": "string",
"lastFailureAt": "2024-07-29T15:51:28.071Z",
"lastSuccessAt": "2024-07-29T15:51:28.071Z",
"lastSyncAt": "2024-07-29T15:51:28.071Z",
"liveError": "string",
"pendingPull": 0,
"pendingPush": 0,
"pluginId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"pluginName": "string"
}