library-syncs

Create Sync

Create a sync. A GitHub-out sync writes nothing until its first-sync preview is confirmed with /start; a website sync is watched at once; a Google import runs first on the next sweep, or with Sync now.

post/api/folders/{library_id}/syncs

Request

  • Base URL: https://app.thinqos.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.thinqos.com/api/folders/{library_id}/syncs
  • Auth: none declared

Path parameters

library_idstring uuid required

Headers

x-impersonate-identity-idstring nullable

Request body

kind'github_folder' | 'website' | 'google_drive_folder'
interval_secondsinteger nullable
installation_instance_idstring uuid nullable
ownerstring nullable
namestring nullable
branchstring
pathstring
auto_mergeboolean
on_remove'leave' | 'remove'
write_noteboolean
urlstring nullable
source_kindstring
modestring
destinationstring
discoverystring
crawl_depthinteger
path_prefixstring nullable
max_pagesinteger
max_bytesinteger
instance_idstring uuid nullable
resource_idstring nullable
resource_namestring
arrive_publishedboolean

Response

Successful Response

idstring uuid required
library_idstring uuid required
kindstring required
directionstring required
statestring required
interval_secondsinteger required
auto_mergeboolean required
on_removestring required
write_noteboolean required
last_run_atstring date-time nullable required
last_success_atstring date-time nullable required
last_statusstring nullable required
last_errorstring nullable required
countsobject required
pr_numberinteger nullable required
pr_urlstring nullable required
pr_statestring nullable required
sync_branchstring nullable required
created_by_identity_idstring uuid required

Changes

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