PUT /accounts/{account_id}/pipelines/{pipeline_name}
Update an existing pipeline.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
pipeline_name |
String | Yes | |
account_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
source[] |
Array | Yes | |
name |
String | Yes |
Defines the name of the pipeline. |
destination |
Object | Yes | |
destination.compression |
Object | Yes | |
destination.compression.type |
String | No |
Specifies the desired compression algorithm and format. Possible values:
Default value: "gzip" |
destination.format |
String | Yes |
Specifies the format of data to deliver. Possible values:
|
destination.credentials |
Object | No | |
destination.credentials.secret_access_key |
String | Yes |
Specifies the R2 Bucket Secret Access Key. |
destination.credentials.access_key_id |
String | Yes |
Specifies the R2 Bucket Access Key Id. |
destination.credentials.endpoint |
String | Yes |
Specifies the R2 Endpoint. |
destination.type |
String | Yes |
Specifies the type of destination. Possible values:
|
destination.batch |
Object | Yes | |
destination.batch.max_duration_s |
Number | No |
Specifies duration to wait to aggregate batches files. Default value: 300 |
destination.batch.max_rows |
Integer | No |
Specifies rough maximum number of rows per file. |
destination.batch.max_bytes |
Integer | No |
Specifies rough maximum size of files. |
destination.path |
Object | Yes | |
destination.path.filepath |
String | No |
Specifies the name pattern for directory. |
destination.path.prefix |
String | No |
Specifies the base directory within the bucket. |
destination.path.bucket |
String | Yes |
Specifies the R2 Bucket to store files. |
destination.path.filename |
String | No |
Specifies the name pattern to for individual data files. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.