API Reference

Pipelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sinks

List Sinks

client.pipelines.sinks.list(SinkListParams { account_id, name, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<SinkListResponse { id, created_at, modified_at, 5 more } >

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

Get Sink Details

client.pipelines.sinks.get(stringsinkID, SinkGetParams { account_id } params, RequestOptionsoptions?): SinkGetResponse { id, created_at, modified_at, 5 more }

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

Create Sink

client.pipelines.sinks.create(SinkCreateParams { account_id, name, type, 3 more } params, RequestOptionsoptions?): SinkCreateResponse { id, created_at, modified_at, 5 more }

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

Delete Sink

client.pipelines.sinks.delete(stringsinkID, SinkDeleteParams { account_id } params, RequestOptionsoptions?): SinkDeleteResponse

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

ModelsExpand Collapse

SinkListResponse { id, created_at, modified_at, 5 more }

id: string

Indicates a unique identifier for this sink.

created_at: string

formatdate-time

modified_at: string

formatdate-time

name: string

Defines the name of the Sink.

maxLength128

minLength1

type: "r2" | "r2_data_catalog"

Specifies the type of sink.

One of the following:

"r2"

"r2_data_catalog"

config?: CloudflarePipelinesR2TablePublic { account_id, bucket, file_naming, 4 more } | CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more }

Defines the configuration of the R2 Sink.

One of the following:

CloudflarePipelinesR2TablePublic { account_id, bucket, file_naming, 4 more }

R2 Sink public configuration.

account_id: string

Cloudflare Account ID for the bucket

bucket: string

R2 Bucket to write to

file_naming?: FileNaming { prefix, strategy, suffix }

Controls filename prefix/suffix and strategy.

prefix?: string

The prefix to use in file name. i.e prefix-.parquet

strategy?: "serial" | "uuid" | "uuid_v7" | "ulid"

Filename generation strategy.

One of the following:

"serial"

"uuid"

"uuid_v7"

"ulid"

suffix?: string

This will overwrite the default file suffix. i.e .parquet, use with caution

jurisdiction?: string

Jurisdiction this bucket is hosted in

partitioning?: Partitioning { time_pattern }

Data-layout partitioning for sinks.

time_pattern?: string

The pattern of the date string

path?: string

Subpath within the bucket to write to

rolling_policy?: RollingPolicy { file_size_bytes, inactivity_seconds, interval_seconds }

Rolling policy for file sinks (when & why to close a file and open a new one).

file_size_bytes?: number

Files will be rolled after reaching this number of bytes

formatuint64

minimum0

inactivity_seconds?: number

Number of seconds of inactivity to wait before rolling over to a new file

formatuint64

minimum1

interval_seconds?: number

Number of seconds to wait before rolling over to a new file

formatuint64

minimum1

CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more }

R2 Data Catalog Sink public configuration.

account_id: string

Cloudflare Account ID

formaturi

bucket: string

The R2 Bucket that hosts this catalog

table_name: string

Table name

namespace?: string

Table namespace

rolling_policy?: RollingPolicy { file_size_bytes, inactivity_seconds, interval_seconds }

Rolling policy for file sinks (when & why to close a file and open a new one).

file_size_bytes?: number

Files will be rolled after reaching this number of bytes

formatuint64

minimum0

inactivity_seconds?: number

Number of seconds of inactivity to wait before rolling over to a new file

formatuint64

minimum1

interval_seconds?: number

Number of seconds to wait before rolling over to a new file

formatuint64

minimum1

format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }

Defines the output data format of a sink.

One of the following:

CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more }

type: "json"

compression?: "uncompressed" | "gzip"

Specifies the compression applied to JSON sink output.

One of the following:

"uncompressed"

"gzip"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

schema?: Schema { fields, inferred }

Defines the schema of the events in the data stream.

fields?: Array<Int32 { type, metadata_key, name, 2 more } | Int64 { type, metadata_key, name, 2 more } | Float32 { type, metadata_key, name, 2 more } | 8 more>

One of the following:

Int32 { type, metadata_key, name, 2 more }

type: "int32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Int64 { type, metadata_key, name, 2 more }

type: "int64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float32 { type, metadata_key, name, 2 more }

type: "float32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float64 { type, metadata_key, name, 2 more }

