REredpanda-data
Redpanda Connect Pipelines

Update a Redpanda Connect pipeline

Changed on

Update the configuration of a Redpanda Connect pipeline.

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

Request

  • Base URL
    https://{dataplane_api_url}
  • Auth
    OAuth 2
    Implicit: https://auth.prd.cloud.redpanda.com/oauth/authorize

Path parameters

idstring required

Pipeline ID.

Query parameters

update_maskstring

Specifies which fields should be updated. If not provided, all fields will be updated, except that an unset egress is left as it is.

Request body

config_yamlstring required

The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details. May be empty only when the stored pipeline is a draft.

descriptionstring

Pipeline description.

display_namestring required

User-friendly pipeline name.

draftboolean nullable

Asserts that the pipeline is a draft: when true, the update fails with FAILED_PRECONDITION if the pipeline has since been started. An update never changes whether a pipeline is a draft; false is rejected, and StartPipeline promotes a draft. Leave unset to update whatever is stored.

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.

create_timestring date-time

When the pipeline was created.

created_bystring

The principal that created the pipeline: a user's email address or a service account's identifier. Empty for pipelines created before this field existed. Attribution only; pipeline permissions are cluster-wide.

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_DRAFT'

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.
  • STATE_DRAFT: The pipeline is saved but has never been deployed. It does not run, is not billed, and its configuration may be incomplete or invalid. StartPipeline validates and deploys it. Omitted from ListPipelines unless ListPipelinesRequest.Filter.include_drafts is set.
tagsobject

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

update_timestring date-time

When the pipeline was last updated. Starting and stopping do not change it. Empty for pipelines not written since this field existed.

urlstring

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

Changes

  • fa974d711625Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • b77f7e26e736Revision changes
    • warning

      added the new STATE_DRAFT enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status