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 Index Templates API

Manage index templates for automatic index creation

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

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

This API exposes 5 operations across 2 paths, and defines 6 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 2 paths 6 schemas 1 DELETE2 GET1 POST1 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Index Templates 5

Manage index templates for automatic index creation

GET
/templates
List index templates
listIndexTemplates → 200500
POST
/templates
Create an index template
createIndexTemplate body → 200400500
GET
/templates/{template_id}
Get an index template
getIndexTemplate 1 param → 200404500
PUT
/templates/{template_id}
Update an index template
updateIndexTemplate 1 param body → 200400404500
DELETE
/templates/{template_id}
Delete an index template
deleteIndexTemplate 1 param → 200404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are IndexTemplate (9 properties), DocMapping (5 properties), IndexingSettings (4 properties), RetentionPolicy (2 properties). Each schema is shown below with its type and property counts.

IndexTemplate
object
9 properties 3 required
RetentionPolicy
object
2 properties
SearchSettings
object
1 property
IndexingSettings
object
4 properties
ApiError
object
1 property 1 required
DocMapping
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quickwit-index-templates-api-openapi.yml Raw ↑

Other APIs Quickwit publishes across the network.

Quickwit Cluster API
Quickwit Delete Tasks API
Quickwit Indexes API
Quickwit Ingest API
Quickwit Search API
Quickwit Sources API