--- title: Get Sink Details --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Pipelines](https://developers.cloudflare.com/api/go/resources/pipelines) [Sinks](https://developers.cloudflare.com/api/go/resources/pipelines/subresources/sinks) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get Sink Details client.Pipelines.Sinks.Get(ctx, sinkID, query) (\*[SinkGetResponse](), error) GET/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id} Get Sink Details. ##### 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` ##### ParametersExpand Collapse sinkID string Specifies the publid ID of the sink. maxLength32 minLength32 [Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20sink_id%20%3E%20(schema)>)
query SinkGetParams AccountID param.Field\[string] Specifies the public ID of the account. Link to this property
[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type SinkGetResponse struct{…} ID string Indicates a unique identifier for this sink. Link to this property CreatedAt Time formatdate-time Link to this property ModifiedAt Time formatdate-time Link to this property Name string Defines the name of the Sink. maxLength128 minLength1 Link to this property
Type SinkGetResponseType Specifies the type of sink. One of the following: const SinkGetResponseTypeR2 SinkGetResponseType = "r2" Link to this property const SinkGetResponseTypeR2DataCatalog SinkGetResponseType = "r2\_data\_catalog" Link to this property const SinkGetResponseTypeBasinCatalog SinkGetResponseType = "basin\_catalog" Link to this property
Link to this property
Config SinkGetResponseConfigOptional Defines the configuration of the R2 Sink. One of the following:
type SinkGetResponseConfigCloudflarePipelinesR2TablePublic struct{…} R2 Sink public configuration. AccountID string Cloudflare Account ID for the bucket Link to this property Bucket string R2 Bucket to write to Link to this property
FileNaming SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingOptional Controls filename prefix/suffix and strategy. Prefix stringOptional The prefix to use in file name. i.e prefix-.parquet Link to this property
Strategy SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyOptional Filename generation strategy. One of the following: const SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategySerial SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "serial" Link to this property const SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUUID SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "uuid" Link to this property const SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUUIDV7 SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "uuid\_v7" Link to this property const SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUlid SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "ulid" Link to this property
Link to this property Suffix stringOptional This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property Jurisdiction stringOptional Jurisdiction this bucket is hosted in Link to this property
Partitioning SinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioningOptional Data-layout partitioning for sinks. TimePattern stringOptional The pattern of the date string Link to this property
Link to this property Path stringOptional Subpath within the bucket to write to Link to this property
RollingPolicy SinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicyOptional Rolling policy for file sinks (when & why to close a file and open a new one). FileSizeBytes int64Optional Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property InactivitySeconds int64Optional Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property IntervalSeconds int64Optional 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
type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublic struct{…} R2 Data Catalog Sink public configuration. AccountID string Cloudflare Account ID formaturi Link to this property Bucket string The R2 Bucket that hosts this catalog Link to this property TableName string Table name Link to this property Namespace stringOptional Table namespace Link to this property
RollingPolicy SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicyOptional Rolling policy for file sinks (when & why to close a file and open a new one). FileSizeBytes int64Optional Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property InactivitySeconds int64Optional Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property IntervalSeconds int64Optional 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 SinkGetResponseFormatOptional Defines the output data format of a sink. One of the following:
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormat struct{…} Type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatType Link to this property
Compression SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompressionOptional Specifies the compression applied to JSON sink output. One of the following: const SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompressionUncompressed SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "uncompressed" Link to this property const SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompressionGzip SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "gzip" Link to this property
Link to this property
DecimalEncoding SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingOptional One of the following: const SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingNumber SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "number" Link to this property const SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingString SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "string" Link to this property const SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingBytes SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "bytes" Link to this property
Link to this property
TimestampFormat SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatOptional One of the following: const SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatRfc3339 SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "rfc3339" Link to this property const SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatUnixMillis SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "unix\_millis" Link to this property
Link to this property Unstructured boolOptional Link to this property
Link to this property
type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormat struct{…} Type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatType Link to this property
Compression SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionOptional One of the following: const SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionUncompressed SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "uncompressed" Link to this property const SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionSnappy SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "snappy" Link to this property const SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionGzip SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "gzip" Link to this property const SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionZstd SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "zstd" Link to this property const SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionLz4 SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "lz4" Link to this property
Link to this property RowGroupBytes int64Optional formatint64 minimum0 Link to this property
Link to this property
Link to this property
Schema SinkGetResponseSchemaOptional Defines the schema of the events in the data stream.
Fields \[]SourceFieldOptional One of the following:
type SourceFieldInt32 struct{…} Type SourceFieldInt32Type Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldInt64 struct{…} Type SourceFieldInt64Type Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldFloat32 struct{…} Type SourceFieldFloat32Type Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldFloat64 struct{…} Type SourceFieldFloat64Type Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldBool struct{…} Type SourceFieldBoolType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldString struct{…} Type SourceFieldStringType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldBinary struct{…} Type SourceFieldBinaryType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldTimestamp struct{…} Type SourceFieldTimestampType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Unit SourceFieldTimestampUnitOptional One of the following: const SourceFieldTimestampUnitSecond SourceFieldTimestampUnit = "second" Link to this property const SourceFieldTimestampUnitMillisecond SourceFieldTimestampUnit = "millisecond" Link to this property const SourceFieldTimestampUnitMicrosecond SourceFieldTimestampUnit = "microsecond" Link to this property const SourceFieldTimestampUnitNanosecond SourceFieldTimestampUnit = "nanosecond" Link to this property
Link to this property
Link to this property
type SourceFieldJson struct{…} Type SourceFieldJsonType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldStruct struct{…} Type SourceFieldStructType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
type SourceFieldList struct{…} Type SourceFieldListType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property
Link to this property
Link to this property Inferred boolOptional Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines.sinks%20%3E%20(model)%20SinkGetResponse%20%3E%20(schema)>) ### Get Sink Details Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/pipelines" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) sink, err := client.Pipelines.Sinks.Get( context.TODO(), "0223105f4ecef8ad9ca31a8372d0c353", pipelines.SinkGetParams{ AccountID: cloudflare.F("0123105f4ecef8ad9ca31a8372d0c353"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", sink.ID) } ``` 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 } }, "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 } }, "success": true } ```