--- title: K2 --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # K2 #### K2Streams ##### [List K2 streams](https://developers.cloudflare.com/api/python/resources/k2/subresources/streams/methods/list) k2.streams.list(StreamListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[StreamListResponse]()] GET/accounts/{account\_id}/k2/streams ##### [Get K2 stream](https://developers.cloudflare.com/api/python/resources/k2/subresources/streams/methods/get) k2.streams.get(strstream\_id, StreamGetParams\*\*kwargs) -> [StreamGetResponse]() GET/accounts/{account\_id}/k2/streams/{stream\_id} ##### [Create K2 stream](https://developers.cloudflare.com/api/python/resources/k2/subresources/streams/methods/create) k2.streams.create(StreamCreateParams\*\*kwargs) -> [StreamCreateResponse]() POST/accounts/{account\_id}/k2/streams ##### [Update K2 stream](https://developers.cloudflare.com/api/python/resources/k2/subresources/streams/methods/update) k2.streams.update(strstream\_id, StreamUpdateParams\*\*kwargs) -> [StreamUpdateResponse]() PATCH/accounts/{account\_id}/k2/streams/{stream\_id} ##### [Delete K2 stream](https://developers.cloudflare.com/api/python/resources/k2/subresources/streams/methods/delete) k2.streams.delete(strstream\_id, StreamDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/k2/streams/{stream\_id} ##### ModelsExpand Collapse
class StreamListResponse: … id: str Specifies the public ID of the K2 stream. maxLength32 minLength32 Link to this property created\_at: datetime formatdate-time Link to this property endpoint: str Indicates the base HTTP endpoint for producing and consuming records. formaturi Link to this property
http: HTTP Configures the HTTP endpoint. Disabling HTTP keeps authentication and cors, so enabling it again restores them. enabled: bool Indicates whether the HTTP endpoint accepts records. Link to this property authentication: Optional\[bool] 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: Optional\[HTTPCORS] origins: Optional\[List\[str]] 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: datetime formatdate-time Link to this property name: str Indicates the name of the K2 stream. maxLength128 minLength1 Link to this property retention\_seconds: int 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: bool 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)>)
class StreamGetResponse: … id: str Specifies the public ID of the K2 stream. maxLength32 minLength32 Link to this property created\_at: datetime formatdate-time Link to this property endpoint: str Indicates the base HTTP endpoint for producing and consuming records. formaturi Link to this property
http: HTTP Configures the HTTP endpoint. Disabling HTTP keeps authentication and cors, so enabling it again restores them. enabled: bool Indicates whether the HTTP endpoint accepts records. Link to this property authentication: Optional\[bool] 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: Optional\[HTTPCORS] origins: Optional\[List\[str]] 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: datetime formatdate-time Link to this property name: str Indicates the name of the K2 stream. maxLength128 minLength1 Link to this property retention\_seconds: int 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: bool 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)>)
class StreamCreateResponse: … id: str Specifies the public ID of the K2 stream. maxLength32 minLength32 Link to this property created\_at: datetime formatdate-time Link to this property endpoint: str Indicates the base HTTP endpoint for producing and consuming records. formaturi Link to this property
http: HTTP Configures the HTTP endpoint. Disabling HTTP keeps authentication and cors, so enabling it again restores them. enabled: bool Indicates whether the HTTP endpoint accepts records. Link to this property authentication: Optional\[bool] 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: Optional\[HTTPCORS] origins: Optional\[List\[str]] 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: datetime formatdate-time Link to this property name: str Indicates the name of the K2 stream. maxLength128 minLength1 Link to this property retention\_seconds: int 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: bool 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)>)
class StreamUpdateResponse: … id: str Specifies the public ID of the K2 stream. maxLength32 minLength32 Link to this property created\_at: datetime formatdate-time Link to this property endpoint: str Indicates the base HTTP endpoint for producing and consuming records. formaturi Link to this property
http: HTTP Configures the HTTP endpoint. Disabling HTTP keeps authentication and cors, so enabling it again restores them. enabled: bool Indicates whether the HTTP endpoint accepts records. Link to this property authentication: Optional\[bool] 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: Optional\[HTTPCORS] origins: Optional\[List\[str]] 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: datetime formatdate-time Link to this property name: str Indicates the name of the K2 stream. maxLength128 minLength1 Link to this property retention\_seconds: int 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: bool 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)>) #### K2StreamsSubscriptions ##### [List subscriptions with consumer lag](https://developers.cloudflare.com/api/python/resources/k2/subresources/streams/subresources/subscriptions/methods/list) k2.streams.subscriptions.list(strstream\_id, SubscriptionListParams\*\*kwargs) -> SyncSinglePage\[[SubscriptionListResponse]()] GET/accounts/{account\_id}/k2/streams/{stream\_id}/subscriptions ##### ModelsExpand Collapse
class SubscriptionListResponse: … id: str Link to this property created\_at: datetime formatdate-time Link to this property
lag: Lag records: Optional\[str] 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: Literal\["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: datetime formatdate-time Link to this property name: str Link to this property
start\_at: StartAt
type: Literal\["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)>) #### K2Data #### K2DataSubscriptions #### K2DataSubscriptionsBatches