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

Quickwit Cluster API

Monitor cluster state and node health

Quickwit Cluster API is one of 7 APIs that Quickwit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 0.8.2.

Requests are made against a single base URL, http://localhost:7280/api/v1.

3 operations 3 paths 2 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.8.2
Base URL
https://your-quickwit-node/api/v1
License
Resource Areas
1

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Cluster 3

Monitor cluster state and node health

GET
/health/livez
Liveness check
livenessCheck → 200
GET
/health/readyz
Readiness check
readinessCheck → 200
GET
/cluster
Get cluster state
getCluster 1 param → 200500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ClusterState (4 properties), ApiError (1 property). Each schema is shown below with its type and property counts.

ClusterState
object
4 properties
ApiError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quickwit-cluster-api-openapi.yml Raw ↑

Other APIs Quickwit publishes across the network.

Quickwit Delete Tasks API
Quickwit Index Templates API
Quickwit Indexes API
Quickwit Ingest API
Quickwit Search API
Quickwit Sources API