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

Configure data sources such as Kafka, Kinesis, and Pulsar

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

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

This API exposes 5 operations across 4 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.

5 operations 4 paths 2 schemas 1 DELETE1 POST3 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 5

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

Sources 5

Configure data sources such as Kafka, Kinesis, and Pulsar

POST
/indexes/{index_id}/sources
Create a source
createSource 1 param body → 200400404500
PUT
/indexes/{index_id}/sources/{source_id}
Update a source
updateSource 2 params body → 200400404500
DELETE
/indexes/{index_id}/sources/{source_id}
Delete a source
deleteSource 2 params → 200404500
PUT
/indexes/{index_id}/sources/{source_id}/toggle
Toggle a source
toggleSource 2 params body → 200404500
PUT
/indexes/{index_id}/sources/{source_id}/reset-checkpoint
Reset source checkpoint
resetSourceCheckpoint 2 params → 200404500

Schemas 2

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

SourceConfig
object
6 properties 4 required
ApiError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quickwit-sources-api-openapi.yml Raw ↑

Other APIs Quickwit publishes across the network.

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