Streams

Clear subscription's backlog

Clear stream backlogs for a specified subscription.

post/_fabric/{fabric}/_api/streams/clearbacklog/{subscription}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/streams/clearbacklog/:subscription/post.ts
A function with typed inputs. Its response is checked against the schema.

fabricstring string required

Fabric name of the streams.

subscriptionstring string required

Subscription name

globalboolean required

Whether the stream is geo-replicated globally.

Successfully cleared backlog for specified subscription.

errorboolean

Flag if there is an error in response. False for this response.

codeinteger

The generated response code.

resultstring

{
  "code": 200
}

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