--- title: K2 --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) 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/resources/k2/subresources/streams/methods/list) GET/accounts/{account\_id}/k2/streams ##### [Get K2 stream](https://developers.cloudflare.com/api/resources/k2/subresources/streams/methods/get) GET/accounts/{account\_id}/k2/streams/{stream\_id} ##### [Create K2 stream](https://developers.cloudflare.com/api/resources/k2/subresources/streams/methods/create) POST/accounts/{account\_id}/k2/streams ##### [Update K2 stream](https://developers.cloudflare.com/api/resources/k2/subresources/streams/methods/update) PATCH/accounts/{account\_id}/k2/streams/{stream\_id} ##### [Delete K2 stream](https://developers.cloudflare.com/api/resources/k2/subresources/streams/methods/delete) DELETE/accounts/{account\_id}/k2/streams/{stream\_id} ##### ModelsExpand Collapse

StreamListResponse object {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: 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. Link to this property 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. Link to this property

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. 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: object {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 object {id, created\_at, endpoint, 5 more }

http: object {enabled, authentication, cors } Configures the HTTP endpoint. Disabling HTTP keeps authentication and cors, so enabling it again restores them.

cors: optional object {origins }

Link to this property

worker\_binding: object {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 object {id, created\_at, endpoint, 5 more }

http: object {enabled, authentication, cors } Configures the HTTP endpoint. Disabling HTTP keeps authentication and cors, so enabling it again restores them.

cors: optional object {origins }

Link to this property

worker\_binding: object {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 object {id, created\_at, endpoint, 5 more }

http: object {enabled, authentication, cors } Configures the HTTP endpoint. Disabling HTTP keeps authentication and cors, so enabling it again restores them.

cors: optional object {origins }

Link to this property

worker\_binding: object {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)>) #### K2StreamsSubscriptions ##### [List subscriptions with consumer lag](https://developers.cloudflare.com/api/resources/k2/subresources/streams/subresources/subscriptions/methods/list) GET/accounts/{account\_id}/k2/streams/{stream\_id}/subscriptions ##### ModelsExpand Collapse

SubscriptionListResponse object {id, created\_at, lag, 3 more }

id: string Link to this property created\_at: string formatdate-time Link to this property

lag: object {records, status }

records: string 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"or "unsupported"or "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: object {type }

type: "earliest"or "latest"

One of the following: "earliest" Link to this property "latest" 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 ##### [Produce records](https://developers.cloudflare.com/api/resources/k2/subresources/data/methods/produce) POST/produce ##### ModelsExpand Collapse

DataProduceResponse object {success }

success: true Link to this property

[Link to this property](<#(resource)%20k2.data%20%3E%20(model)%20data_produce_response%20%3E%20(schema)>) #### K2DataSubscriptions ##### [List subscriptions](https://developers.cloudflare.com/api/resources/k2/subresources/data/subresources/subscriptions/methods/list) GET/subscriptions ##### [Create subscription](https://developers.cloudflare.com/api/resources/k2/subresources/data/subresources/subscriptions/methods/create) POST/subscriptions ##### [Get subscription](https://developers.cloudflare.com/api/resources/k2/subresources/data/subresources/subscriptions/methods/get) GET/subscriptions/{subscription\_id} ##### [Delete subscription](https://developers.cloudflare.com/api/resources/k2/subresources/data/subresources/subscriptions/methods/delete) DELETE/subscriptions/{subscription\_id} ##### [Consume records](https://developers.cloudflare.com/api/resources/k2/subresources/data/subresources/subscriptions/methods/consume) POST/subscriptions/{subscription\_id}/consume ##### ModelsExpand Collapse

SubscriptionListResponse object {id, created\_at, modified\_at, 2 more }

id: string Specifies the ID of the subscription. Link to this property created\_at: string formatdate-time Link to this property modified\_at: string formatdate-time Link to this property name: string Link to this property

start\_at: object {type }

type: "earliest"or "latest"

One of the following: "earliest" Link to this property "latest" Link to this property

Link to this property

[Link to this property](<#(resource)%20k2.data.subscriptions%20%3E%20(model)%20subscription_list_response%20%3E%20(schema)>)

SubscriptionCreateResponse object {id }

id: string Specifies the ID of the subscription. Link to this property

[Link to this property](<#(resource)%20k2.data.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)>)

SubscriptionGetResponse object {id, created\_at, modified\_at, 2 more }

start\_at: object {type }

type: "earliest"or "latest"

One of the following: "earliest" Link to this property "latest" Link to this property

Link to this property

[Link to this property](<#(resource)%20k2.data.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)>)

SubscriptionDeleteResponse object {id }

id: string Specifies the ID of the subscription. Link to this property

[Link to this property](<#(resource)%20k2.data.subscriptions%20%3E%20(model)%20subscription_delete_response%20%3E%20(schema)>)

SubscriptionConsumeResponse object {batch\_id, leased\_until\_ms, records }

batch\_id: string Identifies the delivered batch for ACK, NACK, and extend. Null when the response contains no records. Link to this property leased\_until\_ms: number Shows when the lease on the batch expires, in epoch milliseconds. ACK or NACK the batch before then. Null when the response contains no records. Link to this property

records: array of object {content, timestamp\_ms, headers }

content: string The record payload, encoded as standard base64. formatbyte Link to this property timestamp\_ms: number Shows when K2 received the record, in epoch milliseconds. Link to this property headers: optional map\[string] Lists the metadata the producer attached to the record. Omitted when the record carries none. Link to this property

Link to this property

[Link to this property](<#(resource)%20k2.data.subscriptions%20%3E%20(model)%20subscription_consume_response%20%3E%20(schema)>) #### K2DataSubscriptionsBatches ##### [Acknowledge batch](https://developers.cloudflare.com/api/resources/k2/subresources/data/subresources/subscriptions/subresources/batches/methods/ack) POST/subscriptions/{subscription\_id}/batches/{batch\_id}/ack ##### [Release batch](https://developers.cloudflare.com/api/resources/k2/subresources/data/subresources/subscriptions/subresources/batches/methods/nack) POST/subscriptions/{subscription\_id}/batches/{batch\_id}/nack ##### [Extend batch lease](https://developers.cloudflare.com/api/resources/k2/subresources/data/subresources/subscriptions/subresources/batches/methods/extend) POST/subscriptions/{subscription\_id}/batches/{batch\_id}/extend ##### ModelsExpand Collapse BatchAckResponse = unknown [Link to this property](<#(resource)%20k2.data.subscriptions.batches%20%3E%20(model)%20batch_ack_response%20%3E%20(schema)>) BatchNackResponse = unknown [Link to this property](<#(resource)%20k2.data.subscriptions.batches%20%3E%20(model)%20batch_nack_response%20%3E%20(schema)>)

BatchExtendResponse object {leased\_until\_ms }

leased\_until\_ms: number Shows the new lease expiry, in epoch milliseconds. Link to this property

[Link to this property](<#(resource)%20k2.data.subscriptions.batches%20%3E%20(model)%20batch_extend_response%20%3E%20(schema)>)