---
title: Pipelines
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Pipelines
##### [\[DEPRECATED\] List Pipelines](https://developers.cloudflare.com/api/resources/pipelines/methods/list)
Deprecated
GET/accounts/{account\_id}/pipelines
##### [\[DEPRECATED\] Get Pipeline](https://developers.cloudflare.com/api/resources/pipelines/methods/get)
Deprecated
GET/accounts/{account\_id}/pipelines/{pipeline\_name}
##### [\[DEPRECATED\] Create Pipeline](https://developers.cloudflare.com/api/resources/pipelines/methods/create)
Deprecated
POST/accounts/{account\_id}/pipelines
##### [\[DEPRECATED\] Update Pipeline](https://developers.cloudflare.com/api/resources/pipelines/methods/update)
Deprecated
PUT/accounts/{account\_id}/pipelines/{pipeline\_name}
##### [\[DEPRECATED\] Delete Pipeline](https://developers.cloudflare.com/api/resources/pipelines/methods/delete)
Deprecated
DELETE/accounts/{account\_id}/pipelines/{pipeline\_name}
##### [List Pipelines](https://developers.cloudflare.com/api/resources/pipelines/methods/list_v1)
GET/accounts/{account\_id}/pipelines/v1/pipelines
##### [Get Pipeline Details](https://developers.cloudflare.com/api/resources/pipelines/methods/get_v1)
GET/accounts/{account\_id}/pipelines/v1/pipelines/{pipeline\_id}
##### [Create Pipeline](https://developers.cloudflare.com/api/resources/pipelines/methods/create_v1)
POST/accounts/{account\_id}/pipelines/v1/pipelines
##### [Delete Pipeline](https://developers.cloudflare.com/api/resources/pipelines/methods/delete_v1)
DELETE/accounts/{account\_id}/pipelines/v1/pipelines/{pipeline\_id}
##### [Validate SQL](https://developers.cloudflare.com/api/resources/pipelines/methods/validate_sql)
POST/accounts/{account\_id}/pipelines/v1/validate\_sql
##### ModelsExpand Collapse
FieldType = object {type } or object {type } or object {type } or 8 more
One of the following:
Int32 object {type }
type: "int32"
Link to this property
Link to this property
Int64 object {type }
type: "int64"
Link to this property
Link to this property
Float32 object {type }
type: "float32"
Link to this property
Link to this property
Float64 object {type }
type: "float64"
Link to this property
Link to this property
Bool object {type }
type: "bool"
Link to this property
Link to this property
String object {type }
type: "string"
Link to this property
Link to this property
Binary object {type }
type: "binary"
Link to this property
Link to this property
Timestamp object {type, unit }
type: "timestamp"
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
Link to this property
Json object {type }
type: "json"
Link to this property
Link to this property
Struct object {fields, type, name }
fields: 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
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
type: "struct"
Link to this property
name: optional string
Link to this property
Link to this property
List object {items, type }
items: SourceField
Link to this property
type: "list"
Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20field_type%20%3E%20(schema)>)
ListField object {items }
items: SourceField
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20list_field%20%3E%20(schema)>)
SourceField = object {type, metadata\_key, name, 2 more } or object {type, metadata\_key, name, 2 more } or object {type, metadata\_key, name, 2 more } or 8 more
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
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](<#(resource)%20pipelines%20%3E%20(model)%20source_field%20%3E%20(schema)>)
StructField object {fields, name }
fields: array of SourceField
Link to this property
name: optional string
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20struct_field%20%3E%20(schema)>)
PipelineListResponse object {result\_info, results, success }
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
results: array of object {id, destination, endpoint, 3 more }
id: string
Specifies the pipeline identifier.
Link to this property
destination: object {batch, compression, format, 2 more }
batch: object {max\_bytes, max\_duration\_s, max\_rows }
max\_bytes: number
Specifies rough maximum size of files.
maximum100000000
minimum1000
Link to this property
max\_duration\_s: number
Specifies duration to wait to aggregate batches files.
maximum300
minimum0.25
Link to this property
max\_rows: number
Specifies rough maximum number of rows per file.
maximum10000000
minimum100
Link to this property
Link to this property
compression: object {type }
type: "none"or "gzip"or "deflate"
Specifies the desired compression algorithm and format.
One of the following:
"none"
Link to this property
"gzip"
Link to this property
"deflate"
Link to this property
Link to this property
Link to this property
format: "json"
Specifies the format of data to deliver.
Link to this property
path: object {bucket, filename, filepath, prefix }
bucket: string
Specifies the R2 Bucket to store files.
Link to this property
filename: optional string
Specifies the name pattern to for individual data files.
Link to this property
filepath: optional string
Specifies the name pattern for directory.
Link to this property
prefix: optional string
Specifies the base directory within the bucket.
Link to this property
Link to this property
type: "r2"
Specifies the type of destination.
Link to this property
Link to this property
endpoint: string
Indicates the endpoint URL to send traffic.
Link to this property
name: string
Defines the name of the pipeline.
maxLength128
minLength1
Link to this property
source: array of object {format, type, authentication, cors } or object {format, type }
One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource object {format, type, authentication, cors }
\[DEPRECATED] HTTP source configuration. Use the new streams API instead.
format: "json"
Specifies the format of source data.
Link to this property
type: string
Link to this property
authentication: optional boolean
Specifies whether authentication is required to send to this pipeline via HTTP.
Link to this property
cors: optional object {origins }
origins: optional array of string
Specifies allowed origins to allow Cross Origin HTTP Requests.
Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource object {format, type }
\[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
format: "json"
Specifies the format of source data.
Link to this property
type: string
Link to this property
Link to this property
Link to this property
version: number
Indicates the version number of last saved configuration.
Link to this property
Link to this property
success: boolean
Indicates whether the API call was successful.
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_list_response%20%3E%20(schema)>)
PipelineGetResponse object {id, destination, endpoint, 3 more }
\[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
id: string
Specifies the pipeline identifier.
Link to this property
destination: object {batch, compression, format, 2 more }
batch: object {max\_bytes, max\_duration\_s, max\_rows }
max\_bytes: number
Specifies rough maximum size of files.
maximum100000000
minimum1000
Link to this property
max\_duration\_s: number
Specifies duration to wait to aggregate batches files.
maximum300
minimum0.25
Link to this property
max\_rows: number
Specifies rough maximum number of rows per file.
maximum10000000
minimum100
Link to this property
Link to this property
compression: object {type }
type: "none"or "gzip"or "deflate"
Specifies the desired compression algorithm and format.
One of the following:
"none"
Link to this property
"gzip"
Link to this property
"deflate"
Link to this property
Link to this property
Link to this property
format: "json"
Specifies the format of data to deliver.
Link to this property
path: object {bucket, filename, filepath, prefix }
bucket: string
Specifies the R2 Bucket to store files.
Link to this property
filename: optional string
Specifies the name pattern to for individual data files.
Link to this property
filepath: optional string
Specifies the name pattern for directory.
Link to this property
prefix: optional string
Specifies the base directory within the bucket.
Link to this property
Link to this property
type: "r2"
Specifies the type of destination.
Link to this property
Link to this property
endpoint: string
Indicates the endpoint URL to send traffic.
Link to this property
name: string
Defines the name of the pipeline.
maxLength128
minLength1
Link to this property
source: array of object {format, type, authentication, cors } or object {format, type }
One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource object {format, type, authentication, cors }
\[DEPRECATED] HTTP source configuration. Use the new streams API instead.
format: "json"
Specifies the format of source data.
Link to this property
type: string
Link to this property
authentication: optional boolean
Specifies whether authentication is required to send to this pipeline via HTTP.
Link to this property
cors: optional object {origins }
origins: optional array of string
Specifies allowed origins to allow Cross Origin HTTP Requests.
Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource object {format, type }
\[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
format: "json"
Specifies the format of source data.
Link to this property
type: string
Link to this property
Link to this property
Link to this property
version: number
Indicates the version number of last saved configuration.
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_get_response%20%3E%20(schema)>)
PipelineCreateResponse object {id, destination, endpoint, 3 more }
\[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
id: string
Specifies the pipeline identifier.
Link to this property
destination: object {batch, compression, format, 2 more }
batch: object {max\_bytes, max\_duration\_s, max\_rows }
max\_bytes: number
Specifies rough maximum size of files.
maximum100000000
minimum1000
Link to this property
max\_duration\_s: number
Specifies duration to wait to aggregate batches files.
maximum300
minimum0.25
Link to this property
max\_rows: number
Specifies rough maximum number of rows per file.
maximum10000000
minimum100
Link to this property
Link to this property
compression: object {type }
type: "none"or "gzip"or "deflate"
Specifies the desired compression algorithm and format.
One of the following:
"none"
Link to this property
"gzip"
Link to this property
"deflate"
Link to this property
Link to this property
Link to this property
format: "json"
Specifies the format of data to deliver.
Link to this property
path: object {bucket, filename, filepath, prefix }
bucket: string
Specifies the R2 Bucket to store files.
Link to this property
filename: optional string
Specifies the name pattern to for individual data files.
Link to this property
filepath: optional string
Specifies the name pattern for directory.
Link to this property
prefix: optional string
Specifies the base directory within the bucket.
Link to this property
Link to this property
type: "r2"
Specifies the type of destination.
Link to this property
Link to this property
endpoint: string
Indicates the endpoint URL to send traffic.
Link to this property
name: string
Defines the name of the pipeline.
maxLength128
minLength1
Link to this property
source: array of object {format, type, authentication, cors } or object {format, type }
One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource object {format, type, authentication, cors }
\[DEPRECATED] HTTP source configuration. Use the new streams API instead.
format: "json"
Specifies the format of source data.
Link to this property
type: string
Link to this property
authentication: optional boolean
Specifies whether authentication is required to send to this pipeline via HTTP.
Link to this property
cors: optional object {origins }
origins: optional array of string
Specifies allowed origins to allow Cross Origin HTTP Requests.
Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource object {format, type }
\[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
format: "json"
Specifies the format of source data.
Link to this property
type: string
Link to this property
Link to this property
Link to this property
version: number
Indicates the version number of last saved configuration.
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_create_response%20%3E%20(schema)>)
PipelineUpdateResponse object {id, destination, endpoint, 3 more }
\[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
id: string
Specifies the pipeline identifier.
Link to this property
destination: object {batch, compression, format, 2 more }
batch: object {max\_bytes, max\_duration\_s, max\_rows }
max\_bytes: number
Specifies rough maximum size of files.
maximum100000000
minimum1000
Link to this property
max\_duration\_s: number
Specifies duration to wait to aggregate batches files.
maximum300
minimum0.25
Link to this property
max\_rows: number
Specifies rough maximum number of rows per file.
maximum10000000
minimum100
Link to this property
Link to this property
compression: object {type }
type: "none"or "gzip"or "deflate"
Specifies the desired compression algorithm and format.
One of the following:
"none"
Link to this property
"gzip"
Link to this property
"deflate"
Link to this property
Link to this property
Link to this property
format: "json"
Specifies the format of data to deliver.
Link to this property
path: object {bucket, filename, filepath, prefix }
bucket: string
Specifies the R2 Bucket to store files.
Link to this property
filename: optional string
Specifies the name pattern to for individual data files.
Link to this property
filepath: optional string
Specifies the name pattern for directory.
Link to this property
prefix: optional string
Specifies the base directory within the bucket.
Link to this property
Link to this property
type: "r2"
Specifies the type of destination.
Link to this property
Link to this property
endpoint: string
Indicates the endpoint URL to send traffic.
Link to this property
name: string
Defines the name of the pipeline.
maxLength128
minLength1
Link to this property
source: array of object {format, type, authentication, cors } or object {format, type }
One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource object {format, type, authentication, cors }
\[DEPRECATED] HTTP source configuration. Use the new streams API instead.
format: "json"
Specifies the format of source data.
Link to this property
type: string
Link to this property
authentication: optional boolean
Specifies whether authentication is required to send to this pipeline via HTTP.
Link to this property
cors: optional object {origins }
origins: optional array of string
Specifies allowed origins to allow Cross Origin HTTP Requests.
Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource object {format, type }
\[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
format: "json"
Specifies the format of source data.
Link to this property
type: string
Link to this property
Link to this property
Link to this property
version: number
Indicates the version number of last saved configuration.
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_update_response%20%3E%20(schema)>)
PipelineListV1Response object {id, created\_at, modified\_at, 3 more }
id: string
Indicates a unique identifier for this pipeline.
Link to this property
created\_at: string
Link to this property
modified\_at: string
Link to this property
name: string
Indicates the name of the Pipeline.
maxLength128
minLength1
Link to this property
sql: string
Specifies SQL for the Pipeline processing flow.
Link to this property
status: string
Indicates the current status of the Pipeline.
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_list_v1_response%20%3E%20(schema)>)
PipelineGetV1Response object {id, created\_at, modified\_at, 5 more }
id: string
Indicates a unique identifier for this pipeline.
Link to this property
created\_at: string
Link to this property
modified\_at: string
Link to this property
name: string
Indicates the name of the Pipeline.
maxLength128
minLength1
Link to this property
sql: string
Specifies SQL for the Pipeline processing flow.
Link to this property
status: string
Indicates the current status of the Pipeline.
Link to this property
tables: array of object {id, latest, name, 2 more }
List of streams and sinks used by this pipeline.
id: string
Unique identifier for the connection (stream or sink).
Link to this property
latest: number
Latest available version of the connection.
Link to this property
name: string
Name of the connection.
maxLength128
minLength1
Link to this property
type: "stream"or "sink"
Type of the connection.
One of the following:
"stream"
Link to this property
"sink"
Link to this property
Link to this property
version: number
Current version of the connection used by this pipeline.
Link to this property
Link to this property
failure\_reason: optional string
Indicates the reason for the failure of the Pipeline.
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_get_v1_response%20%3E%20(schema)>)
PipelineCreateV1Response object {id, created\_at, modified\_at, 3 more }
id: string
Indicates a unique identifier for this pipeline.
Link to this property
created\_at: string
Link to this property
modified\_at: string
Link to this property
name: string
Indicates the name of the Pipeline.
maxLength128
minLength1
Link to this property
sql: string
Specifies SQL for the Pipeline processing flow.
Link to this property
status: string
Indicates the current status of the Pipeline.
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_create_v1_response%20%3E%20(schema)>)
PipelineDeleteV1Response = unknown
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_delete_v1_response%20%3E%20(schema)>)
PipelineValidateSqlResponse object {tables, graph }
tables: map\[object {id, name, type, version } ]
Indicates tables involved in the processing.
id: string
Link to this property
name: string
Link to this property
type: string
Link to this property
version: number
Link to this property
Link to this property
graph: optional object {edges, nodes }
Indicates the processing flow to implement the SQL.
edges: array of object {dest\_id, edge\_type, key\_type, 2 more }
dest\_id: number
formatint32
minimum0
Link to this property
edge\_type: string
Link to this property
key\_type: string
Link to this property
src\_id: number
formatint32
minimum0
Link to this property
value\_type: string
Link to this property
Link to this property
nodes: array of object {description, node\_id, operator, parallelism }
description: string
Link to this property
node\_id: number
formatint32
minimum0
Link to this property
operator: string
Link to this property
parallelism: number
formatint32
minimum0
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20pipeline_validate_sql_response%20%3E%20(schema)>)
#### PipelinesSinks
##### [List Sinks](https://developers.cloudflare.com/api/resources/pipelines/subresources/sinks/methods/list)
GET/accounts/{account\_id}/pipelines/v1/sinks
##### [Get Sink Details](https://developers.cloudflare.com/api/resources/pipelines/subresources/sinks/methods/get)
GET/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id}
##### [Create Sink](https://developers.cloudflare.com/api/resources/pipelines/subresources/sinks/methods/create)
POST/accounts/{account\_id}/pipelines/v1/sinks
##### [Delete Sink](https://developers.cloudflare.com/api/resources/pipelines/subresources/sinks/methods/delete)
DELETE/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id}
##### ModelsExpand Collapse
SinkListResponse 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
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).
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
Link to this property
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
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
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(model)%20sink_list_response%20%3E%20(schema)>)
SinkGetResponse 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
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).
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
Link to this property
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
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
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(model)%20sink_get_response%20%3E%20(schema)>)
SinkCreateResponse 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, credentials, 5 more } or object {token, account\_id, bucket, 3 more }
R2 Data Catalog Sink
One of the following:
CloudflarePipelinesR2Table object {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: object {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: 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
Link to this property
CloudflarePipelinesR2DataCatalogTable object {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: 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).
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
Link to this property
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
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
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(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)>)
#### PipelinesStreams
##### [List Streams](https://developers.cloudflare.com/api/resources/pipelines/subresources/streams/methods/list)
GET/accounts/{account\_id}/pipelines/v1/streams
##### [Get Stream Details](https://developers.cloudflare.com/api/resources/pipelines/subresources/streams/methods/get)
GET/accounts/{account\_id}/pipelines/v1/streams/{stream\_id}
##### [Create Stream](https://developers.cloudflare.com/api/resources/pipelines/subresources/streams/methods/create)
POST/accounts/{account\_id}/pipelines/v1/streams
##### [Update Stream](https://developers.cloudflare.com/api/resources/pipelines/subresources/streams/methods/update)
PATCH/accounts/{account\_id}/pipelines/v1/streams/{stream\_id}
##### [Delete Stream](https://developers.cloudflare.com/api/resources/pipelines/subresources/streams/methods/delete)
DELETE/accounts/{account\_id}/pipelines/v1/streams/{stream\_id}
##### ModelsExpand Collapse
StreamListResponse object {id, created\_at, http, 7 more }
id: string
Indicates a unique identifier for this stream.
Link to this property
created\_at: string
formatdate-time
Link to this property
http: object {authentication, enabled, cors }
authentication: boolean
Indicates that authentication is required for the HTTP endpoint.
Link to this property
enabled: boolean
Indicates that the HTTP endpoint is enabled.
Link to this property
cors: optional object {origins }
Specifies the CORS options for the HTTP endpoint.
origins: optional array of string
Link to this property
Link to this property
Link to this property
modified\_at: string
formatdate-time
Link to this property
name: string
Indicates the name of the Stream.
maxLength128
minLength1
Link to this property
version: number
Indicates the current version of this stream.
Link to this property
worker\_binding: object {enabled }
enabled: boolean
Indicates that the worker binding is enabled.
Link to this property
Link to this property
endpoint: optional string
Indicates the endpoint URL of this stream.
formaturi
Link to this property
format: optional object {type, decimal\_encoding, timestamp\_format, unstructured } or object {type, compression, row\_group\_bytes }
Defines the data format of the events.
One of the following:
Json object {type, decimal\_encoding, timestamp\_format, unstructured }
type: "json"
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
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
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.streams%20%3E%20(model)%20stream_list_response%20%3E%20(schema)>)
StreamGetResponse object {id, created\_at, http, 7 more }
id: string
Indicates a unique identifier for this stream.
Link to this property
created\_at: string
formatdate-time
Link to this property
http: object {authentication, enabled, cors }
authentication: boolean
Indicates that authentication is required for the HTTP endpoint.
Link to this property
enabled: boolean
Indicates that the HTTP endpoint is enabled.
Link to this property
cors: optional object {origins }
Specifies the CORS options for the HTTP endpoint.
origins: optional array of string
Link to this property
Link to this property
Link to this property
modified\_at: string
formatdate-time
Link to this property
name: string
Indicates the name of the Stream.
maxLength128
minLength1
Link to this property
version: number
Indicates the current version of this stream.
Link to this property
worker\_binding: object {enabled }
enabled: boolean
Indicates that the worker binding is enabled.
Link to this property
Link to this property
endpoint: optional string
Indicates the endpoint URL of this stream.
formaturi
Link to this property
format: optional object {type, decimal\_encoding, timestamp\_format, unstructured } or object {type, compression, row\_group\_bytes }
Defines the data format of the events.
One of the following:
Json object {type, decimal\_encoding, timestamp\_format, unstructured }
type: "json"
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
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
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.streams%20%3E%20(model)%20stream_get_response%20%3E%20(schema)>)
StreamCreateResponse object {id, created\_at, http, 7 more }
id: string
Indicates a unique identifier for this stream.
Link to this property
created\_at: string
formatdate-time
Link to this property
http: object {authentication, enabled, cors }
authentication: boolean
Indicates that authentication is required for the HTTP endpoint.
Link to this property
enabled: boolean
Indicates that the HTTP endpoint is enabled.
Link to this property
cors: optional object {origins }
Specifies the CORS options for the HTTP endpoint.
origins: optional array of string
Link to this property
Link to this property
Link to this property
modified\_at: string
formatdate-time
Link to this property
name: string
Indicates the name of the Stream.
maxLength128
minLength1
Link to this property
version: number
Indicates the current version of this stream.
Link to this property
worker\_binding: object {enabled }
enabled: boolean
Indicates that the worker binding is enabled.
Link to this property
Link to this property
endpoint: optional string
Indicates the endpoint URL of this stream.
formaturi
Link to this property
format: optional object {type, decimal\_encoding, timestamp\_format, unstructured } or object {type, compression, row\_group\_bytes }
Defines the data format of the events.
One of the following:
Json object {type, decimal\_encoding, timestamp\_format, unstructured }
type: "json"
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
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
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.streams%20%3E%20(model)%20stream_create_response%20%3E%20(schema)>)
StreamUpdateResponse object {id, created\_at, http, 7 more }
id: string
Indicates a unique identifier for this stream.
Link to this property
created\_at: string
formatdate-time
Link to this property
http: object {authentication, enabled, cors }
authentication: boolean
Indicates that authentication is required for the HTTP endpoint.
Link to this property
enabled: boolean
Indicates that the HTTP endpoint is enabled.
Link to this property
cors: optional object {origins }
Specifies the CORS options for the HTTP endpoint.
origins: optional array of string
Link to this property
Link to this property
Link to this property
modified\_at: string
formatdate-time
Link to this property
name: string
Indicates the name of the Stream.
maxLength128
minLength1
Link to this property
version: number
Indicates the current version of this stream.
Link to this property
worker\_binding: object {enabled }
enabled: boolean
Indicates that the worker binding is enabled.
Link to this property
Link to this property
endpoint: optional string
Indicates the endpoint URL of this stream.
formaturi
Link to this property
format: optional object {type, decimal\_encoding, timestamp\_format, unstructured } or object {type, compression, row\_group\_bytes }
Defines the data format of the events.
One of the following:
Json object {type, decimal\_encoding, timestamp\_format, unstructured }
type: "json"
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
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
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.streams%20%3E%20(model)%20stream_update_response%20%3E%20(schema)>)
StreamDeleteResponse = unknown
[Link to this property](<#(resource)%20pipelines.streams%20%3E%20(model)%20stream_delete_response%20%3E%20(schema)>)