List K2 streams

client.K2.Streams.List(ctx, params) (*V4PagePaginationArray[StreamListResponse], error)

GET/accounts/{account_id}/k2/streams

List or filter K2 streams in an 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

ParametersExpand Collapse

params StreamListParams

AccountID param.Field[string]

Path param: Specifies the public ID of the account.

maxLength32

minLength32

Name param.Field[string]Optional

Query param: Filters K2 streams by name using a case-insensitive substring.

maxLength128

minLength1

Page param.Field[int64]Optional

Query param

minimum1

PerPage param.Field[int64]Optional

Query param

maximum100

minimum1

ReturnsExpand Collapse

type StreamListResponse struct{…}

ID string

Specifies the public ID of the K2 stream.

maxLength32

minLength32

CreatedAt Time

formatdate-time

Endpoint string

Indicates the base HTTP endpoint for producing and consuming records.

formaturi

HTTP StreamListResponseHTTP

One of the following:

type StreamListResponseHTTPEnabled struct{…}

Enabled StreamListResponseHTTPEnabledEnabled

Indicates whether the HTTP endpoint accepts records.

type StreamListResponseHTTPObject struct{…}

Enabled StreamListResponseHTTPObjectEnabled

Indicates whether the HTTP endpoint accepts records.

Authentication boolOptional

Indicates whether the HTTP endpoint requires an API token with K2 produce permission. When false or omitted, the endpoint accepts unauthenticated records.

CORS StreamListResponseHTTPObjectCORSOptional

Origins StreamListResponseHTTPObjectCORSOriginsUnionOptional

Allows requests from these HTTP or HTTPS origins. Use a wildcard only as the sole origin.

One of the following:

type StreamListResponseHTTPObjectCORSOriginsArray []StreamListResponseHTTPObjectCORSOriginsArrayItem

type StreamListResponseHTTPObjectCORSOriginsArray []string

ModifiedAt Time

formatdate-time

Name string

Indicates the name of the K2 stream.

maxLength128

minLength1

RetentionSeconds int64

Shows the configured record retention period from 1 hour (3600 seconds) to 30 days (2592000 seconds), inclusive.

maximum2592000

minimum3600

WorkerBinding StreamListResponseWorkerBinding

One of the following:

type StreamListResponseWorkerBindingEnabled struct{…}

Enabled StreamListResponseWorkerBindingEnabledEnabled

Indicates whether Workers bindings can produce records to the stream.

type StreamListResponseWorkerBindingEnabled struct{…}

Enabled StreamListResponseWorkerBindingEnabledEnabled

Indicates whether Workers bindings can produce records to the stream.

List K2 streams

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/k2"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.K2.Streams.List(context.TODO(), k2.StreamListParams{
    AccountID: cloudflare.F("0123105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "result": [
    {
      "id": "053e105f4ecef8ad9ca31a8372d0c353",
      "created_at": "2019-12-27T18:11:19.117Z",
      "endpoint": "https://053e105f4ecef8ad9ca31a8372d0c353.k2.cloudflarestorage.com",
      "http": {
        "enabled": false
      },
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "my_k2_stream",
      "retention_seconds": 604800,
      "worker_binding": {
        "enabled": false
      }
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}

Returns Examples

{
  "result": [
    {
      "id": "053e105f4ecef8ad9ca31a8372d0c353",
      "created_at": "2019-12-27T18:11:19.117Z",
      "endpoint": "https://053e105f4ecef8ad9ca31a8372d0c353.k2.cloudflarestorage.com",
      "http": {
        "enabled": false
      },
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "my_k2_stream",
      "retention_seconds": 604800,
      "worker_binding": {
        "enabled": false
      }
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}