Sign in

v50

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-0193273218.8 KB
Redpanda Connect Pipelines

Update a Redpanda Connect pipeline

Update the configuration of a Redpanda Connect pipeline.

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

Path parameters

idstring required

Pipeline ID.

Query parameters

update_maskstring

Specifies which fields should be updated. If not provided, all fields will be updated.

Request body

config_yamlstring required

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

descriptionstring

Pipeline description.

display_namestring required

User-friendly pipeline name.

tagsobject

A map of tags to add, update or delete. If a tag's value is empty, the server interprets that as a deletion.

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.