--- title: Pipelines --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/pipelines/methods/list) Deprecated client.pipelines.list(PipelineListParams {account\_id, page, per\_page, search } params, RequestOptionsoptions?): [PipelineListResponse]() {result\_info, results, success } GET/accounts/{account\_id}/pipelines ##### [\[DEPRECATED\] Get Pipeline](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/get) Deprecated client.pipelines.get(stringpipelineName, PipelineGetParams {account\_id } params, RequestOptionsoptions?): [PipelineGetResponse]() {id, destination, endpoint, 3 more } GET/accounts/{account\_id}/pipelines/{pipeline\_name} ##### [\[DEPRECATED\] Create Pipeline](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/create) Deprecated client.pipelines.create(PipelineCreateParams {account\_id, destination, name, source } params, RequestOptionsoptions?): [PipelineCreateResponse]() {id, destination, endpoint, 3 more } POST/accounts/{account\_id}/pipelines ##### [\[DEPRECATED\] Update Pipeline](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/update) Deprecated client.pipelines.update(stringpipelineName, PipelineUpdateParams {account\_id, destination, name, source } params, RequestOptionsoptions?): [PipelineUpdateResponse]() {id, destination, endpoint, 3 more } PUT/accounts/{account\_id}/pipelines/{pipeline\_name} ##### [\[DEPRECATED\] Delete Pipeline](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/delete) Deprecated client.pipelines.delete(stringpipelineName, PipelineDeleteParams {account\_id } params, RequestOptionsoptions?): void DELETE/accounts/{account\_id}/pipelines/{pipeline\_name} ##### [List Pipelines](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/list_v1) client.pipelines.listV1(PipelineListV1Params {account\_id, name, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [PipelineListV1Response]() {id, created\_at, modified\_at, 3 more } > GET/accounts/{account\_id}/pipelines/v1/pipelines ##### [Get Pipeline Details](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/get_v1) client.pipelines.getV1(stringpipelineID, PipelineGetV1Params {account\_id } params, RequestOptionsoptions?): [PipelineGetV1Response]() {id, created\_at, modified\_at, 5 more } GET/accounts/{account\_id}/pipelines/v1/pipelines/{pipeline\_id} ##### [Create Pipeline](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/create_v1) client.pipelines.createV1(PipelineCreateV1Params {account\_id, name, sql } params, RequestOptionsoptions?): [PipelineCreateV1Response]() {id, created\_at, modified\_at, 3 more } POST/accounts/{account\_id}/pipelines/v1/pipelines ##### [Delete Pipeline](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/delete_v1) client.pipelines.deleteV1(stringpipelineID, PipelineDeleteV1Params {account\_id } params, RequestOptionsoptions?): [PipelineDeleteV1Response]() DELETE/accounts/{account\_id}/pipelines/v1/pipelines/{pipeline\_id} ##### [Validate SQL](https://developers.cloudflare.com/api/typescript/resources/pipelines/methods/validate_sql) client.pipelines.validateSql(PipelineValidateSqlParams {account\_id, sql } params, RequestOptionsoptions?): [PipelineValidateSqlResponse]() {tables, graph } POST/accounts/{account\_id}/pipelines/v1/validate\_sql ##### ModelsExpand Collapse
FieldType = Int32 {type } | Int64 {type } | Float32 {type } | 8 more One of the following:
Int32 {type } type: "int32" Link to this property
Link to this property
Int64 {type } type: "int64" Link to this property
Link to this property
Float32 {type } type: "float32" Link to this property
Link to this property
Float64 {type } type: "float64" Link to this property
Link to this property
Bool {type } type: "bool" Link to this property
Link to this property
String {type } type: "string" Link to this property
Link to this property
Binary {type } type: "binary" Link to this property
Link to this property
Timestamp {type, unit } type: "timestamp" Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type } type: "json" Link to this property
Link to this property
Struct {fields, type, name }
fields: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property type: "struct" Link to this property name?: string| null Link to this property
Link to this property
List {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 {items } items: SourceField Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20list_field%20%3E%20(schema)>)
SourceField = Int32 {type, metadata\_key, name, 2 more } | Int64 {type, metadata\_key, name, 2 more } | Float32 {type, metadata\_key, name, 2 more } | 8 more One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: 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 {fields, name }
fields: Array<SourceField> One of the following:
SourceField = Int32 {type, metadata\_key, name, 2 more } | Int64 {type, metadata\_key, name, 2 more } | Float32 {type, metadata\_key, name, 2 more } | 8 more One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property
Link to this property name?: string| null Link to this property
[Link to this property](<#(resource)%20pipelines%20%3E%20(model)%20struct_field%20%3E%20(schema)>)
PipelineListResponse {result\_info, results, success }
result\_info: ResultInfo {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<Result> id: string Specifies the pipeline identifier. Link to this property
destination: Destination {batch, compression, format, 2 more }
batch: Batch {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: Compression {type }
type: "none"| "gzip"| "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: Path {bucket, filename, filepath, prefix } bucket: string Specifies the R2 Bucket to store files. Link to this property filename?: string Specifies the name pattern to for individual data files. Link to this property filepath?: string Specifies the name pattern for directory. Link to this property prefix?: 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<CloudflarePipelinesWorkersPipelinesHTTPSource {format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource {format, type } > One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource {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?: boolean Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors?: CORS {origins } origins?: Array<string> Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource {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 {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: Destination {batch, compression, format, 2 more }
batch: Batch {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: Compression {type }
type: "none"| "gzip"| "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: Path {bucket, filename, filepath, prefix } bucket: string Specifies the R2 Bucket to store files. Link to this property filename?: string Specifies the name pattern to for individual data files. Link to this property filepath?: string Specifies the name pattern for directory. Link to this property prefix?: 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<CloudflarePipelinesWorkersPipelinesHTTPSource {format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource {format, type } > One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource {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?: boolean Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors?: CORS {origins } origins?: Array<string> Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource {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 {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: Destination {batch, compression, format, 2 more }
batch: Batch {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: Compression {type }
type: "none"| "gzip"| "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: Path {bucket, filename, filepath, prefix } bucket: string Specifies the R2 Bucket to store files. Link to this property filename?: string Specifies the name pattern to for individual data files. Link to this property filepath?: string Specifies the name pattern for directory. Link to this property prefix?: 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<CloudflarePipelinesWorkersPipelinesHTTPSource {format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource {format, type } > One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource {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?: boolean Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors?: CORS {origins } origins?: Array<string> Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource {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 {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: Destination {batch, compression, format, 2 more }
batch: Batch {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: Compression {type }
type: "none"| "gzip"| "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: Path {bucket, filename, filepath, prefix } bucket: string Specifies the R2 Bucket to store files. Link to this property filename?: string Specifies the name pattern to for individual data files. Link to this property filepath?: string Specifies the name pattern for directory. Link to this property prefix?: 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<CloudflarePipelinesWorkersPipelinesHTTPSource {format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource {format, type } > One of the following:
CloudflarePipelinesWorkersPipelinesHTTPSource {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?: boolean Specifies whether authentication is required to send to this pipeline via HTTP. Link to this property
cors?: CORS {origins } origins?: Array<string> Specifies allowed origins to allow Cross Origin HTTP Requests. Link to this property
Link to this property
Link to this property
CloudflarePipelinesWorkersPipelinesBindingSource {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 {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 {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<Table> 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"| "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?: 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 {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 {tables, graph }
tables: Record<string, Tables> 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?: Graph {edges, nodes } Indicates the processing flow to implement the SQL.
edges: Array<Edge> 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<Node> 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/typescript/resources/pipelines/subresources/sinks/methods/list) client.pipelines.sinks.list(SinkListParams {account\_id, name, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray< [SinkListResponse]() {id, created\_at, modified\_at, 5 more } > GET/accounts/{account\_id}/pipelines/v1/sinks ##### [Get Sink Details](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/sinks/methods/get) client.pipelines.sinks.get(stringsinkID, SinkGetParams {account\_id } params, RequestOptionsoptions?): [SinkGetResponse]() {id, created\_at, modified\_at, 5 more } GET/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id} ##### [Create Sink](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/sinks/methods/create) client.pipelines.sinks.create(SinkCreateParams {account\_id, name, type, 3 more } params, RequestOptionsoptions?): [SinkCreateResponse]() {id, created\_at, modified\_at, 5 more } POST/accounts/{account\_id}/pipelines/v1/sinks ##### [Delete Sink](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/sinks/methods/delete) client.pipelines.sinks.delete(stringsinkID, SinkDeleteParams {account\_id } params, RequestOptionsoptions?): [SinkDeleteResponse]() DELETE/accounts/{account\_id}/pipelines/v1/sinks/{sink\_id} ##### ModelsExpand Collapse
SinkListResponse {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"| "r2\_data\_catalog"| "basin\_catalog" Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
config?: CloudflarePipelinesR2TablePublic {account\_id, bucket, file\_naming, 4 more } | CloudflarePipelinesR2DataCatalogTablePublic {account\_id, bucket, table\_name, 2 more } Defines the configuration of the R2 Sink. One of the following:
CloudflarePipelinesR2TablePublic {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?: FileNaming {prefix, strategy, suffix } Controls filename prefix/suffix and strategy. prefix?: string The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy?: "serial"| "uuid"| "uuid\_v7"| "ulid" Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix?: string This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction?: string Jurisdiction this bucket is hosted in Link to this property
partitioning?: Partitioning {time\_pattern } Data-layout partitioning for sinks. time\_pattern?: string The pattern of the date string Link to this property
Link to this property path?: string Subpath within the bucket to write to Link to this property
rolling\_policy?: RollingPolicy {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?: number Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: 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 {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?: string Table namespace Link to this property
rolling\_policy?: RollingPolicy {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?: number Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: 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?: CloudflarePipelinesSinkJsonFormat {type, compression, decimal\_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } Defines the output data format of a sink. One of the following:
CloudflarePipelinesSinkJsonFormat {type, compression, decimal\_encoding, 2 more } type: "json" Link to this property
compression?: "uncompressed"| "gzip" Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null 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 {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"| "r2\_data\_catalog"| "basin\_catalog" Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
config?: CloudflarePipelinesR2TablePublic {account\_id, bucket, file\_naming, 4 more } | CloudflarePipelinesR2DataCatalogTablePublic {account\_id, bucket, table\_name, 2 more } Defines the configuration of the R2 Sink. One of the following:
CloudflarePipelinesR2TablePublic {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?: FileNaming {prefix, strategy, suffix } Controls filename prefix/suffix and strategy. prefix?: string The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy?: "serial"| "uuid"| "uuid\_v7"| "ulid" Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix?: string This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction?: string Jurisdiction this bucket is hosted in Link to this property
partitioning?: Partitioning {time\_pattern } Data-layout partitioning for sinks. time\_pattern?: string The pattern of the date string Link to this property
Link to this property path?: string Subpath within the bucket to write to Link to this property
rolling\_policy?: RollingPolicy {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?: number Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: 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 {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?: string Table namespace Link to this property
rolling\_policy?: RollingPolicy {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?: number Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: 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?: CloudflarePipelinesSinkJsonFormat {type, compression, decimal\_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } Defines the output data format of a sink. One of the following:
CloudflarePipelinesSinkJsonFormat {type, compression, decimal\_encoding, 2 more } type: "json" Link to this property
compression?: "uncompressed"| "gzip" Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null 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 {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"| "r2\_data\_catalog"| "basin\_catalog" Specifies the type of sink. One of the following: "r2" Link to this property "r2\_data\_catalog" Link to this property "basin\_catalog" Link to this property
Link to this property
config?: CloudflarePipelinesR2Table {account\_id, bucket, credentials, 5 more } | CloudflarePipelinesR2DataCatalogTable {token, account\_id, bucket, 3 more } R2 Data Catalog Sink One of the following:
CloudflarePipelinesR2Table {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: Credentials {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?: FileNaming {prefix, strategy, suffix } Controls filename prefix/suffix and strategy. prefix?: string The prefix to use in file name. i.e prefix-.parquet Link to this property
strategy?: "serial"| "uuid"| "uuid\_v7"| "ulid" Filename generation strategy. One of the following: "serial" Link to this property "uuid" Link to this property "uuid\_v7" Link to this property "ulid" Link to this property
Link to this property suffix?: string This will overwrite the default file suffix. i.e .parquet, use with caution Link to this property
Link to this property jurisdiction?: string Jurisdiction this bucket is hosted in Link to this property
partitioning?: Partitioning {time\_pattern } Data-layout partitioning for sinks. time\_pattern?: string The pattern of the date string Link to this property
Link to this property path?: string Subpath within the bucket to write to Link to this property
rolling\_policy?: RollingPolicy {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?: number Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: 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 {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?: string Table namespace Link to this property
rolling\_policy?: RollingPolicy {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?: number Files will be rolled after reaching this number of bytes formatuint64 minimum0 Link to this property inactivity\_seconds?: number Number of seconds of inactivity to wait before rolling over to a new file formatuint64 minimum1 Link to this property interval\_seconds?: 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?: CloudflarePipelinesSinkJsonFormat {type, compression, decimal\_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } Defines the output data format of a sink. One of the following:
CloudflarePipelinesSinkJsonFormat {type, compression, decimal\_encoding, 2 more } type: "json" Link to this property
compression?: "uncompressed"| "gzip" Specifies the compression applied to JSON sink output. One of the following: "uncompressed" Link to this property "gzip" Link to this property
Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
CloudflarePipelinesSinkParquetFormat {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null 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/typescript/resources/pipelines/subresources/streams/methods/list) client.pipelines.streams.list(StreamListParams {account\_id, name, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray< [StreamListResponse]() {id, created\_at, http, 7 more } > GET/accounts/{account\_id}/pipelines/v1/streams ##### [Get Stream Details](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/streams/methods/get) client.pipelines.streams.get(stringstreamID, StreamGetParams {account\_id } params, RequestOptionsoptions?): [StreamGetResponse]() {id, created\_at, http, 7 more } GET/accounts/{account\_id}/pipelines/v1/streams/{stream\_id} ##### [Create Stream](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/streams/methods/create) client.pipelines.streams.create(StreamCreateParams {account\_id, name, format, 3 more } params, RequestOptionsoptions?): [StreamCreateResponse]() {id, created\_at, http, 7 more } POST/accounts/{account\_id}/pipelines/v1/streams ##### [Update Stream](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/streams/methods/update) client.pipelines.streams.update(stringstreamID, StreamUpdateParams {account\_id, http, worker\_binding } params, RequestOptionsoptions?): [StreamUpdateResponse]() {id, created\_at, http, 7 more } PATCH/accounts/{account\_id}/pipelines/v1/streams/{stream\_id} ##### [Delete Stream](https://developers.cloudflare.com/api/typescript/resources/pipelines/subresources/streams/methods/delete) client.pipelines.streams.delete(stringstreamID, StreamDeleteParams {account\_id } params, RequestOptionsoptions?): [StreamDeleteResponse]() DELETE/accounts/{account\_id}/pipelines/v1/streams/{stream\_id} ##### ModelsExpand Collapse
StreamListResponse {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: HTTP {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?: CORS {origins } Specifies the CORS options for the HTTP endpoint. origins?: Array<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: WorkerBinding {enabled } enabled: boolean Indicates that the worker binding is enabled. Link to this property
Link to this property endpoint?: string Indicates the endpoint URL of this stream. formaturi Link to this property
format?: Json {type, decimal\_encoding, timestamp\_format, unstructured } | Parquet {type, compression, row\_group\_bytes } Defines the data format of the events. One of the following:
Json {type, decimal\_encoding, timestamp\_format, unstructured } type: "json" Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
Parquet {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null 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 {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: HTTP {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?: CORS {origins } Specifies the CORS options for the HTTP endpoint. origins?: Array<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: WorkerBinding {enabled } enabled: boolean Indicates that the worker binding is enabled. Link to this property
Link to this property endpoint?: string Indicates the endpoint URL of this stream. formaturi Link to this property
format?: Json {type, decimal\_encoding, timestamp\_format, unstructured } | Parquet {type, compression, row\_group\_bytes } Defines the data format of the events. One of the following:
Json {type, decimal\_encoding, timestamp\_format, unstructured } type: "json" Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
Parquet {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null 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 {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: HTTP {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?: CORS {origins } Specifies the CORS options for the HTTP endpoint. origins?: Array<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: WorkerBinding {enabled } enabled: boolean Indicates that the worker binding is enabled. Link to this property
Link to this property endpoint?: string Indicates the endpoint URL of this stream. formaturi Link to this property
format?: Json {type, decimal\_encoding, timestamp\_format, unstructured } | Parquet {type, compression, row\_group\_bytes } Defines the data format of the events. One of the following:
Json {type, decimal\_encoding, timestamp\_format, unstructured } type: "json" Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
Parquet {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null 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 {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: HTTP {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?: CORS {origins } Specifies the CORS options for the HTTP endpoint. origins?: Array<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: WorkerBinding {enabled } enabled: boolean Indicates that the worker binding is enabled. Link to this property
Link to this property endpoint?: string Indicates the endpoint URL of this stream. formaturi Link to this property
format?: Json {type, decimal\_encoding, timestamp\_format, unstructured } | Parquet {type, compression, row\_group\_bytes } Defines the data format of the events. One of the following:
Json {type, decimal\_encoding, timestamp\_format, unstructured } type: "json" Link to this property
decimal\_encoding?: "number"| "string"| "bytes" One of the following: "number" Link to this property "string" Link to this property "bytes" Link to this property
Link to this property
timestamp\_format?: "rfc3339"| "unix\_millis" One of the following: "rfc3339" Link to this property "unix\_millis" Link to this property
Link to this property unstructured?: boolean Link to this property
Link to this property
Parquet {type, compression, row\_group\_bytes } type: "parquet" Link to this property
compression?: "uncompressed"| "snappy"| "gzip"| 2 more One of the following: "uncompressed" Link to this property "snappy" Link to this property "gzip" Link to this property "zstd" Link to this property "lz4" Link to this property
Link to this property row\_group\_bytes?: number| null formatint64 minimum0 Link to this property
Link to this property
Link to this property
schema?: Schema {fields, inferred } Defines the schema of the events in the data stream.
fields?: Array<SourceField> One of the following:
Int32 {type, metadata\_key, name, 2 more } type: "int32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Int64 {type, metadata\_key, name, 2 more } type: "int64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float32 {type, metadata\_key, name, 2 more } type: "float32" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Float64 {type, metadata\_key, name, 2 more } type: "float64" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Bool {type, metadata\_key, name, 2 more } type: "bool" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
String {type, metadata\_key, name, 2 more } type: "string" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Binary {type, metadata\_key, name, 2 more } type: "binary" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Timestamp {type, metadata\_key, name, 3 more } type: "timestamp" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
unit?: "second"| "millisecond"| "microsecond"| "nanosecond" One of the following: "second" Link to this property "millisecond" Link to this property "microsecond" Link to this property "nanosecond" Link to this property
Link to this property
Link to this property
Json {type, metadata\_key, name, 2 more } type: "json" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Struct extends StructField {fields, name } {type, metadata\_key, name, 2 more } type: "struct" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
List extends ListField {items } {type, metadata\_key, name, 2 more } type: "list" Link to this property metadata\_key?: string| null Link to this property name?: string Link to this property required?: boolean Link to this property sql\_name?: string Link to this property
Link to this property
Link to this property inferred?: boolean| null 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)>)