type: "float64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Bool { type, metadata_key, name, 2 more }

type: "bool"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

String { type, metadata_key, name, 2 more }

type: "string"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Binary { type, metadata_key, name, 2 more }

type: "binary"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Timestamp { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

unit?: "second" | "millisecond" | "microsecond" | "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json { type, metadata_key, name, 2 more }

type: "json"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Struct

List

inferred?: boolean | null

SinkGetResponse { id, created_at, modified_at, 5 more }

id: string

Indicates a unique identifier for this sink.

created_at: string

formatdate-time

modified_at: string

formatdate-time

name: string

Defines the name of the Sink.

maxLength128

minLength1

type: "r2" | "r2_data_catalog"

Specifies the type of sink.

One of the following:

"r2"

"r2_data_catalog"

config?: CloudflarePipelinesR2TablePublic { account_id, bucket, file_naming, 4 more } | CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more }

Defines the configuration of the R2 Sink.

One of the following:

CloudflarePipelinesR2TablePublic { account_id, bucket, file_naming, 4 more }

R2 Sink public configuration.

account_id: string

Cloudflare Account ID for the bucket

bucket: string

R2 Bucket to write to

file_naming?: FileNaming { prefix, strategy, suffix }

Controls filename prefix/suffix and strategy.

prefix?: string

The prefix to use in file name. i.e prefix-.parquet

strategy?: "serial" | "uuid" | "uuid_v7" | "ulid"

Filename generation strategy.

One of the following:

"serial"

"uuid"

"uuid_v7"

"ulid"

suffix?: string

This will overwrite the default file suffix. i.e .parquet, use with caution

jurisdiction?: string

Jurisdiction this bucket is hosted in

partitioning?: Partitioning { time_pattern }

Data-layout partitioning for sinks.

time_pattern?: string

The pattern of the date string

path?: string

Subpath within the bucket to write to

rolling_policy?: RollingPolicy { file_size_bytes, inactivity_seconds, interval_seconds }

Rolling policy for file sinks (when & why to close a file and open a new one).

file_size_bytes?: number

Files will be rolled after reaching this number of bytes

formatuint64

minimum0

inactivity_seconds?: number

Number of seconds of inactivity to wait before rolling over to a new file

formatuint64

minimum1

interval_seconds?: number

Number of seconds to wait before rolling over to a new file

formatuint64

minimum1

CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more }

R2 Data Catalog Sink public configuration.

account_id: string

Cloudflare Account ID

formaturi

bucket: string

The R2 Bucket that hosts this catalog

table_name: string

Table name

namespace?: string

Table namespace

rolling_policy?: RollingPolicy { file_size_bytes, inactivity_seconds, interval_seconds }

Rolling policy for file sinks (when & why to close a file and open a new one).

file_size_bytes?: number

Files will be rolled after reaching this number of bytes

formatuint64

minimum0

inactivity_seconds?: number

Number of seconds of inactivity to wait before rolling over to a new file

formatuint64

minimum1

interval_seconds?: number

Number of seconds to wait before rolling over to a new file

formatuint64

minimum1

format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }

Defines the output data format of a sink.

One of the following:

CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more }

type: "json"

compression?: "uncompressed" | "gzip"

Specifies the compression applied to JSON sink output.

One of the following:

"uncompressed"

"gzip"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

schema?: Schema { fields, inferred }

Defines the schema of the events in the data stream.

fields?: Array<Int32 { type, metadata_key, name, 2 more } | Int64 { type, metadata_key, name, 2 more } | Float32 { type, metadata_key, name, 2 more } | 8 more>

One of the following:

Int32 { type, metadata_key, name, 2 more }

type: "int32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Int64 { type, metadata_key, name, 2 more }

type: "int64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float32 { type, metadata_key, name, 2 more }

type: "float32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float64 { type, metadata_key, name, 2 more }

type: "float64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Bool { type, metadata_key, name, 2 more }

type: "bool"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

String { type, metadata_key, name, 2 more }

type: "string"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Binary { type, metadata_key, name, 2 more }

