--- title: Streams --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [K2](https://developers.cloudflare.com/api/typescript/resources/k2) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Streams ##### [List K2 streams](https://developers.cloudflare.com/api/typescript/resources/k2/subresources/streams/methods/list) client.k2.streams.list(StreamListParams {account\_id, name, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [StreamListResponse]() {id, created\_at, endpoint, 5 more } > GET/accounts/{account\_id}/k2/streams ##### [Get K2 stream](https://developers.cloudflare.com/api/typescript/resources/k2/subresources/streams/methods/get) client.k2.streams.get(stringstreamID, StreamGetParams {account\_id } params, RequestOptionsoptions?): [StreamGetResponse]() {id, created\_at, endpoint, 5 more } GET/accounts/{account\_id}/k2/streams/{stream\_id} ##### [Create K2 stream](https://developers.cloudflare.com/api/typescript/resources/k2/subresources/streams/methods/create) client.k2.streams.create(StreamCreateParams {account\_id, name, http, 2 more } params, RequestOptionsoptions?): [StreamCreateResponse]() {id, created\_at, endpoint, 5 more } POST/accounts/{account\_id}/k2/streams ##### [Update K2 stream](https://developers.cloudflare.com/api/typescript/resources/k2/subresources/streams/methods/update) client.k2.streams.update(stringstreamID, StreamUpdateParams {account\_id, http, retention\_seconds, worker\_binding } params, RequestOptionsoptions?): [StreamUpdateResponse]() {id, created\_at, endpoint, 5 more } PATCH/accounts/{account\_id}/k2/streams/{stream\_id} ##### [Delete K2 stream](https://developers.cloudflare.com/api/typescript/resources/k2/subresources/streams/methods/delete) client.k2.streams.delete(stringstreamID, StreamDeleteParams {account\_id } params, RequestOptionsoptions?): [StreamDeleteResponse]() DELETE/accounts/{account\_id}/k2/streams/{stream\_id} ##### ModelsExpand Collapse
StreamListResponse {id, created\_at, endpoint, 5 more } id: string Specifies the public ID of the K2 stream. maxLength32 minLength32 Link to this property created\_at: string formatdate-time Link to this property endpoint: string Indicates the base HTTP endpoint for producing and consuming records. formaturi Link to this property
http: HTTP {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. Link to this property authentication?: 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. Link to this property
cors?: CORS {origins } origins?: Array<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. Link to this property
Link to this property
Link to this property modified\_at: string formatdate-time Link to this property name: string Indicates the name of the K2 stream. maxLength128 minLength1 Link to this property retention\_seconds: number Shows the configured record retention period from 1 hour (3600 seconds) to 30 days (2592000 seconds), inclusive. maximum2592000 minimum3600 Link to this property
worker\_binding: WorkerBinding {enabled } enabled: boolean Indicates whether Workers bindings can produce records to the stream. Link to this property
Link to this property
[Link to this property](<#(resource)%20k2.streams%20%3E%20(model)%20stream_list_response%20%3E%20(schema)>)
StreamGetResponse {id, created\_at, endpoint, 5 more } id: string Specifies the public ID of the K2 stream. maxLength32 minLength32 Link to this property created\_at: string formatdate-time Link to this property endpoint: string Indicates the base HTTP endpoint for producing and consuming records. formaturi Link to this property
http: HTTP {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. Link to this property authentication?: 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. Link to this property
cors?: CORS {origins } origins?: Array<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. Link to this property
Link to this property
Link to this property modified\_at: string formatdate-time Link to this property name: string Indicates the name of the K2 stream. maxLength128 minLength1 Link to this property retention\_seconds: number Shows the configured record retention period from 1 hour (3600 seconds) to 30 days (2592000 seconds), inclusive. maximum2592000 minimum3600 Link to this property
worker\_binding: WorkerBinding {enabled } enabled: boolean Indicates whether Workers bindings can produce records to the stream. Link to this property
Link to this property
[Link to this property](<#(resource)%20k2.streams%20%3E%20(model)%20stream_get_response%20%3E%20(schema)>)
StreamCreateResponse {id, created\_at, endpoint, 5 more } id: string Specifies the public ID of the K2 stream. maxLength32 minLength32 Link to this property created\_at: string formatdate-time Link to this property endpoint: string Indicates the base HTTP endpoint for producing and consuming records. formaturi Link to this property
http: HTTP {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. Link to this property authentication?: 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. Link to this property
cors?: CORS {origins } origins?: Array<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. Link to this property
Link to this property
Link to this property modified\_at: string formatdate-time Link to this property name: string Indicates the name of the K2 stream. maxLength128 minLength1 Link to this property retention\_seconds: number Shows the configured record retention period from 1 hour (3600 seconds) to 30 days (2592000 seconds), inclusive. maximum2592000 minimum3600 Link to this property
worker\_binding: WorkerBinding {enabled } enabled: boolean Indicates whether Workers bindings can produce records to the stream. Link to this property
Link to this property
[Link to this property](<#(resource)%20k2.streams%20%3E%20(model)%20stream_create_response%20%3E%20(schema)>)
StreamUpdateResponse {id, created\_at, endpoint, 5 more } id: string Specifies the public ID of the K2 stream. maxLength32 minLength32 Link to this property created\_at: string formatdate-time Link to this property endpoint: string Indicates the base HTTP endpoint for producing and consuming records. formaturi Link to this property
http: HTTP {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. Link to this property authentication?: 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. Link to this property
cors?: CORS {origins } origins?: Array<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. Link to this property
Link to this property
Link to this property modified\_at: string formatdate-time Link to this property name: string Indicates the name of the K2 stream. maxLength128 minLength1 Link to this property retention\_seconds: number Shows the configured record retention period from 1 hour (3600 seconds) to 30 days (2592000 seconds), inclusive. maximum2592000 minimum3600 Link to this property
worker\_binding: WorkerBinding {enabled } enabled: boolean Indicates whether Workers bindings can produce records to the stream. Link to this property
Link to this property
[Link to this property](<#(resource)%20k2.streams%20%3E%20(model)%20stream_update_response%20%3E%20(schema)>) StreamDeleteResponse = unknown [Link to this property](<#(resource)%20k2.streams%20%3E%20(model)%20stream_delete_response%20%3E%20(schema)>) #### StreamsSubscriptions ##### [List subscriptions with consumer lag](https://developers.cloudflare.com/api/typescript/resources/k2/subresources/streams/subresources/subscriptions/methods/list) client.k2.streams.subscriptions.list(stringstreamID, SubscriptionListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [SubscriptionListResponse]() {id, created\_at, lag, 3 more } > GET/accounts/{account\_id}/k2/streams/{stream\_id}/subscriptions ##### ModelsExpand Collapse
SubscriptionListResponse {id, created\_at, lag, 3 more } id: string Link to this property created\_at: string formatdate-time Link to this property
lag: Lag {records, status } records: string| null Decimal-string distance from the subscription’s committed position to the observed exclusive stream tail, in records. Includes in-flight records and may include expired records or records acknowledged beyond an earlier gap. Null unless status is available. Link to this property
status: "available"| "unsupported"| "unavailable" Unsupported means the subscription or stream topology cannot be measured; unavailable means a required observation failed or was inconsistent. One of the following: "available" Link to this property "unsupported" Link to this property "unavailable" Link to this property
Link to this property
Link to this property modified\_at: string formatdate-time Link to this property name: string Link to this property
start\_at: StartAt {type }
type: "earliest"| "latest" One of the following: "earliest" Link to this property "latest" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20k2.streams.subscriptions%20%3E%20(model)%20subscription_list_response%20%3E%20(schema)>)