# ZincSearch Index API

**Canonical:** https://apis.io/apis/zincsearch/zincsearch-index-api/  
**Provider:** ZincSearch — https://apis.io/providers/zincsearch/  
**Base URL:** http://localhost:4080  
**Documentation:** https://zincsearch-docs.zinc.dev/api/

ZincSearch Index API is one of 8 APIs that [ZincSearch](https://apis.io/providers/zincsearch/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Index. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 6 JSON Schemas.

The Index API from ZincSearch — 14 operation(s) for index.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/_analyze` | Analyze |
| GET | `/api/index` | List indexes |
| POST | `/api/index` | Create index |
| GET | `/api/index/{index}` | Get index metadata |
| DELETE | `/api/index/{index}` | Delete index |
| HEAD | `/api/index/{index}` | Checks if the index exists |
| POST | `/api/index/{index}/refresh` | Resfresh index |
| GET | `/api/index_name` | List index Name |
| POST | `/api/{index}/_analyze` | Analyze |
| GET | `/api/{index}/_mapping` | Get index mappings |
| PUT | `/api/{index}/_mapping` | Set index mappings |
| GET | `/api/{index}/_settings` | Get index settings |
| PUT | `/api/{index}/_settings` | Set index Settings |
| POST | `/es/_aliases` | Add or remove index alias for compatible ES |
| GET | `/es/_index_template` | List index teplates |
| POST | `/es/_index_template` | Create update index template |
| GET | `/es/_index_template/{name}` | Get index template |
| PUT | `/es/_index_template/{name}` | Create update index template |
| DELETE | `/es/_index_template/{name}` | Delete template |
| PUT | `/es/{index}` | Create index for compatible ES |
| HEAD | `/es/{index}` | Checks if the index exists for compatible ES |
| GET | `/es/{index}/_mapping` | Get index mappings for compatible ES |
| GET | `/es/{target}/_alias/{target_alias}` | Get index alias for compatible ES |

## Machine-readable artifacts (9)

- **OpenAPI** — https://artifacts.apis.io/zincsearch/openapi/zincsearch-index-api-openapi.yml
- **Documentation** — https://zincsearch-docs.zinc.dev/
- **APIReference** — https://zincsearch-docs.zinc.dev/api/
- **JSONSchema** — https://artifacts.apis.io/zincsearch/json-schema/zincsearch-meta-index-template-schema.json
- **JSONSchema** — https://artifacts.apis.io/zincsearch/json-schema/zincsearch-meta-index-simple-schema.json
- **JSONSchema** — https://artifacts.apis.io/zincsearch/json-schema/zincsearch-meta-index-settings-schema.json
- **JSONSchema** — https://artifacts.apis.io/zincsearch/json-schema/zincsearch-index-index-list-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/zincsearch/json-schema/zincsearch-meta-mappings-schema.json
- **JSONSchema** — https://artifacts.apis.io/zincsearch/json-schema/zincsearch-index-analyze-response-schema.json

## Other ZincSearch APIs (7)

- [ZincSearch Document API](https://apis.io/apis/zincsearch/zincsearch-document-api/)
- [ZincSearch Healthz API](https://apis.io/apis/zincsearch/zincsearch-healthz-api/)
- [ZincSearch Permission API](https://apis.io/apis/zincsearch/zincsearch-permission-api/)
- [ZincSearch Role API](https://apis.io/apis/zincsearch/zincsearch-role-api/)
- [ZincSearch Search API](https://apis.io/apis/zincsearch/zincsearch-search-api/)
- [ZincSearch User API](https://apis.io/apis/zincsearch/zincsearch-user-api/)
- [ZincSearch Version API](https://apis.io/apis/zincsearch/zincsearch-version-api/)

## Tags

Index

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/zincsearch/zincsearch-index-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/zincsearch/.