--- title: List Sinks --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Pipelines](https://developers.cloudflare.com/api/resources/pipelines) [Sinks](https://developers.cloudflare.com/api/resources/pipelines/subresources/sinks) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Sinks GET/accounts/{account\_id}/pipelines/v1/sinks List/Filter Sinks in Account. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `Pipelines Write``Pipelines Read` ##### P ath ParametersExpand Collapse account\_id: string Specifies the public ID of the account. [Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### Q uery ParametersExpand Collapse name: optional string Filters sinks by name (case-insensitive substring). maxLength128 minLength1 [Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>) page: optional number [Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: optional number [Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) pipeline\_id: optional string [Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20pipeline_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse

result: array of object {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"or "r2\_data\_catalog"or "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 object {account\_id, bucket, file\_naming, 4 more } or object {account\_id, bucket, table\_name, 2 more } Defines the configuration of the R2 Sink.

One of the following:

CloudflarePipelinesR2TablePublic object {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: optional object {prefix, strategy, suffix } Controls filename prefix/suffix and strategy.

prefix: optional string The prefix to use in file name. i.e prefix-.parquet Link to this property

strategy: optional "serial"or "uuid"or "uuid\_v7"or "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 string This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property

Link to this property jurisdiction: optional string Jurisdiction this bucket is hosted in Link to this property

partitioning: optional object {time\_pattern } Data-layout partitioning for sinks.

time\_pattern: optional string The pattern of the date string Link to this property

Link to this property path: optional string Subpath within the bucket to write to Link to this property

rolling\_policy: optional object {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: optional number Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds: optional number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds: optional number Number of seconds to wait before rolling over to a new file formatuint64 minimum1 Link to this property

Link to this property

CloudflarePipelinesR2DataCatalogTablePublic object {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: optional string Table namespace Link to this property

rolling\_policy: optional object {file\_size\_bytes, inactivity\_seconds, interval\_seconds } Rolling policy for file sinks (when & why to close a file and open a new one).

Link to this property

format: optional object {type, compression, decimal\_encoding, 2 more } or object {type, compression, row\_group\_bytes } Defines the output data format of a sink.

One of the following:

Json object {type, compression, decimal\_encoding, 2 more }

type: "json" Link to this property

compression: optional "uncompressed"or "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 "number"or "string"or "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 "rfc3339"or "unix\_millis"

One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property

Link to this property unstructured: optional boolean Link to this property

Link to this property

Parquet object {type, compression, row\_group\_bytes }

type: "parquet" Link to this property

compression: optional "uncompressed"or "snappy"or "gzip"or 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 number formatint64 minimum0 Link to this property

Link to this property

schema: optional object {fields, inferred } Defines the schema of the events in the data stream.

fields: optional array of SourceField

One of the following:

Int32 object {type, metadata\_key, name, 2 more }

type: "int32" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

Int64 object {type, metadata\_key, name, 2 more }

type: "int64" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

Float32 object {type, metadata\_key, name, 2 more }

type: "float32" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

Float64 object {type, metadata\_key, name, 2 more }

type: "float64" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

Bool object {type, metadata\_key, name, 2 more }

type: "bool" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

String object {type, metadata\_key, name, 2 more }

type: "string" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

Binary object {type, metadata\_key, name, 2 more }

type: "binary" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

Timestamp object {type, metadata\_key, name, 3 more }

type: "timestamp" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

unit: optional "second"or "millisecond"or "microsecond"or "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

Json object {type, metadata\_key, name, 2 more }

type: "json" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

Struct = StructField { fields, name }

type: "struct" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

List = ListField { items }

type: "list" Link to this property metadata\_key: optional string Link to this property name: optional string Link to this property required: optional boolean Link to this property sql\_name: optional string Link to this property

Link to this property

Link to this property inferred: optional boolean Link to this property

Link to this property

[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)

result\_info: object {count, page, per\_page, total\_count }

count: number Indicates the number of items on current page. Link to this property page: number Indicates the current page number. Link to this property per\_page: number Indicates the number of items per page. Link to this property total\_count: number Indicates the total number of items. Link to this property

[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>) success: boolean Indicates whether the API call was successful. [Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>) ### List Sinks HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pipelines/v1/sinks \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 200 example ``` { "result": [ { "id": "01234567890123457689012345678901", "created_at": "2019-12-27T18:11:19.117Z", "modified_at": "2019-12-27T18:11:19.117Z", "name": "my_sink", "type": "r2", "config": { "account_id": "account_id", "bucket": "bucket", "file_naming": { "prefix": "prefix", "strategy": "serial", "suffix": "suffix" }, "jurisdiction": "jurisdiction", "partitioning": { "time_pattern": "year=%Y/month=%m/day=%d/hour=%H" }, "path": "path", "rolling_policy": { "file_size_bytes": 0, "inactivity_seconds": 1, "interval_seconds": 1 } }, "format": { "type": "json", "compression": "uncompressed", "decimal_encoding": "number", "timestamp_format": "rfc3339", "unstructured": true }, "schema": { "fields": [ { "type": "int32", "metadata_key": "metadata_key", "name": "name", "required": true, "sql_name": "sql_name" } ], "inferred": true } } ], "result_info": { "count": 1, "page": 0, "per_page": 10, "total_count": 1 }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": [ { "id": "01234567890123457689012345678901", "created_at": "2019-12-27T18:11:19.117Z", "modified_at": "2019-12-27T18:11:19.117Z", "name": "my_sink", "type": "r2", "config": { "account_id": "account_id", "bucket": "bucket", "file_naming": { "prefix": "prefix", "strategy": "serial", "suffix": "suffix" }, "jurisdiction": "jurisdiction", "partitioning": { "time_pattern": "year=%Y/month=%m/day=%d/hour=%H" }, "path": "path", "rolling_policy": { "file_size_bytes": 0, "inactivity_seconds": 1, "interval_seconds": 1 } }, "format": { "type": "json", "compression": "uncompressed", "decimal_encoding": "number", "timestamp_format": "rfc3339", "unstructured": true }, "schema": { "fields": [ { "type": "int32", "metadata_key": "metadata_key", "name": "name", "required": true, "sql_name": "sql_name" } ], "inferred": true } } ], "result_info": { "count": 1, "page": 0, "per_page": 10, "total_count": 1 }, "success": true } ```