Sign in
Redpanda Connect Pipelines

Get Redpanda Connect pipeline

Get a specific Redpanda Connect pipeline.

get/v1/redpanda-connect/pipelines/{id}

Path parameters

idstring required

Pipeline ID.

Response

OK

config_yamlstring required

The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.

descriptionstring

Optional pipeline description.

display_namestring required

User-friendly pipeline name.

idstring required

Pipeline ID.

state'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_STOPPING' | 'STATE_STOPPED' | 'STATE_ERROR' | 'STATE_COMPLETED'

State of the pipeline.

  • STATE_STARTING: The pipeline is starting.
  • STATE_RUNNING: The pipeline is running.
  • STATE_STOPPING: The pipeline is in the process of stopping.
  • STATE_STOPPED: The pipeline is stopped and in paused state.
  • STATE_ERROR: The pipeline encountered an error. See Error Handling for further guidance.
  • STATE_COMPLETED: The pipeline has completed the job successfully.
tagsobject

Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them.

urlstring

URL to connect to the pipeline, for example, via http_server. May be empty if no http_server is used.

Changes

Changed in 3 of the 51 revisions of this API.15

  • e76564a24c261See the full diff
    • ○

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

      response-optional-property-added

  • dc5aad6b75192See the full diff
    • ○

      api tag Redpanda Connect Pipelines added

      api-tag-added

    • ○

      api tag Redpanda Connect Pipeline removed

      api-tag-removed

  • dfa71f9d277e12See the full diff
    • ●

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

      response-optional-property-removed

    • ○

      api tag Redpanda Connect Pipeline added

      api-tag-added

    • ○

      api tag Redpanda Connect Pipelines removed

      api-tag-removed

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