Pipelines
[DEPRECATED] List Pipelines
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
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
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
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
Deprecated
client.pipelines.delete(stringpipelineName, PipelineDeleteParams { account_id } params, RequestOptionsoptions?): void
DELETE/accounts/{account_id}/pipelines/{pipeline_name}
List Pipelines
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
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
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
client.pipelines.deleteV1(stringpipelineID, PipelineDeleteV1Params { account_id } params, RequestOptionsoptions?): PipelineDeleteV1Response
DELETE/accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id}
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
FieldType = Int32 { type } | Int64 { type } | Float32 { type } | 8 more
One of the following:
Struct { fields, type, name }
Struct { fields, type, name }
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
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:
StructField { fields, name }
StructField { fields, name }
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
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:
PipelineListResponse { result_info, results, success }
PipelineListResponse { result_info, results, success }
results: Array<Result>
results: Array<Result>
destination: Destination { batch, compression, format, 2 more }
destination: Destination { batch, compression, format, 2 more }
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource { format, type } >
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource { format, type } >
PipelineGetResponse { id, destination, endpoint, 3 more } [DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
PipelineGetResponse { id, destination, endpoint, 3 more }
[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
destination: Destination { batch, compression, format, 2 more }
destination: Destination { batch, compression, format, 2 more }
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource { format, type } >
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource { format, type } >
PipelineCreateResponse { id, destination, endpoint, 3 more } [DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
PipelineCreateResponse { id, destination, endpoint, 3 more }
[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
destination: Destination { batch, compression, format, 2 more }
destination: Destination { batch, compression, format, 2 more }
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource { format, type } >
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource { format, type } >
PipelineUpdateResponse { id, destination, endpoint, 3 more } [DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
PipelineUpdateResponse { id, destination, endpoint, 3 more }
[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
destination: Destination { batch, compression, format, 2 more }
destination: Destination { batch, compression, format, 2 more }
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource { format, type } >
source: Array<CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } | CloudflarePipelinesWorkersPipelinesBindingSource { format, type } >
PipelinesSinks
List Sinks
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
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
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
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 }
SinkListResponse { id, created_at, modified_at, 5 more }
config?: CloudflarePipelinesR2TablePublic { account_id, bucket, file_naming, 4 more } | CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more } Defines the configuration of the R2 Sink.
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.
CloudflarePipelinesR2TablePublic { account_id, bucket, file_naming, 4 more }
R2 Sink public configuration.
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).
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).
CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more } R2 Data Catalog Sink public configuration.
CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more }
R2 Data Catalog Sink public configuration.
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).
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).
format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes } Defines the output data format of a sink.
format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }
Defines the output data format of a sink.
schema?: Schema { fields, inferred } Defines the schema of the events in the data stream.
schema?: Schema { fields, inferred }
Defines the schema of the events in the data stream.
One of the following:
SinkGetResponse { id, created_at, modified_at, 5 more }
SinkGetResponse { id, created_at, modified_at, 5 more }
config?: CloudflarePipelinesR2TablePublic { account_id, bucket, file_naming, 4 more } | CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more } Defines the configuration of the R2 Sink.
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.
CloudflarePipelinesR2TablePublic { account_id, bucket, file_naming, 4 more }
R2 Sink public configuration.
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).
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).
CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more } R2 Data Catalog Sink public configuration.
CloudflarePipelinesR2DataCatalogTablePublic { account_id, bucket, table_name, 2 more }
R2 Data Catalog Sink public configuration.
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).
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).
format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes } Defines the output data format of a sink.
format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }
Defines the output data format of a sink.
schema?: Schema { fields, inferred } Defines the schema of the events in the data stream.
schema?: Schema { fields, inferred }
Defines the schema of the events in the data stream.
One of the following:
SinkCreateResponse { id, created_at, modified_at, 5 more }
SinkCreateResponse { id, created_at, modified_at, 5 more }
config?: CloudflarePipelinesR2Table { account_id, bucket, credentials, 5 more } | CloudflarePipelinesR2DataCatalogTable { token, account_id, bucket, 3 more } R2 Data Catalog Sink
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 }
CloudflarePipelinesR2Table { account_id, bucket, credentials, 5 more }
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).
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).
CloudflarePipelinesR2DataCatalogTable { token, account_id, bucket, 3 more } R2 Data Catalog Sink
CloudflarePipelinesR2DataCatalogTable { token, account_id, bucket, 3 more }
R2 Data Catalog Sink
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).
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).
format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes } Defines the output data format of a sink.
format?: CloudflarePipelinesSinkJsonFormat { type, compression, decimal_encoding, 2 more } | CloudflarePipelinesSinkParquetFormat { type, compression, row_group_bytes }
Defines the output data format of a sink.
schema?: Schema { fields, inferred } Defines the schema of the events in the data stream.
schema?: Schema { fields, inferred }
Defines the schema of the events in the data stream.
One of the following:
PipelinesStreams
List Streams
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
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
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
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
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 }
StreamListResponse { id, created_at, http, 7 more }
format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes } Defines the data format of the events.
format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }
Defines the data format of the events.
schema?: Schema { fields, inferred } Defines the schema of the events in the data stream.
schema?: Schema { fields, inferred }
Defines the schema of the events in the data stream.
One of the following:
StreamGetResponse { id, created_at, http, 7 more }
StreamGetResponse { id, created_at, http, 7 more }
format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes } Defines the data format of the events.
format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }
Defines the data format of the events.
schema?: Schema { fields, inferred } Defines the schema of the events in the data stream.
schema?: Schema { fields, inferred }
Defines the schema of the events in the data stream.
One of the following:
StreamCreateResponse { id, created_at, http, 7 more }
StreamCreateResponse { id, created_at, http, 7 more }
format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes } Defines the data format of the events.
format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }
Defines the data format of the events.
schema?: Schema { fields, inferred } Defines the schema of the events in the data stream.
schema?: Schema { fields, inferred }
Defines the schema of the events in the data stream.
One of the following:
StreamUpdateResponse { id, created_at, http, 7 more }
StreamUpdateResponse { id, created_at, http, 7 more }
format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes } Defines the data format of the events.
format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }
Defines the data format of the events.
schema?: Schema { fields, inferred } Defines the schema of the events in the data stream.
schema?: Schema { fields, inferred }
Defines the schema of the events in the data stream.
One of the following: