Skip to content
Cloudflare API
Start here
API Reference

Pipelines

[DEPRECATED] List Pipelines
Deprecated
client.Pipelines.List(ctx, params) (*PipelineListResponse, error)
GET/accounts/{account_id}/pipelines
[DEPRECATED] Get Pipeline
Deprecated
client.Pipelines.Get(ctx, pipelineName, query) (*PipelineGetResponse, error)
GET/accounts/{account_id}/pipelines/{pipeline_name}
[DEPRECATED] Create Pipeline
Deprecated
client.Pipelines.New(ctx, params) (*PipelineNewResponse, error)
POST/accounts/{account_id}/pipelines
[DEPRECATED] Update Pipeline
Deprecated
client.Pipelines.Update(ctx, pipelineName, params) (*PipelineUpdateResponse, error)
PUT/accounts/{account_id}/pipelines/{pipeline_name}
[DEPRECATED] Delete Pipeline
Deprecated
client.Pipelines.Delete(ctx, pipelineName, body) error
DELETE/accounts/{account_id}/pipelines/{pipeline_name}
List Pipelines
client.Pipelines.ListV1(ctx, params) (*V4PagePaginationArray[PipelineListV1Response], error)
GET/accounts/{account_id}/pipelines/v1/pipelines
Get Pipeline Details
client.Pipelines.GetV1(ctx, pipelineID, query) (*PipelineGetV1Response, error)
GET/accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id}
Create Pipeline
client.Pipelines.NewV1(ctx, params) (*PipelineNewV1Response, error)
POST/accounts/{account_id}/pipelines/v1/pipelines
Delete Pipeline
client.Pipelines.DeleteV1(ctx, pipelineID, body) (*PipelineDeleteV1Response, error)
DELETE/accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id}
Validate SQL
client.Pipelines.ValidateSql(ctx, params) (*PipelineValidateSqlResponse, error)
POST/accounts/{account_id}/pipelines/v1/validate_sql
ModelsExpand Collapse
type FieldType interface{…}
One of the following:
FieldTypeInt32
Type FieldTypeInt32Type
FieldTypeInt64
Type FieldTypeInt64Type
FieldTypeFloat32
Type FieldTypeFloat32Type
FieldTypeFloat64
Type FieldTypeFloat64Type
FieldTypeBool
Type FieldTypeBoolType
FieldTypeString
Type FieldTypeStringType
FieldTypeBinary
Type FieldTypeBinaryType
FieldTypeTimestamp
Type FieldTypeTimestampType
Unit FieldTypeTimestampUnitOptional
One of the following:
const FieldTypeTimestampUnitSecond FieldTypeTimestampUnit = "second"
const FieldTypeTimestampUnitMillisecond FieldTypeTimestampUnit = "millisecond"
const FieldTypeTimestampUnitMicrosecond FieldTypeTimestampUnit = "microsecond"
const FieldTypeTimestampUnitNanosecond FieldTypeTimestampUnit = "nanosecond"
FieldTypeJson
Type FieldTypeJsonType
FieldTypeStruct
Fields []SourceField
One of the following:
type SourceFieldInt32 struct{…}
Type SourceFieldInt32Type
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldInt64 struct{…}
Type SourceFieldInt64Type
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldFloat32 struct{…}
Type SourceFieldFloat32Type
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldFloat64 struct{…}
Type SourceFieldFloat64Type
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldBool struct{…}
Type SourceFieldBoolType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldString struct{…}
Type SourceFieldStringType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldBinary struct{…}
Type SourceFieldBinaryType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldTimestamp struct{…}
Type SourceFieldTimestampType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
Unit SourceFieldTimestampUnitOptional
One of the following:
const SourceFieldTimestampUnitSecond SourceFieldTimestampUnit = "second"
const SourceFieldTimestampUnitMillisecond SourceFieldTimestampUnit = "millisecond"
const SourceFieldTimestampUnitMicrosecond SourceFieldTimestampUnit = "microsecond"
const SourceFieldTimestampUnitNanosecond SourceFieldTimestampUnit = "nanosecond"
type SourceFieldJson struct{…}
Type SourceFieldJsonType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldStruct struct{…}
Type SourceFieldStructType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldList struct{…}
Type SourceFieldListType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
Type FieldTypeStructType
Name stringOptional
FieldTypeList
Type FieldTypeListType
type ListField struct{…}
type SourceField interface{…}
One of the following:
type SourceFieldInt32 struct{…}
Type SourceFieldInt32Type
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldInt64 struct{…}
Type SourceFieldInt64Type
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldFloat32 struct{…}
Type SourceFieldFloat32Type
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldFloat64 struct{…}
Type SourceFieldFloat64Type
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldBool struct{…}
Type SourceFieldBoolType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldString struct{…}
Type SourceFieldStringType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldBinary struct{…}
Type SourceFieldBinaryType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldTimestamp struct{…}
Type SourceFieldTimestampType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
Unit SourceFieldTimestampUnitOptional
One of the following:
const SourceFieldTimestampUnitSecond SourceFieldTimestampUnit = "second"
const SourceFieldTimestampUnitMillisecond SourceFieldTimestampUnit = "millisecond"
const SourceFieldTimestampUnitMicrosecond SourceFieldTimestampUnit = "microsecond"
const SourceFieldTimestampUnitNanosecond SourceFieldTimestampUnit = "nanosecond"
type SourceFieldJson struct{…}
Type SourceFieldJsonType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldStruct struct{…}
Type SourceFieldStructType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type SourceFieldList struct{…}
Type SourceFieldListType
MetadataKey stringOptional
Name stringOptional
Required boolOptional
SqlName stringOptional
type StructField struct{…}
Fields []SourceField
Name stringOptional

PipelinesSinks

List Sinks
client.Pipelines.Sinks.List(ctx, params) (*V4PagePaginationArray[SinkListResponse], error)
GET/accounts/{account_id}/pipelines/v1/sinks
Get Sink Details
client.Pipelines.Sinks.Get(ctx, sinkID, query) (*SinkGetResponse, error)
GET/accounts/{account_id}/pipelines/v1/sinks/{sink_id}
Create Sink
client.Pipelines.Sinks.New(ctx, params) (*SinkNewResponse, error)
POST/accounts/{account_id}/pipelines/v1/sinks
Delete Sink
client.Pipelines.Sinks.Delete(ctx, sinkID, body) (*SinkDeleteResponse, error)
DELETE/accounts/{account_id}/pipelines/v1/sinks/{sink_id}

PipelinesStreams

List Streams
client.Pipelines.Streams.List(ctx, params) (*V4PagePaginationArray[StreamListResponse], error)
GET/accounts/{account_id}/pipelines/v1/streams
Get Stream Details
client.Pipelines.Streams.Get(ctx, streamID, query) (*StreamGetResponse, error)
GET/accounts/{account_id}/pipelines/v1/streams/{stream_id}
Create Stream
client.Pipelines.Streams.New(ctx, params) (*StreamNewResponse, error)
POST/accounts/{account_id}/pipelines/v1/streams
Update Stream
client.Pipelines.Streams.Update(ctx, streamID, params) (*StreamUpdateResponse, error)
PATCH/accounts/{account_id}/pipelines/v1/streams/{stream_id}
Delete Stream
client.Pipelines.Streams.Delete(ctx, streamID, body) (*StreamDeleteResponse, error)
DELETE/accounts/{account_id}/pipelines/v1/streams/{stream_id}