List K2 streams

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

Path ParametersExpand Collapse

account_id: string

Specifies the public ID of the account.

maxLength32

minLength32

Query ParametersExpand Collapse

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

maxLength128

minLength1

page: optional number

minimum1

per_page: optional number

maximum100

minimum1

ReturnsExpand Collapse

errors: array of object { message, code }

message: string

code: optional number

messages: array of object { message, code }

message: string

code: optional number

result: array of object { id, created_at, endpoint, 5 more }

id: string

Specifies the public ID of the K2 stream.

maxLength32

minLength32

created_at: string

formatdate-time

endpoint: string

Indicates the base HTTP endpoint for producing and consuming records.

formaturi

http: object { enabled, authentication, cors }

Configures the HTTP endpoint. Disabling HTTP keeps authentication and cors, so enabling it again restores them.

enabled: boolean

Indicates whether the HTTP endpoint accepts records.

authentication: optional boolean

Indicates whether the HTTP endpoint requires an API token with K2 produce permission. When false, the endpoint accepts unauthenticated records. Defaults to true when HTTP is enabled without a stored value.

cors: optional object { origins }

origins: optional array of string

Allows browser requests from these HTTP or HTTPS origins. Use a wildcard only as the sole origin. An empty list blocks cross-origin browser requests. Defaults to ['*'] when HTTP is enabled without stored origins.

modified_at: string

formatdate-time

Indicates the name of the K2 stream.

maxLength128

minLength1

retention_seconds: number

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

maximum2592000

minimum3600

worker_binding: object { enabled } or object { enabled }

One of the following:

Enabled object { enabled }

enabled: false

Indicates whether Workers bindings can produce records to the stream.

Enabled object { enabled }

enabled: true

Indicates whether Workers bindings can produce records to the stream.

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

page: number

per_page: number

total_count: number

success: boolean

Indicates whether the API call was successful.

List K2 streams

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

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "id": "053e105f4ecef8ad9ca31a8372d0c353",
      "created_at": "2019-12-27T18:11:19.117Z",
      "endpoint": "https://053e105f4ecef8ad9ca31a8372d0c353.k2.cloudflarestorage.com",
      "http": {
        "enabled": true,
        "authentication": true,
        "cors": {
          "origins": [
            "string"
          ]
        }
      },
      "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

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "id": "053e105f4ecef8ad9ca31a8372d0c353",
      "created_at": "2019-12-27T18:11:19.117Z",
      "endpoint": "https://053e105f4ecef8ad9ca31a8372d0c353.k2.cloudflarestorage.com",
      "http": {
        "enabled": true,
        "authentication": true,
        "cors": {
          "origins": [
            "string"
          ]
        }
      },
      "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
}