[DEPRECATED] Update Pipeline

client.pipelines.update(, , ?): 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

params: PipelineUpdateParams { account_id, destination, name, source }

account_id: string

Path param: Specifies the public ID of the account.

destination: Destination

Body param

batch: Batch { max_bytes, max_duration_s, max_rows }

max_bytes?: number

Specifies rough maximum size of files.

maximum100000000

minimum1000

max_duration_s?: number

Specifies duration to wait to aggregate batches files.

maximum300

minimum0.25

max_rows?: number

Specifies rough maximum number of rows per file.

maximum10000000

minimum100

compression: Compression { type }

type?: "none" | "gzip" | "deflate"

Specifies the desired compression algorithm and format.

One of the following:

"none"

"gzip"

"deflate"

format: "json"

Specifies the format of data to deliver.

path: Path { bucket, filename, filepath, prefix }

bucket: string

Specifies the R2 Bucket to store files.

filename?: string

Specifies the name pattern to for individual data files.

filepath?: string

Specifies the name pattern for directory.

prefix?: string

Specifies the base directory within the bucket.

type: "r2"

Specifies the type of destination.

credentials?: Credentials { access_key_id, endpoint, secret_access_key }

access_key_id: string

Specifies the R2 Bucket Access Key Id.

endpoint: string

Specifies the R2 Endpoint.

secret_access_key: string

Specifies the R2 Bucket Secret Access Key.