--- title: Create Sink --- [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** # Create Sink client.Pipelines.Sinks.New(ctx, params) (\*[SinkNewResponse](), error) POST/accounts/{account\_id}/pipelines/v1/sinks Create a new Sink. ##### 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` ##### ParametersExpand Collapse

params SinkNewParams

AccountID param.Field\[string] Path param: Specifies the public ID of the account. Link to this property Name param.Field\[string] Body param: Defines the name of the Sink. maxLength128 minLength1 Link to this property

Type param.Field\[SinkNewParamsType] Body param: Specifies the type of sink.

const SinkNewParamsTypeR2 SinkNewParamsType = "r2" Link to this property const SinkNewParamsTypeR2DataCatalog SinkNewParamsType = "r2\_data\_catalog" Link to this property const SinkNewParamsTypeBasinCatalog SinkNewParamsType = "basin\_catalog" Link to this property

Link to this property

Config param.Field\[SinkNewParamsConfig]Optional Body param: Defines the configuration of the R2 Sink.

type SinkNewParamsConfigCloudflarePipelinesR2Table struct{…}

AccountID string Cloudflare Account ID for the bucket Link to this property Bucket string R2 Bucket to write to Link to this property

Credentials SinkNewParamsConfigCloudflarePipelinesR2TableCredentials

AccessKeyID string Cloudflare Account ID for the bucket formatvar-str Link to this property SecretAccessKey string Cloudflare Account ID for the bucket formatvar-str Link to this property

Link to this property

FileNaming SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingOptional Controls filename prefix/suffix and strategy.

Prefix stringOptional The prefix to use in file name. i.e prefix-.parquet Link to this property

Strategy SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyOptional Filename generation strategy.

One of the following: const SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategySerial SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "serial" Link to this property const SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUUID SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid" Link to this property const SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUUIDV7 SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid\_v7" Link to this property const SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUlid SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "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 SinkNewParamsConfigCloudflarePipelinesR2TablePartitioningOptional 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 SinkNewParamsConfigCloudflarePipelinesR2TableRollingPolicyOptional 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

type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable struct{…} R2 Data Catalog Sink

Token string Authentication token formatvar-str Link to this property 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 SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTableRollingPolicyOptional Rolling policy for file sinks (when & why to close a file and open a new one).

Link to this property

Format param.Field\[SinkNewParamsFormat]Optional Body param: Defines the output data format of a sink.

type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormat struct{…}

Type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatType Link to this property

Compression SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompressionOptional Specifies the compression applied to JSON sink output.

One of the following: const SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompressionUncompressed SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression = "uncompressed" Link to this property const SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompressionGzip SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression = "gzip" Link to this property

Link to this property

DecimalEncoding SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingOptional

One of the following: const SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingNumber SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "number" Link to this property const SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingString SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "string" Link to this property const SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingBytes SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "bytes" Link to this property

Link to this property

TimestampFormat SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormatOptional

One of the following: const SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormatRfc3339 SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "rfc3339" Link to this property const SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormatUnixMillis SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "unix\_millis" Link to this property

Link to this property Unstructured boolOptional Link to this property

Link to this property

type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormat struct{…}

Type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatType Link to this property

Compression SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionOptional

One of the following: const SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionUncompressed SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "uncompressed" Link to this property const SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionSnappy SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "snappy" Link to this property const SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionGzip SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "gzip" Link to this property const SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionZstd SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "zstd" Link to this property const SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionLz4 SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "lz4" Link to this property

Link to this property RowGroupBytes int64Optional formatint64 minimum0 Link to this property

Link to this property

Schema param.Field\[SinkNewParamsSchema]Optional Body param: 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

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(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type SinkNewResponse 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 SinkNewResponseType Specifies the type of sink.

One of the following: const SinkNewResponseTypeR2 SinkNewResponseType = "r2" Link to this property const SinkNewResponseTypeR2DataCatalog SinkNewResponseType = "r2\_data\_catalog" Link to this property const SinkNewResponseTypeBasinCatalog SinkNewResponseType = "basin\_catalog" Link to this property

Link to this property

Config SinkNewResponseConfigOptional R2 Data Catalog Sink

One of the following:

type SinkNewResponseConfigCloudflarePipelinesR2Table struct{…}

AccountID string Cloudflare Account ID for the bucket Link to this property Bucket string R2 Bucket to write to Link to this property

Credentials SinkNewResponseConfigCloudflarePipelinesR2TableCredentials

AccessKeyID string Cloudflare Account ID for the bucket formatvar-str Link to this property SecretAccessKey string Cloudflare Account ID for the bucket formatvar-str Link to this property

Link to this property

FileNaming SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingOptional Controls filename prefix/suffix and strategy.

Prefix stringOptional The prefix to use in file name. i.e prefix-.parquet Link to this property

Strategy SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyOptional Filename generation strategy.

One of the following: const SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategySerial SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "serial" Link to this property const SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUID SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid" Link to this property const SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUIDV7 SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid\_v7" Link to this property const SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUlid SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "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 SinkNewResponseConfigCloudflarePipelinesR2TablePartitioningOptional 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 SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicyOptional Rolling policy for file sinks (when & why to close a file and open a new one).

Link to this property

type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable struct{…} R2 Data Catalog Sink

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

Link to this property

Format SinkNewResponseFormatOptional Defines the output data format of a sink.

One of the following:

type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormat struct{…}

Type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatType Link to this property

Compression SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompressionOptional Specifies the compression applied to JSON sink output.

One of the following: const SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompressionUncompressed SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "uncompressed" Link to this property const SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompressionGzip SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "gzip" Link to this property

Link to this property

DecimalEncoding SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingOptional

One of the following: const SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingNumber SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "number" Link to this property const SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingString SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "string" Link to this property const SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingBytes SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "bytes" Link to this property

Link to this property

TimestampFormat SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatOptional

One of the following: const SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatRfc3339 SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "rfc3339" Link to this property const SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatUnixMillis SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "unix\_millis" Link to this property

Link to this property Unstructured boolOptional Link to this property

Link to this property

type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormat struct{…}

Type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatType Link to this property

Compression SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionOptional

One of the following: const SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionUncompressed SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "uncompressed" Link to this property const SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionSnappy SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "snappy" Link to this property const SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionGzip SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "gzip" Link to this property const SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionZstd SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "zstd" Link to this property const SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionLz4 SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "lz4" Link to this property

Link to this property RowGroupBytes int64Optional formatint64 minimum0 Link to this property

Link to this property

Schema SinkNewResponseSchemaOptional Defines the schema of the events in the data stream.

Fields \[]SourceFieldOptional

One of the following:

type SourceFieldInt32 struct{…}

Link to this property

type SourceFieldInt64 struct{…}

Link to this property

type SourceFieldFloat32 struct{…}

Link to this property

type SourceFieldFloat64 struct{…}

Link to this property

type SourceFieldBool struct{…}

Link to this property

type SourceFieldString struct{…}

Link to this property

type SourceFieldBinary struct{…}

Link to this property

type SourceFieldTimestamp struct{…}

Unit SourceFieldTimestampUnitOptional

Link to this property

type SourceFieldJson struct{…}

Link to this property

type SourceFieldStruct struct{…}

Link to this property

type SourceFieldList struct{…}

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)%20SinkNewResponse%20%3E%20(schema)>) ### Create Sink 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.New(context.TODO(), pipelines.SinkNewParams{ AccountID: cloudflare.F("0123105f4ecef8ad9ca31a8372d0c353"), Name: cloudflare.F("my_sink"), Type: cloudflare.F(pipelines.SinkNewParamsTypeR2), }) 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", "credentials": { "access_key_id": "access_key_id", "secret_access_key": "secret_access_key" }, "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", "credentials": { "access_key_id": "access_key_id", "secret_access_key": "secret_access_key" }, "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 } ```