Sign in
Pipelines

Run sync for a pipeline (batch, returns JSON)

Runs the full sync pipeline and returns the final EofPayload as a single JSON response. Persists the ending sync_state on the pipeline so the next run resumes where this one left off.

post/pipelines/{id}/sync_batch

Path parameters

idstring required

Unique pipeline identifier (e.g. pipe_abc123).

Example:pipe_abc123

Unique pipeline identifier (e.g. pipe_abc123).

Query parameters

state_limitinteger

Stop after N source_state messages

Stop after N source_state messages

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

Sync result

status'started' | 'succeeded' | 'failed' required

succeeded = all streams completed/skipped; failed = connection_status failed OR any stream errored.

has_moreboolean required

Whether the client should continue with another request. true when cut off by limits; false when the source iterator exhausted naturally.

Changes

Changed in 5 of the 47 revisions of this API.17

  • 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

  • e12c5be30b021See the full diff
    • ○

      endpoint added

      endpoint-added

  • 131345353e381See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog