PAparley
Syncs

Run a sync now

Bring a synced folder up to date now instead of waiting for its next run. Returns the sync as soon as the run is queued. Returns 409 SYNC_NOT_RUNNABLE when the sync can't run, and details.reason says why.

post/syncs/{id}/run

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/syncs/{id}/run
  • Auth
    HTTP bearer

Path parameters

idstring required

The sync ID.

Response

OK

idstring required

The sync ID.

status'pending' | 'active' | 'interrupted' | 'failed' required

pending: created, and its first run hasn't finished. active: syncing. interrupted: a run hit a problem Parley is resolving on its own. failed: it stopped syncing; delete it and sync the folder again.

reconnectRequiredboolean required

true when the connection the sync reads through stopped working. The sync doesn't run until the person who owns that connection reconnects it.

lastSyncedAtstring date-time nullable required

When a run last finished, or null before the first.

createdAtstring date-time required

When the sync was created.

updatedAtstring date-time required

When the sync last changed, including its status.

Changes

No recorded changes to this operation across all 2 revisions of this API.