Sign in
Pipelines

Run sync for a pipeline

Triggers an ad-hoc sync run for the pipeline and streams NDJSON messages (records, state, progress, eof) back to the client. Persists the ending sync_state on the pipeline so the next run resumes where this one left off.

post/pipelines/{id}/sync

Path parameters

idstring required

Unique pipeline identifier (e.g. pipe_abc123).

Example:pipe_abc123

Unique pipeline identifier (e.g. pipe_abc123).

Query parameters

time_limitnumber

Stop after N seconds

Stop after N seconds

run_idstring

Sync run identifier (resumes or starts fresh)

Sync run identifier (resumes or starts fresh)

reset_stateboolean

Ignore persisted sync state and start fresh (ending state is still saved)

Ignore persisted sync state and start fresh (ending state is still saved)

Request body

sourceSourceConfig — unresolved $ref

Response

Streaming NDJSON sync output

Changes

Changed in 14 of the 47 revisions of this API.3717

  • 0fb02347c6cc2See the full diff
    • ○

      added subschema #2 to the source request property oneOf list

      request-property-one-of-added

    • ○

      added subschema #3 to the destination request property oneOf list

      request-property-one-of-added

  • 0987d72f1a622See the full diff
    • ○

      added the new optional request property source/oneOf[subschema #2]/metronome/webhook_port

      new-optional-request-property

    • ○

      added the new optional request property source/oneOf[subschema #2]/metronome/webhook_secret

      new-optional-request-property

  • e7da611c8dfe2See the full diff
    • ○

      added subschema #2 to the source request property oneOf list

      request-property-one-of-added

    • ○

      added subschema #3 to the destination request property oneOf list

      request-property-one-of-added

  • e12c5be30b022See the full diff
    • ▲

      added the new required request property sync_state/sync_run/progress/derived/total_record_count

      new-required-request-property

    • ▲

      added the new required request property sync_state/sync_run/progress/derived/total_state_count

      new-required-request-property

  • d27c818295f01See the full diff
    • ●

      changed the pattern of the path request parameter id from ^[a-z][a-z0-9_-]*$ to ^[a-zA-Z][a-zA-Z0-9_-]*$

      request-parameter-pattern-changed

  • f10e963a18892See the full diff
    • ○

      the request property destination/oneOf[subschema #2]/google_sheets/access_token became optional

      request-property-became-optional

    • ○

      request property destination/oneOf[subschema #2]/google_sheets/access_token list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

  • c669c4f1f6131See the full diff
    • ●

      deleted the query request parameter state_limit

      request-parameter-removed

  • e34afe1c48ab1See the full diff
    • ●

      removed the request property source/oneOf[subschema #1]/stripe/max_concurrent_streams

      request-property-removed

  • 4284e9bc6bb022See the full diff
    • ●

      deleted the query request parameter sync_run_id

      request-parameter-removed

    • ●

      removed the request property sync_state/sync_run/sync_run_id

      request-property-removed

    • ○

      added the new optional query request parameter run_id

      new-optional-request-parameter

    • ○

      added the new optional request property sync_state/sync_run/run_id

      new-optional-request-property

  • 6b9d8074511411See the full diff
    • ●

      deleted the query request parameter no_state

      request-parameter-removed

    • ○

      added the new optional query request parameter reset_state

      new-optional-request-parameter