Update an existing stream by id.

Requires permission matching: stream:write:default.<name>.

patch/streams/{id}

Request

Base URL
https://replace-with-account.api.decodable.co/v1alpha2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://auth.decodable.co/authorize?audience=https://api.decodable.co/
  Token URLhttps://auth.decodable.co/oauth/token
  Scopeswrite:stream
TypeScript
https://skmtc.dev/decodable/apis/decodable-control-plane/docs/streams/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

response_schema_v'v1' | 'v2'

The response schema version to use. Defaults to v1. When v1, the response will include the schema field. When v2, the response will include the schema_v2 field.

Request body

namestring

The stream name.

descriptionstring

The stream description.

watermarkstring

The stream watermark strategy.

propertiesobject

The stream properties.

partition_keystring[]

The fields to use to partition data in the stream

Response

A stream update response.

Example response

{
  "id": "abcd1234"
}

Changes

No recorded changes to this operation across all 1 revision of this API.