--- title: "[DEPRECATED] Update Pipeline" --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Pipelines](https://developers.cloudflare.com/api/typescript/resources/pipelines) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # \[DEPRECATED] Update Pipeline Deprecated: The v1 API does not support updates. This endpoint will be removed in the future. client.pipelines.update(stringpipelineName, PipelineUpdateParams {account\_id, destination, name, source } params, RequestOptionsoptions?): [PipelineUpdateResponse]() {id, destination, endpoint, 3 more } PUT/accounts/{account\_id}/pipelines/{pipeline\_name} \[DEPRECATED] Update an existing pipeline. Use the new /pipelines/v1/pipelines endpoint instead. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Pipelines Write` ##### ParametersExpand Collapse pipelineName: string Defines the name of the pipeline. maxLength128 minLength1 [Link to this property](<#(resource)%20pipelines%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20pipeline_name%20%3E%20(schema)>)
params: PipelineUpdateParams {account\_id, destination, name, source } account\_id: string Path param: Specifies the public ID of the account. Link to this property
destination: Destination Body param
batch: Batch {max\_bytes, max\_duration\_s, max\_rows } max\_bytes?: number Specifies rough maximum size of files. maximum100000000 minimum1000 Link to this property max\_duration\_s?: number Specifies duration to wait to aggregate batches files. maximum300 minimum0.25 Link to this property max\_rows?: number Specifies rough maximum number of rows per file. maximum10000000 minimum100 Link to this property
Link to this property
compression: Compression {type }
type?: "none"| "gzip"| "deflate" Specifies the desired compression algorithm and format. One of the following: "none" Link to this property "gzip" Link to this property "deflate" Link to this property
Link to this property
Link to this property format: "json" Specifies the format of data to deliver. Link to this property
path: Path {bucket, filename, filepath, prefix } bucket: string Specifies the R2 Bucket to store files. Link to this property filename?: string Specifies the name pattern to for individual data files. Link to this property filepath?: string Specifies the name pattern for directory. Link to this property prefix?: string Specifies the base directory within the bucket. Link to this property
Link to this property type: "r2" Specifies the type of destination. Link to this property
credentials?: Credentials {access\_key\_id, endpoint, secret\_access\_key } access\_key\_id: string Specifies the R2 Bucket Access Key Id. Link to this property endpoint: string Specifies the R2 Endpoint. Link to this property secret\_access\_key: string Specifies the R2 Bucket Secret Access Key. Link to this property
Link to this property
Link to this property name: string Body param: Defines the name of the pipeline. maxLength128 minLength1 Link to this property
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource {format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource {format, type } > Body param One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource {format, type, authentication, cors } \[DEPRECATED] HTTP source configuration. Use the new streams API instead. format: "json" Specifies the format of source data. Link to this property type: string Link to this property authentication?: boolean Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors?: CORS {origins } origins?: Array<string> Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource {format, type } \[DEPRECATED] Worker binding source configuration. Use the new streams API instead. format: "json" Specifies the format of source data. Link to this property type: string Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(method)%20update%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
PipelineUpdateResponse {id, destination, endpoint, 3 more } \[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead. id: string Specifies the pipeline identifier. Link to this property
destination: Destination {batch, compression, format, 2 more }
batch: Batch {max\_bytes, max\_duration\_s, max\_rows } max\_bytes: number Specifies rough maximum size of files. maximum100000000 minimum1000 Link to this property max\_duration\_s: number Specifies duration to wait to aggregate batches files. maximum300 minimum0.25 Link to this property max\_rows: number Specifies rough maximum number of rows per file. maximum10000000 minimum100 Link to this property
Link to this property
compression: Compression {type }
type: "none"| "gzip"| "deflate" Specifies the desired compression algorithm and format. One of the following: "none" Link to this property "gzip" Link to this property "deflate" Link to this property
Link to this property
Link to this property format: "json" Specifies the format of data to deliver. Link to this property
path: Path {bucket, filename, filepath, prefix } bucket: string Specifies the R2 Bucket to store files. Link to this property filename?: string Specifies the name pattern to for individual data files. Link to this property filepath?: string Specifies the name pattern for directory. Link to this property prefix?: string Specifies the base directory within the bucket. Link to this property
Link to this property type: "r2" Specifies the type of destination. Link to this property
Link to this property endpoint: string Indicates the endpoint URL to send traffic. Link to this property name: string Defines the name of the pipeline. maxLength128 minLength1 Link to this property
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource {format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource {format, type } > One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource {format, type, authentication, cors } \[DEPRECATED] HTTP source configuration. Use the new streams API instead. format: "json" Specifies the format of source data. Link to this property type: string Link to this property authentication?: boolean Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors?: CORS {origins } origins?: Array<string> Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource {format, type } \[DEPRECATED] Worker binding source configuration. Use the new streams API instead. format: "json" Specifies the format of source data. Link to this property type: string Link to this property
Link to this property
Link to this property version: number Indicates the version number of last saved configuration. Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_update_response%20%3E%20(schema)>) ### \[DEPRECATED] Update Pipeline TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const pipeline = await client.pipelines.update('sample_pipeline', { account_id: '0123105f4ecef8ad9ca31a8372d0c353', destination: { batch: {}, compression: {}, format: 'json', path: { bucket: 'bucket' }, type: 'r2', }, name: 'sample_pipeline', source: [{ format: 'json', type: 'type' }], }); console.log(pipeline.id); ``` 200 example ``` { "result": { "id": "123f8a8258064ed892a347f173372359", "destination": { "batch": { "max_bytes": 1000, "max_duration_s": 0.25, "max_rows": 100 }, "compression": { "type": "gzip" }, "format": "json", "path": { "bucket": "bucket", "filename": "${slug}${extension}", "filepath": "${date}/${hour}", "prefix": "base" }, "type": "r2" }, "endpoint": "https://123f8a8258064ed892a347f173372359.pipelines.cloudflare.com", "name": "sample_pipeline", "source": [ { "format": "json", "type": "type", "authentication": true, "cors": { "origins": [ "*" ] } } ], "version": 2 }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": { "id": "123f8a8258064ed892a347f173372359", "destination": { "batch": { "max_bytes": 1000, "max_duration_s": 0.25, "max_rows": 100 }, "compression": { "type": "gzip" }, "format": "json", "path": { "bucket": "bucket", "filename": "${slug}${extension}", "filepath": "${date}/${hour}", "prefix": "base" }, "type": "r2" }, "endpoint": "https://123f8a8258064ed892a347f173372359.pipelines.cloudflare.com", "name": "sample_pipeline", "source": [ { "format": "json", "type": "type", "authentication": true, "cors": { "origins": [ "*" ] } } ], "version": 2 }, "success": true } ```