type: "binary"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Timestamp { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

unit?: "second" | "millisecond" | "microsecond" | "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json { type, metadata_key, name, 2 more }

type: "json"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Struct

List

inferred?: boolean | null

SinkCreateResponse { id, created_at, modified_at, 5 more }

id: string

Indicates a unique identifier for this sink.

created_at: string

formatdate-time

modified_at: string

formatdate-time

name: string

Defines the name of the Sink.

maxLength128

minLength1

type: "r2" | "r2_data_catalog"

Specifies the type of sink.

One of the following:

"r2"

"r2_data_catalog"

config?: CloudflarePipelinesR2Table { account_id, bucket, credentials, 5 more } | CloudflarePipelinesR2DataCatalogTable { token, account_id, bucket, 3 more }

R2 Data Catalog Sink

One of the following:

CloudflarePipelinesR2Table { account_id, bucket, credentials, 5 more }

account_id: string

Cloudflare Account ID for the bucket

bucket: string

R2 Bucket to write to

credentials: Credentials { access_key_id, secret_access_key }

access_key_id: string

Cloudflare Account ID for the bucket

formatvar-str

secret_access_key: string

Cloudflare Account ID for the bucket

formatvar-str

file_naming?: FileNaming { prefix, strategy, suffix }

Controls filename prefix/suffix and strategy.

prefix?: string

The prefix to use in file name. i.e prefix-.parquet

strategy?: "serial" | "uuid" | "uuid_v7" | "ulid"

Filename generation strategy.

One of the following:

"serial"

"uuid"

"uuid_v7"

"ulid"

suffix?: string

This will overwrite the default file suffix. i.e .parquet, use with caution

jurisdiction?: string

Jurisdiction this bucket is hosted in

partitioning?: Partitioning { time_pattern }

Data-layout partitioning for sinks.

time_pattern?: string

The pattern of the date string

path?: string

Subpath within the bucket to write to

rolling_policy?: RollingPolicy { file_size_bytes, inactivity_seconds, interval_seconds }

Rolling policy for file sinks (when & why to close a file and open a new one).

file_size_bytes?: number

Files will be rolled after reaching this number of bytes

formatuint64

minimum0

inactivity_seconds?: number

Number of seconds of inactivity to wait before rolling over to a new file

formatuint64

minimum1

interval_seconds?: number

Number of seconds to wait before rolling over to a new file

formatuint64

minimum1

CloudflarePipelinesR2DataCatalogTable { token, account_id, bucket, 3 more }

R2 Data Catalog Sink

token: string

Authentication token

formatvar-str

account_id: string

Cloudflare Account ID

formaturi

bucket: string

The R2 Bucket that hosts this catalog

table_name: string

Table name

namespace?: string

Table namespace

rolling_policy?: RollingPolicy { file_size_bytes, inactivity_seconds, interval_seconds }

Rolling policy for file sinks (when & why to close a file and open a new one).

file_size_bytes?: number

Files will be rolled after reaching this number of bytes

formatuint64

minimum0

inactivity_seconds?: number

Number of seconds of inactivity to wait before rolling over to a new file

formatuint64

minimum1

interval_seconds?: number

Number of seconds to wait before rolling over to a new file

formatuint64

minimum1

format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }

Defines the output data format of a sink.

One of the following:

CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more }

type: "json"

compression?: "uncompressed" | "gzip"

Specifies the compression applied to JSON sink output.

One of the following:

"uncompressed"

"gzip"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

schema?: Schema { fields, inferred }

Defines the schema of the events in the data stream.

fields?: Array<Int32 { type, metadata_key, name, 2 more } | Int64 { type, metadata_key, name, 2 more } | Float32 { type, metadata_key, name, 2 more } | 8 more>

One of the following:

Int32 { type, metadata_key, name, 2 more }

type: "int32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Int64 { type, metadata_key, name, 2 more }

type: "int64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float32 { type, metadata_key, name, 2 more }

type: "float32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float64 { type, metadata_key, name, 2 more }

type: "float64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Bool { type, metadata_key, name, 2 more }

type: "bool"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

String { type, metadata_key, name, 2 more }

type: "string"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Binary { type, metadata_key, name, 2 more }

type: "binary"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Timestamp { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

unit?: "second" | "millisecond" | "microsecond" | "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json { type, metadata_key, name, 2 more }

type: "json"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Struct

List

inferred?: boolean | null

SinkDeleteResponse = unknown