Cloudflare API | Pipelines › Update Pipeline

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Storage & Databases

Create Pipeline

Delete Pipeline

Update Pipeline

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Pipelines

pipelines

Methods

Create Pipeline -> Envelope<{ id, destination, endpoint, 3 more... }>

post/accounts/{account_id}/pipelines

Create a new pipeline.

Delete Pipeline ->

delete/accounts/{account_id}/pipelines/{pipeline_name}

Delete a pipeline.

Get Pipeline -> Envelope<{ id, destination, endpoint, 3 more... }>

get/accounts/{account_id}/pipelines/{pipeline_name}

Get configuration of a pipeline.

List Pipelines -> { result_info, results, success }

get/accounts/{account_id}/pipelines

List, filter, and paginate pipelines in an account.

Update Pipeline -> Envelope<{ id, destination, endpoint, 3 more... }>

put/accounts/{account_id}/pipelines/{pipeline_name}

Update an existing pipeline.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Pipelines Write

path Parameters

account_id: string

Specifies the public ID of the account.

pipeline_name: string

(maxLength: 128, minLength: 1)

Defines the name of the pipeline.

Response fields

result: { id, destination, endpoint, 3 more... }

Describes the configuration of a pipeline.

success: boolean

Indicates whether the API call was successful.

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pipelines/$PIPELINE_NAME \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "destination": {
        "batch": {},
        "compression": {},
        "format": "json",
        "path": {
          "bucket": "bucket",
          "prefix": "base"
        },
        "type": "r2"
      },
      "name": "sample_pipeline",
      "source": [
        {
          "format": "json",
          "type": "type"
        }
      ]
    }'

200Example

{
  "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
}