Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kurrent Subscriptions API

Persistent (competing consumer) subscription management and consumption

Kurrent Subscriptions API is one of 9 APIs that Kurrent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 13 operations across 10 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version v26.1.

Requests are made against a single base URL, https://{host}:{port}.

13 operations 10 paths 1 schemas 1 DELETE5 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v26.1
Base URL
https://docs.kurrent.io/server/v26.1/http-api/api.html
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Kurrent Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — KurrentDB supports HTTP Basic authentication for the HTTP API, with access control lists (ACLs) applied per stream. See https://docs.kurrent.io/server/v26.1/ht…

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 5 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 13

Persistent (competing consumer) subscription management and consumption

GET
/subscriptions
List all persistent subscriptions
listSubscriptions → 200401
GET
/subscriptions/{stream}
List the persistent subscriptions on a stream
listSubscriptionsForStream 1 param → 200401
GET
/subscriptions/{stream}/{subscription}
Read events from a persistent subscription
readSubscription 2 params → 200401
PUT
/subscriptions/{stream}/{subscription}
Create a persistent subscription
createSubscription 2 params body → 201400401
POST
/subscriptions/{stream}/{subscription}
Update a persistent subscription
updateSubscription 2 params body → 200400401
DELETE
/subscriptions/{stream}/{subscription}
Delete a persistent subscription
deleteSubscription 2 params → 200401
GET
/subscriptions/{stream}/{subscription}/info
Get details of a persistent subscription
getSubscriptionInfo 2 params → 200401
GET
/subscriptions/{stream}/{subscription}/{count}
Read a number of events from a persistent subscription
readSubscriptionEvents 3 params → 200401
POST
/subscriptions/{stream}/{subscription}/ack
Acknowledge a set of messages
ackMessages 3 params → 200401
POST
/subscriptions/{stream}/{subscription}/ack/{messageid}
Acknowledge a single message
ackMessage 3 params → 200401
POST
/subscriptions/{stream}/{subscription}/nack
Negatively acknowledge a set of messages
nackMessages 4 params → 200401
POST
/subscriptions/{stream}/{subscription}/nack/{messageid}
Negatively acknowledge a single message
nackMessage 4 params → 200401
POST
/subscriptions/{stream}/{subscription}/replayParked
Replay the parked messages of a persistent subscription
replayParkedMessages 2 params → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is PersistentSubscriptionSettings (13 properties). Each schema is shown below with its type and property counts.

PersistentSubscriptionSettings
object
Settings of a persistent (competing consumer) subscription
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kurrent-subscriptions-api-openapi.yml Raw ↑

Other APIs Kurrent publishes across the network.

KurrentDB gRPC API
Kurrent Admin API
Kurrent Gossip API
Kurrent Info API
Kurrent Projections API
Kurrent Statistics API
Kurrent Streams API
Kurrent Users API