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 Projections API

Create, manage and query projections

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

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

This API exposes 22 operations across 16 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}.

22 operations 16 paths 1 schemas 1 DELETE11 GET8 POST2 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 Projections 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 22

Across 16 paths, the API surfaces 22 operations — 1 DELETE, 11 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Projections 22

Create, manage and query projections

GET
/projections/any
List all projections
listAllProjections → 200401
GET
/projections/all-non-transient
List all non-transient projections
listNonTransientProjections → 200401
GET
/projections/transient
List all transient projections
listTransientProjections → 200401
POST
/projections/transient
Create a transient projection
createTransientProjection 1 param body → 201400401
GET
/projections/onetime
List all one-time projections (queries)
listOneTimeProjections → 200401
POST
/projections/onetime
Create a one-time projection
createOneTimeProjection body → 201400401
GET
/projections/continuous
List all continuous projections
listContinuousProjections → 200401
POST
/projections/continuous
Create a continuous projection
createContinuousProjection 2 params body → 201400401
POST
/projections/read-events
Query the events of a projection
readProjectionEvents body → 200400401
GET
/projection/{name}
Get the details of a projection
getProjection 1 param → 200401404
DELETE
/projection/{name}
Delete a projection
deleteProjection 1 param → 204401404
GET
/projection/{name}/query
Get the definition of a projection
getProjectionQuery 1 param → 200401404
PUT
/projection/{name}/query
Update the definition of a projection
updateProjectionQuery 1 param body → 200400401
GET
/projection/{name}/state
Get the state of a projection
getProjectionState 2 params → 200401404
GET
/projection/{name}/result
Get the result of a projection
getProjectionResult 2 params → 200401404
GET
/projection/{name}/statistics
Get the statistics of a projection
getProjectionStatistics 1 param → 200401404
GET
/projection/{name}/config
Get the configuration of a projection
getProjectionConfig 1 param → 200401404
PUT
/projection/{name}/config
Update the configuration of a projection
updateProjectionConfig 1 param body → 200400401
POST
/projection/{name}/command/enable
Enable a projection
enableProjection 1 param → 200401404
POST
/projection/{name}/command/disable
Disable a projection
disableProjection 1 param → 200401404
POST
/projection/{name}/command/reset
Reset a projection
resetProjection 1 param → 200401404
POST
/projection/{name}/command/abort
Abort a projection
abortProjection 1 param → 200401404

Schemas 1

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

ProjectionConfig
object
Runtime configuration of a projection
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kurrent-projections-api-openapi.yml Raw ↑

Other APIs Kurrent publishes across the network.

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