Sign in
Pipelines

Retrieve pipeline

get/pipelines/{id}

Path parameters

idstring required

Unique pipeline identifier (e.g. pipe_abc123).

Example:pipe_abc123

Unique pipeline identifier (e.g. pipe_abc123).

Response

Retrieved pipeline with status

idstring required

Unique pipeline identifier (e.g. pipe_abc123).

sourceSourceConfig required— unresolved $ref
desired_status'active' | 'paused' | 'deleted' required

User-controlled lifecycle state. Set via PATCH to pause, resume, or delete.

status'setup' | 'backfill' | 'ready' | 'paused' | 'teardown' | 'error' required

Workflow-controlled execution state. Updated by the Temporal workflow.

Changes

Changed in 28 of the 47 revisions of this API.269554

  • 0fb02347c6cc2See the full diff
    • ▲

      added subschema #2 to the source response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added subschema #3 to the destination response property oneOf list for the response status 200

      response-property-one-of-added

  • 0987d72f1a622See the full diff
    • ○

      added the optional property source/oneOf[subschema #2]/metronome/webhook_port to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property source/oneOf[subschema #2]/metronome/webhook_secret to the response with the 200 status

      response-optional-property-added

  • e7da611c8dfe2See the full diff
    • ▲

      added subschema #2 to the source response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added subschema #3 to the destination response property oneOf list for the response status 200

      response-property-one-of-added

  • e12c5be30b022See the full diff
    • ○

      added the required property sync_state/sync_run/progress/derived/total_record_count to the response with the 200 status

      response-required-property-added

    • ○

      added the required property sync_state/sync_run/progress/derived/total_state_count to the response with the 200 status

      response-required-property-added

  • d27c818295f011See 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

    • ○

      the id response's property pattern was changed from ^[a-z][a-z0-9_-]*$ to ^[a-zA-Z][a-zA-Z0-9_-]*$ for the status 200

      response-property-pattern-changed

  • f10e963a18892See the full diff
    • ▲

      the response property destination/oneOf[subschema #2]/google_sheets/access_token became optional for the status 200

      response-property-became-optional

    • ▲

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

      response-property-list-of-types-widened

  • e34afe1c48ab1See the full diff
    • ●

      removed the optional property source/oneOf[subschema #1]/stripe/max_concurrent_streams from the response with the 200 status

      response-optional-property-removed

  • 4284e9bc6bb011See the full diff
    • ●

      removed the optional property sync_state/sync_run/sync_run_id from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property sync_state/sync_run/run_id to the response with the 200 status

      response-optional-property-added

  • a88e8958452521See the full diff
    • ●

      removed the optional property last_progress from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property sync_state/sync_run/progress/streams/additionalProperties/time_range from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property sync_state/sync_run/progress/streams/additionalProperties/total_range to the response with the 200 status

      response-optional-property-added

  • 678a866828d212See the full diff
    • ●

      removed the optional property progress from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property last_progress to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sync_state to the response with the 200 status

      response-optional-property-added