Cloudflare API | Pipelines › Deprecated Get Pipeline

API Reference

Overview

Account & User Management

Abuse Reports

Certificate Management

ACM

Certificate Authorities

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

SSL

Cloudflare One

Email Security

Zero Trust

DNS

Account Custom Nameservers

DNS

DNS Firewall

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Magic Transit

Network Interconnects

Observability

Radar

Routing & Performance

Rules

Security

Leaked Credential Checks

Storage & Databases

[DEPRECATED] List Pipelines

[DEPRECATED] Get Pipeline

[DEPRECATED] Create Pipeline

[DEPRECATED] Update Pipeline

[DEPRECATED] Delete Pipeline

Threat Intelligence

Workers & Pages

Workers For Platforms

Shared

Pipelines

pipelines

Methods

Deprecated List Pipelines -> { result_info, results, success }

Deprecated

get/accounts/{account_id}/pipelines

Deprecated

Use list_v1 instead. This endpoint will be removed in the future.

[DEPRECATED] List, filter, and paginate pipelines in an account. Use the new /pipelines/v1/pipelines endpoint instead.

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

Deprecated

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

Deprecated

Use get_v1 instead. This endpoint will be removed in the future.

[DEPRECATED] Get configuration of a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.

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 Pipelines Read

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... }

Deprecated

[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.

success: boolean

Indicates whether the API call was successful.

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pipelines/$PIPELINE_NAME \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

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
}

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

Deprecated

post/accounts/{account_id}/pipelines

Deprecated

Use create_v1 instead. This endpoint will be removed in the future.

[DEPRECATED] Create a new pipeline. Use the new /pipelines/v1/pipelines endpoint instead.

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

Deprecated

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

Deprecated

The v1 API does not support updates. This endpoint will be removed in the future.

[DEPRECATED] Update an existing pipeline. Use the new /pipelines/v1/pipelines endpoint instead.

Deprecated Delete Pipeline ->

Deprecated

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

Deprecated

Use delete_v1 instead. This endpoint will be removed in the future.

[DEPRECATED] Delete a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.

List Pipelines -> V4PagePaginationArray<{ id, created_at, modified_at, 3 more... }>

get/accounts/{account_id}/pipelines/v1/pipelines

List/Filter Pipelines in Account.

Get Pipeline Details -> Envelope<{ id, created_at, modified_at, 4 more... }>

get/accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id}

Get Pipelines Details.

Create Pipeline -> Envelope<{ id, created_at, modified_at, 3 more... }>

post/accounts/{account_id}/pipelines/v1/pipelines

Create a new Pipeline.

Delete Pipelines ->

delete/accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id}

Delete Pipeline in Account.

Validate Sql -> Envelope<{ tables, graph }>

post/accounts/{account_id}/pipelines/v1/validate_sql

Validate Arroyo SQL.

Pipelines

Sinks

pipelines.sinks

Methods

List Sinks -> V4PagePaginationArray<{ id, created_at, modified_at, 5 more... }>

get/accounts/{account_id}/pipelines/v1/sinks

List/Filter Sinks in Account.

Get Sink Details -> Envelope<{ id, created_at, modified_at, 5 more... }>

get/accounts/{account_id}/pipelines/v1/sinks/{sink_id}

Get Sink Details.

Create Sink -> Envelope<{ id, created_at, modified_at, 5 more... }>

post/accounts/{account_id}/pipelines/v1/sinks

Create a new Sink.

Delete Sink ->

delete/accounts/{account_id}/pipelines/v1/sinks/{sink_id}

Delete Pipeline in Account.

Pipelines

Streams

pipelines.streams

Methods

List Streams -> V4PagePaginationArray<{ id, created_at, http, 7 more... }>

get/accounts/{account_id}/pipelines/v1/streams

List/Filter Streams in Account.

Get Stream Details -> Envelope<{ id, created_at, http, 7 more... }>

get/accounts/{account_id}/pipelines/v1/streams/{stream_id}

Get Stream Details.

Create Stream -> Envelope<{ id, created_at, http, 7 more... }>

post/accounts/{account_id}/pipelines/v1/streams

Create a new Stream.

Update Stream -> Envelope<{ id, created_at, http, 6 more... }>

patch/accounts/{account_id}/pipelines/v1/streams/{stream_id}

Update a Stream.

Delete Stream ->

delete/accounts/{account_id}/pipelines/v1/streams/{stream_id}

Delete Stream in Account.