Sign in

v1

latestSwagger 2.0Event Store License v22026-07-17711075.0 KB
Subscriptions

Create a persistent subscription

Before interacting with a subscription group, you need to create one. You will receive an error if you attempt to create a subscription group more than once. This requires admin permissions.

put/subscriptions/{stream}/{subscription}

Path parameters

streamstring required

The stream the persistent subscription is on.

subscriptionstring required

The name of the subscription group.

Request body

ResolveLinkTosboolean

Whether to resolve link events.

startFrominteger

Which event position in the stream the subscription should start from.

extraStatisticsboolean

Whether to track latency statistics on this subscription.

checkPointAfterMillisecondsinteger

The amount of time to try to checkpoint after.

liveBufferSizeinteger

The size of the buffer (in-memory) listening to live messages as they happen before paging occurs.

readBatchSizeinteger

The number of events to read per batch when reading the history.

bufferSizeinteger

The number of events to cache when paging through history.

maxCheckPointCountinteger

The maximum number of messages not checkpointed before forcing a checkpoint.

maxRetryCountinteger

The maximum number of retries (due to timeout) before a message is considered to be parked.

maxSubscriberCountinteger

The maximum number of TCP subscribers allowed.

messageTimeoutMillisecondsinteger

The amount of time after which to consider a message as timedout and retried.

minCheckPointCountinteger

The minimum number of messages to write to a checkpoint.

namedConsumerStrategy'RoundRobin' | 'DispatchToSingle' | 'Pinned'

The strategy to use for distributing events to client consumers.

Example request

{
  "minCheckPointCount": 2,
  "startFrom": 0,
  "ResolveLinkTos": true,
  "readBatchSize": 5,
  "namedConsumerStrategy": "RoundRobin",
  "extraStatistics": true,
  "maxRetryCount": 7,
  "liveBufferSize": 1,
  "messageTimeoutMilliseconds": 3,
  "maxCheckPointCount": 2,
  "maxSubscriberCount": 9,
  "checkPointAfterMilliseconds": 6,
  "bufferSize": 5
}

Response

Subscription created