v7

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-07-07355390.1 KB
subscription

Create subscription

Creates a new subscription that connects an event source (e.g., a Kafka topic) to a Restate service handler. For more information, see the subscription documentation.

post/subscriptions

Request body

optionsobject nullable

Options

Additional options to apply to the subscription.

sinkstring uri required

Sink

Sink uri. Accepted forms:

  • service://<service_name>/<service_name>, e.g. service://Counter/count
sourcestring uri required

Source

Source uri. Accepted forms:

  • kafka://<cluster_name>/<topic_name>, e.g. kafka://my-cluster/my-topic

Response

Subscription created successfully

idstring required
optionsobject required
sinkstring required
sourcestring required