List Streams

GET/accounts/{account_id}/pipelines/v1/streams

List/Filter Streams in Account.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Pipelines WritePipelines Read

Path ParametersExpand Collapse

account_id: string

Specifies the public ID of the account.

Query ParametersExpand Collapse

page: optional number

per_page: optional number

pipeline_id: optional string

Specifies the public ID of the pipeline.

maxLength32

minLength32

ReturnsExpand Collapse

result: array of object { id, created_at, http, 7 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: object { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors: optional object { origins }

Specifies the CORS options for the HTTP endpoint.

origins: optional array of string

modified_at: string

formatdate-time

Indicates the name of the Stream.

maxLength128

minLength1

version: number

Indicates the current version of this stream.

worker_binding: object { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint: optional string

Indicates the endpoint URL of this stream.

formaturi

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0

schema: optional object { fields, format, inferred }

fields: optional array of object { type, metadata_key, name, 2 more } or object { type, metadata_key, name, 2 more } or object { type, metadata_key, name, 2 more } or 8 more

One of the following:

Int32 = object { type, metadata_key, name, 2 more }

type: "int32"

metadata_key: optional string

required: optional boolean

sql_name: optional string

Int64 = object { type, metadata_key, name, 2 more }

type: "int64"

metadata_key: optional string

required: optional boolean

sql_name: optional string

Float32 = object { type, metadata_key, name, 2 more }

type: "float32"

metadata_key: optional string

required: optional boolean

sql_name: optional string

Float64 = object { type, metadata_key, name, 2 more }

type: "float64"

metadata_key: optional string

required: optional boolean

sql_name: optional string

Bool = object { type, metadata_key, name, 2 more }

type: "bool"

metadata_key: optional string

required: optional boolean

sql_name: optional string

String = object { type, metadata_key, name, 2 more }

type: "string"

metadata_key: optional string

required: optional boolean

sql_name: optional string

Binary = object { type, metadata_key, name, 2 more }

type: "binary"

metadata_key: optional string

required: optional boolean

sql_name: optional string

Timestamp = object { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key: optional string

required: optional boolean

sql_name: optional string

unit: optional "second" or "millisecond" or "microsecond" or "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json = object { type, metadata_key, name, 2 more }

type: "json"

metadata_key: optional string

required: optional boolean

sql_name: optional string

Struct =

List =

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0

inferred: optional boolean

result_info: object { count, page, per_page, total_count }

Indicates the number of items on current page.

page: number

Indicates the current page number.

per_page: number

Indicates the number of items per page.

total_count: number

Indicates the total number of items.

success: boolean

Indicates whether the API call was successful.

List Streams

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pipelines/v1/streams \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "result": [
    {
      "id": "01234567890123457689012345678901",
      "created_at": "2019-12-27T18:11:19.117Z",
      "http": {
        "authentication": false,
        "enabled": true,
        "cors": {
          "origins": [
            "string"
          ]
        }
      },
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "my_stream",
      "version": 3,
      "worker_binding": {
        "enabled": true
      },
      "endpoint": "https://01234567890123457689012345678901.ingest.cloudflare.com/v1",
      "format": {
        "type": "json",
        "decimal_encoding": "number",
        "timestamp_format": "rfc3339",
        "unstructured": true
      },
      "schema": {
        "fields": [
          {
            "type": "int32",
            "metadata_key": "metadata_key",
            "name": "name",
            "required": true,
            "sql_name": "sql_name"
          }
        ],
        "format": {
          "type": "json",
          "decimal_encoding": "number",
          "timestamp_format": "rfc3339",
          "unstructured": true
        },
        "inferred": true
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 0,
    "per_page": 10,
    "total_count": 1
  },
  "success": true
}

Returns Examples

{
  "result": [
    {
      "id": "01234567890123457689012345678901",
      "created_at": "2019-12-27T18:11:19.117Z",
      "http": {
        "authentication": false,
        "enabled": true,
        "cors": {
          "origins": [
            "string"
          ]
        }
      },
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "my_stream",
      "version": 3,
      "worker_binding": {
        "enabled": true
      },
      "endpoint": "https://01234567890123457689012345678901.ingest.cloudflare.com/v1",
      "format": {
        "type": "json",
        "decimal_encoding": "number",
        "timestamp_format": "rfc3339",
        "unstructured": true
      },
      "schema": {
        "fields": [
          {
            "type": "int32",
            "metadata_key": "metadata_key",
            "name": "name",
            "required": true,
            "sql_name": "sql_name"
          }
        ],
        "format": {
          "type": "json",
          "decimal_encoding": "number",
          "timestamp_format": "rfc3339",
          "unstructured": true
        },
        "inferred": true
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 0,
    "per_page": 10,
    "total_count": 1
  },
  "success": true
}