library-syncs

Patch Sync

Pause or resume a folder sync or change its schedule; for GitHub its auto-merge, removal policy and note file; for a website its crawl settings; for a Google import whether new documents arrive published.

patch/api/folders/{library_id}/syncs/{sync_id}

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/{sync_id}
  • Auth: none declared

Path parameters

library_idstring uuid required
sync_idstring uuid required

Headers

x-impersonate-identity-idstring nullable

Request body

state'active' | 'paused' nullable
interval_secondsinteger nullable
auto_mergeboolean nullable
on_remove'leave' | 'remove' nullable
write_noteboolean nullable
modestring nullable
destinationstring nullable
discoverystring nullable
crawl_depthinteger nullable
path_prefixstring nullable
max_pagesinteger nullable
max_bytesinteger nullable
arrive_publishedboolean nullable

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.