--- title: Sinks --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Pipelines](https://developers.cloudflare.com/api/typescript/resources/pipelines) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Sinks ##### [List Sinks](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/sinks/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/sinks/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/sinks/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/sinks/methods/delete) 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. Link to this property created\_at: string formatdate-time Link to this property modified\_at: string formatdate-time Link to this property name: string Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: "r2"| "r2\_data\_catalog"| "basin\_catalog" Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
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 Link to this property bucket: string R2 Bucket to write to Link to this property
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 Link to this property
strategy?: "serial"| "uuid"| "uuid\_v7"| "ulid" Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix?: string This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction?: string Jurisdiction this bucket is hosted in Link to this property
partitioning?: Partitioning {time\_pattern } Data-layout partitioning for sinks. time\_pattern?: string The pattern of the date string Link to this property
Link to this property path?: string Subpath within the bucket to write to Link to this property
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 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: number Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
CloudflarePipelinesR2DataCatalogTablePublic {account\_id, bucket, table\_name, 2 more } R2 Data Catalog Sink public configuration. account\_id: string Cloudflare Account ID formaturi Link to this property bucket: string The R2 Bucket that hosts this catalog Link to this property table\_name: string Table name Link to this property namespace?: string Table namespace Link to this property
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 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: number Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
Link to this property
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" Link to this property
compression?: "uncompressed"| "gzip" Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(model)%20sink_list_response%20%3E%20(schema)>)
SinkGetResponse {id, created\_at, modified\_at, 5 more } id: string Indicates a unique identifier for this sink. Link to this property created\_at: string formatdate-time Link to this property modified\_at: string formatdate-time Link to this property name: string Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: "r2"| "r2\_data\_catalog"| "basin\_catalog" Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
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 Link to this property bucket: string R2 Bucket to write to Link to this property
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 Link to this property
strategy?: "serial"| "uuid"| "uuid\_v7"| "ulid" Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix?: string This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction?: string Jurisdiction this bucket is hosted in Link to this property
partitioning?: Partitioning {time\_pattern } Data-layout partitioning for sinks. time\_pattern?: string The pattern of the date string Link to this property
Link to this property path?: string Subpath within the bucket to write to Link to this property
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 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: number Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
CloudflarePipelinesR2DataCatalogTablePublic {account\_id, bucket, table\_name, 2 more } R2 Data Catalog Sink public configuration. account\_id: string Cloudflare Account ID formaturi Link to this property bucket: string The R2 Bucket that hosts this catalog Link to this property table\_name: string Table name Link to this property namespace?: string Table namespace Link to this property
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 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: number Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
Link to this property
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" Link to this property
compression?: "uncompressed"| "gzip" Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(model)%20sink_get_response%20%3E%20(schema)>)
SinkCreateResponse {id, created\_at, modified\_at, 5 more } id: string Indicates a unique identifier for this sink. Link to this property created\_at: string formatdate-time Link to this property modified\_at: string formatdate-time Link to this property name: string Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: "r2"| "r2\_data\_catalog"| "basin\_catalog" Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
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 Link to this property bucket: string R2 Bucket to write to Link to this property
credentials: Credentials {access\_key\_id, secret\_access\_key } access\_key\_id: string Cloudflare Account ID for the bucket formatvar-str Link to this property secret\_access\_key: string Cloudflare Account ID for the bucket formatvar-str Link to this property
Link to this property
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 Link to this property
strategy?: "serial"| "uuid"| "uuid\_v7"| "ulid" Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix?: string This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction?: string Jurisdiction this bucket is hosted in Link to this property
partitioning?: Partitioning {time\_pattern } Data-layout partitioning for sinks. time\_pattern?: string The pattern of the date string Link to this property
Link to this property path?: string Subpath within the bucket to write to Link to this property
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 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: number Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
CloudflarePipelinesR2DataCatalogTable {token, account\_id, bucket, 3 more } R2 Data Catalog Sink token: string Authentication token formatvar-str Link to this property account\_id: string Cloudflare Account ID formaturi Link to this property bucket: string The R2 Bucket that hosts this catalog Link to this property table\_name: string Table name Link to this property namespace?: string Table namespace Link to this property
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 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: number Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property
Link to this property
Link to this property
Link to this property
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" Link to this property
compression?: "uncompressed"| "gzip" Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(model)%20sink_create_response%20%3E%20(schema)>) SinkDeleteResponse = unknown [Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(model)%20sink_delete_response%20%3E%20(schema)>)