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

Create, update, retrieve, and manage search indexes

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

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

This API exposes 8 operations across 5 paths, and defines 11 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.

8 operations 5 paths 11 schemas 1 DELETE4 GET1 POST2 PUT

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 8

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

Indexes 8

Create, update, retrieve, and manage search indexes

GET
/indexes
List all indexes
listIndexes → 200500
POST
/indexes
Create an index
createIndex body → 200400409500
GET
/indexes/{index_id}
Get index metadata
getIndex 1 param → 200404500
PUT
/indexes/{index_id}
Update an index
updateIndex 2 params body → 200400404500
DELETE
/indexes/{index_id}
Delete an index
deleteIndex 1 param → 200404500
GET
/indexes/{index_id}/describe
Describe an index
describeIndex 1 param → 200404500
PUT
/indexes/{index_id}/clear
Clear an index
clearIndex 1 param → 200404500
GET
/indexes/{index_id}/splits
List splits
listSplits 7 params → 200404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are IndexDescription (9 properties), SplitMetadata (7 properties), IndexConfig (7 properties), SourceConfig (6 properties). Each schema is shown below with its type and property counts.

IndexMetadata
object
6 properties
IndexDescription
object
9 properties
IndexConfig
object
7 properties 3 required
RetentionPolicy
object
2 properties
SplitList
object
3 properties
SearchSettings
object
1 property
IndexingSettings
object
4 properties
SourceConfig
object
6 properties 4 required
ApiError
object
1 property 1 required
DocMapping
object
5 properties
SplitMetadata
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quickwit-indexes-api-openapi.yml Raw ↑

Other APIs Quickwit publishes across the network.

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