--- title: Sinks --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Pipelines](https://developers.cloudflare.com/api/python/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/python/resources/pipelines/subresources/sinks/methods/list) pipelines.sinks.list(SinkListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[SinkListResponse]()] GET/accounts/{account\_id}/pipelines/v1/sinks ##### [Get Sink Details](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/sinks/methods/get) pipelines.sinks.get(strsink\_id, SinkGetParams\*\*kwargs) -> [SinkGetResponse]() GET/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id} ##### [Create Sink](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/sinks/methods/create) pipelines.sinks.create(SinkCreateParams\*\*kwargs) -> [SinkCreateResponse]() POST/accounts/{account\_id}/pipelines/v1/sinks ##### [Delete Sink](https://developers.cloudflare.com/api/python/resources/pipelines/subresources/sinks/methods/delete) pipelines.sinks.delete(strsink\_id, SinkDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id} ##### ModelsExpand Collapse
class SinkListResponse: … id: str Indicates a unique identifier for this sink. Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property name: str Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: Literal\["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: Optional\[Config] Defines the configuration of the R2 Sink. One of the following:
class ConfigCloudflarePipelinesR2TablePublic: … R2 Sink public configuration. account\_id: str Cloudflare Account ID for the bucket Link to this property bucket: str R2 Bucket to write to Link to this property
file\_naming: Optional\[ConfigCloudflarePipelinesR2TablePublicFileNaming] Controls filename prefix/suffix and strategy. prefix: Optional\[str] The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy: Optional\[Literal\["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: Optional\[str] This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction: Optional\[str] Jurisdiction this bucket is hosted in Link to this property
partitioning: Optional\[ConfigCloudflarePipelinesR2TablePublicPartitioning] Data-layout partitioning for sinks. time\_pattern: Optional\[str] The pattern of the date string Link to this property
Link to this property path: Optional\[str] Subpath within the bucket to write to Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2TablePublicRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] 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
class ConfigCloudflarePipelinesR2DataCatalogTablePublic: … R2 Data Catalog Sink public configuration. account\_id: str Cloudflare Account ID formaturi Link to this property bucket: str The R2 Bucket that hosts this catalog Link to this property table\_name: str Table name Link to this property namespace: Optional\[str] Table namespace Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] 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: Optional\[Format] Defines the output data format of a sink. One of the following:
class FormatCloudflarePipelinesSinkJsonFormat: … type: Literal\["json"] Link to this property
compression: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatCloudflarePipelinesSinkParquetFormat: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["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: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["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
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] 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)>)
class SinkGetResponse: … id: str Indicates a unique identifier for this sink. Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property name: str Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: Literal\["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: Optional\[Config] Defines the configuration of the R2 Sink. One of the following:
class ConfigCloudflarePipelinesR2TablePublic: … R2 Sink public configuration. account\_id: str Cloudflare Account ID for the bucket Link to this property bucket: str R2 Bucket to write to Link to this property
file\_naming: Optional\[ConfigCloudflarePipelinesR2TablePublicFileNaming] Controls filename prefix/suffix and strategy. prefix: Optional\[str] The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy: Optional\[Literal\["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: Optional\[str] This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction: Optional\[str] Jurisdiction this bucket is hosted in Link to this property
partitioning: Optional\[ConfigCloudflarePipelinesR2TablePublicPartitioning] Data-layout partitioning for sinks. time\_pattern: Optional\[str] The pattern of the date string Link to this property
Link to this property path: Optional\[str] Subpath within the bucket to write to Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2TablePublicRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] 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
class ConfigCloudflarePipelinesR2DataCatalogTablePublic: … R2 Data Catalog Sink public configuration. account\_id: str Cloudflare Account ID formaturi Link to this property bucket: str The R2 Bucket that hosts this catalog Link to this property table\_name: str Table name Link to this property namespace: Optional\[str] Table namespace Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] 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: Optional\[Format] Defines the output data format of a sink. One of the following:
class FormatCloudflarePipelinesSinkJsonFormat: … type: Literal\["json"] Link to this property
compression: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatCloudflarePipelinesSinkParquetFormat: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["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: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["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
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] 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)>)
class SinkCreateResponse: … id: str Indicates a unique identifier for this sink. Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property name: str Defines the name of the Sink. maxLength128 minLength1 Link to this property
type: Literal\["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: Optional\[Config] R2 Data Catalog Sink One of the following:
class ConfigCloudflarePipelinesR2Table: … account\_id: str Cloudflare Account ID for the bucket Link to this property bucket: str R2 Bucket to write to Link to this property
credentials: ConfigCloudflarePipelinesR2TableCredentials access\_key\_id: str Cloudflare Account ID for the bucket formatvar-str Link to this property secret\_access\_key: str Cloudflare Account ID for the bucket formatvar-str Link to this property
Link to this property
file\_naming: Optional\[ConfigCloudflarePipelinesR2TableFileNaming] Controls filename prefix/suffix and strategy. prefix: Optional\[str] The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy: Optional\[Literal\["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: Optional\[str] This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction: Optional\[str] Jurisdiction this bucket is hosted in Link to this property
partitioning: Optional\[ConfigCloudflarePipelinesR2TablePartitioning] Data-layout partitioning for sinks. time\_pattern: Optional\[str] The pattern of the date string Link to this property
Link to this property path: Optional\[str] Subpath within the bucket to write to Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2TableRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] 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
class ConfigCloudflarePipelinesR2DataCatalogTable: … R2 Data Catalog Sink token: str Authentication token formatvar-str Link to this property account\_id: str Cloudflare Account ID formaturi Link to this property bucket: str The R2 Bucket that hosts this catalog Link to this property table\_name: str Table name Link to this property namespace: Optional\[str] Table namespace Link to this property
rolling\_policy: Optional\[ConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy] Rolling policy for file sinks (when & why to close a file and open a new one). file\_size\_bytes: Optional\[int] Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: Optional\[int] Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: Optional\[int] 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: Optional\[Format] Defines the output data format of a sink. One of the following:
class FormatCloudflarePipelinesSinkJsonFormat: … type: Literal\["json"] Link to this property
compression: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[Literal\["rfc3339", "unix\_millis"]] One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured: Optional\[bool] Link to this property
Link to this property
class FormatCloudflarePipelinesSinkParquetFormat: … type: Literal\["parquet"] Link to this property
compression: Optional\[Literal\["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: Optional\[int] formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema: Optional\[Schema] Defines the schema of the events in the data stream.
fields: Optional\[List\[SourceField]] One of the following:
class Int32: … type: Literal\["int32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Int64: … type: Literal\["int64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float32: … type: Literal\["float32"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Float64: … type: Literal\["float64"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Bool: … type: Literal\["bool"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class String: … type: Literal\["string"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Binary: … type: Literal\["binary"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Timestamp: … type: Literal\["timestamp"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
unit: Optional\[Literal\["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
class Json: … type: Literal\["json"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class Struct: … type: Literal\["struct"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
class List: … type: Literal\["list"] Link to this property metadata\_key: Optional\[str] Link to this property name: Optional\[str] Link to this property required: Optional\[bool] Link to this property sql\_name: Optional\[str] Link to this property
Link to this property
Link to this property inferred: Optional\[bool] 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)>)