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

Node administration operations

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

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

This API exposes 5 operations across 5 paths. It is described by OpenAPI 3.1.0, at version v26.1.

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

5 operations 5 paths 0 schemas 1 DELETE4 POST

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 Admin 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 5

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

Admin 5

Node administration operations

POST
/admin/shutdown
Shut down the node
shutdownNode → 200401
POST
/admin/node/resign
Resign leadership of the node
resignNode → 200401
POST
/admin/scavenge
Start a scavenge operation
startScavenge 2 params → 200401
DELETE
/admin/scavenge/{scavengeId}
Stop a running scavenge operation
stopScavenge 1 param → 200401
POST
/admin/mergeindexes
Merge the node indexes
mergeIndexes → 200401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kurrent-admin-api-openapi.yml Raw ↑

Other APIs Kurrent publishes across the network.

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