Update K2 stream

client.K2.Streams.Update(ctx, streamID, params) (*StreamUpdateResponse, error)

PATCH/accounts/{account_id}/k2/streams/{stream_id}

Update a K2 stream. Omitted http settings, such as authentication and cors, keep their current values while HTTP stays enabled. Disabling HTTP clears its settings. At least one input must remain enabled.

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

streamID string

Specifies the public ID of the K2 stream.

maxLength32

minLength32

params StreamUpdateParams

AccountID param.Field[string]

Path param: Specifies the public ID of the account.

maxLength32

minLength32

HTTP param.Field[StreamUpdateParamsHTTP]Optional

Body param

type StreamUpdateParamsHTTPEnabled struct{…}

Enabled StreamUpdateParamsHTTPEnabledEnabled

Indicates whether the HTTP endpoint accepts records.

type StreamUpdateParamsHTTPObject struct{…}

Enabled StreamUpdateParamsHTTPObjectEnabled

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 StreamUpdateParamsHTTPObjectCORSOptional

Origins StreamUpdateParamsHTTPObjectCORSOriginsUnionOptional

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

One of the following:

type StreamUpdateParamsHTTPObjectCORSOriginsArray []StreamUpdateParamsHTTPObjectCORSOriginsArray

type StreamUpdateParamsHTTPObjectCORSOriginsArray []string

RetentionSeconds param.Field[int64]Optional

Body param: Sets the record retention period from 1 hour (3600 seconds) to 30 days (2592000 seconds), inclusive.

maximum2592000

minimum3600

WorkerBinding param.Field[StreamUpdateParamsWorkerBinding]Optional

Body param

type StreamUpdateParamsWorkerBindingEnabled struct{…}

Enabled StreamUpdateParamsWorkerBindingEnabledEnabled

Indicates whether Workers bindings can produce records to the stream.

type StreamUpdateParamsWorkerBindingEnabled struct{…}

Enabled StreamUpdateParamsWorkerBindingEnabledEnabled

Indicates whether Workers bindings can produce records to the stream.

ReturnsExpand Collapse

type StreamUpdateResponse 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 StreamUpdateResponseHTTP

One of the following:

type StreamUpdateResponseHTTPEnabled struct{…}

Enabled StreamUpdateResponseHTTPEnabledEnabled

Indicates whether the HTTP endpoint accepts records.

type StreamUpdateResponseHTTPObject struct{…}

Enabled StreamUpdateResponseHTTPObjectEnabled

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 StreamUpdateResponseHTTPObjectCORSOptional

Origins StreamUpdateResponseHTTPObjectCORSOriginsUnionOptional

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

One of the following:

type StreamUpdateResponseHTTPObjectCORSOriginsArray []StreamUpdateResponseHTTPObjectCORSOriginsArrayItem

type StreamUpdateResponseHTTPObjectCORSOriginsArray []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 StreamUpdateResponseWorkerBinding

One of the following:

type StreamUpdateResponseWorkerBindingEnabled struct{…}

Enabled StreamUpdateResponseWorkerBindingEnabledEnabled

Indicates whether Workers bindings can produce records to the stream.

type StreamUpdateResponseWorkerBindingEnabled struct{…}

Enabled StreamUpdateResponseWorkerBindingEnabledEnabled

Indicates whether Workers bindings can produce records to the stream.

Update K2 stream

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"),
  )
  stream, err := client.K2.Streams.Update(
    context.TODO(),
    "053e105f4ecef8ad9ca31a8372d0c353",
    k2.StreamUpdateParams{
      AccountID: cloudflare.F("0123105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", stream.ID)
}

{
  "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
    }
  },
  "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
    }
  },
  "success": true
}