# Update a Redpanda Connect pipeline

**PUT /v1/redpanda-connect/pipelines/{id}**

Update the [configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) of a Redpanda Connect pipeline.


## Servers
- Data Plane API: https://{dataplane_api_subdomain}.cloud.redpanda.com (Data Plane API)


## Authentication methods
- Auth0


## Parameters

### Path parameters
- **id** (string)
  Pipeline ID.

### Query parameters
- **update_mask** (string)
  Specifies which fields should be updated. If not provided,
  all fields will be updated.

### Body: application/json (object)

- **config_yaml** (string)
  The Redpanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details.
- **description** (string)
  Pipeline description.
- **display_name** (string)
  User-friendly pipeline name.
- **resources** (object)

- **service_account** (object)

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


## Responses
### 200
OK

#### Body: application/json (object)
- **config_yaml** (string)
  The Redpanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details.
- **description** (string)
  Optional pipeline description.
- **display_name** (string)
  User-friendly pipeline name.
- **id** (string)
  Pipeline ID.
- **resources** (object)

- **service_account** (object)

- **state** (string)
  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](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/error_handling/) for further guidance.
   - STATE_COMPLETED: The pipeline has completed the job successfully.
- **status** (object)
  Pipeline status may contain an error message.
- **tags** (object)
  Tags are key-value pairs that can be assigned to a pipeline resource.
  They help organize pipelines and enable filtering when listing them.
- **url** (string)
  URL to connect to the pipeline, for example, via http_server.
  May be empty if no http_server is used.

### 401
Unauthenticated.

#### Body: application/json (object)
- **code** (string(int32))
  RPC status code, as described [here](https://github.com/googleapis/googleapis/blob/b4c238feaa1097c53798ed77035bbfeb7fc72e96/google/rpc/code.proto#L32).
- **details** (array[object])
  A list of messages that carries the error details.
- **message** (string)
  Detailed error message. No compatibility guarantees are given for the text contained in this message.

### 500
Internal Server Error. Reach out to support.

#### Body: application/json (object)
- **code** (string(int32))
  RPC status code, as described [here](https://github.com/googleapis/googleapis/blob/b4c238feaa1097c53798ed77035bbfeb7fc72e96/google/rpc/code.proto#L32).
- **details** (array[object])
  A list of messages that carries the error details.
- **message** (string)
  Detailed error message. No compatibility guarantees are given for the text contained in this message.

### default
An unexpected error response.

#### Body: application/json (object)
- **code** (string(int32))
  RPC status code, as described [here](https://github.com/googleapis/googleapis/blob/b4c238feaa1097c53798ed77035bbfeb7fc72e96/google/rpc/code.proto#L32).
- **details** (array[object])
  A list of messages that carries the error details.
- **message** (string)
  Detailed error message. No compatibility guarantees are given for the text contained in this message.


[Powered by Bump.sh](https://bump.sh)