How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ZincSearch Index API

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

ZincSearch Index API is one of 8 APIs that ZincSearch publishes on the 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.

This API exposes 23 operations across 14 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: /, http://localhost:4080/.

23 operations 14 paths 18 schemas 2 DELETE9 GET2 HEAD6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
http://localhost:4080
Authentication
HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 1

ZincSearch Index API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 23

Across 14 paths, the API surfaces 23 operations — 2 DELETE, 9 GET, 2 HEAD, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Index 23
POST
/api/_analyze
Analyze
Analyze body → 200400
GET
/api/index
List indexes
ListIndexes 5 params → 200
POST
/api/index
Create index
CreateIndex body → 200400
GET
/api/index/{index}
Get index metadata
GetIndex 1 param → 200404
DELETE
/api/index/{index}
Delete index
DeleteIndex 1 param → 200400500
HEAD
/api/index/{index}
Checks if the index exists
Exists 1 param → 200404
POST
/api/index/{index}/refresh
Resfresh index
Refresh 1 param → 200400
GET
/api/index_name
List index Name
IndexNameList 1 param → 200
POST
/api/{index}/_analyze
Analyze
AnalyzeIndex 1 param body → 200400
GET
/api/{index}/_mapping
Get index mappings
GetMapping 1 param → 200400
PUT
/api/{index}/_mapping
Set index mappings
SetMapping 1 param body → 200400500
GET
/api/{index}/_settings
Get index settings
GetSettings 1 param → 200400
PUT
/api/{index}/_settings
Set index Settings
SetSettings 1 param body → 200400500
POST
/es/_aliases
Add or remove index alias for compatible ES
AddOrRemoveESAlias → 200400
GET
/es/_index_template
List index teplates
ListTemplates → 200400
POST
/es/_index_template
Create update index template
CreateTemplate body → 200400
GET
/es/_index_template/{name}
Get index template
GetTemplate 1 param → 200400
PUT
/es/_index_template/{name}
Create update index template
UpdateTemplate 1 param body → 200400
DELETE
/es/_index_template/{name}
Delete template
DeleteTemplate 1 param → 200400
PUT
/es/{index}
Create index for compatible ES
ESCreateIndex 1 param body → 200400
HEAD
/es/{index}
Checks if the index exists for compatible ES
EsExists 1 param → 200404
GET
/es/{index}/_mapping
Get index mappings for compatible ES
ESGetMapping 1 param → 200400
GET
/es/{target}/_alias/{target_alias}
Get index alias for compatible ES
GetESAliases 2 params → 200400

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are meta.Property (12 properties), meta.Analyzer (8 properties), index.AnalyzeResponseToken (6 properties), meta.IndexSimple (5 properties). Each schema is shown below with its type and property counts.

meta.Analyzer
object
8 properties
meta.Property
object
12 properties
meta.IndexSimple
object
5 properties
meta.HTTPResponse
object
1 property
index.IndexListResponse
object
2 properties
meta.HTTPResponseIndex
object
3 properties
index.AnalyzeResponseToken
object
6 properties
meta.Page
object
3 properties
meta.TemplateTemplate
object
2 properties
core.Index
object
meta.IndexSettings
object
3 properties
meta.IndexAnalysis
object
5 properties
meta.IndexTemplate
object
5 properties
meta.HTTPResponseTemplate
object
2 properties
meta.HTTPResponseError
object
1 property
meta.Mappings
object
1 property
meta.Template
object
2 properties
index.AnalyzeResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zincsearch-index-api-openapi.yml Raw ↑

Other APIs ZincSearch publishes across the network.

ZincSearch Document API
ZincSearch Healthz API
ZincSearch Permission API
ZincSearch Role API
ZincSearch Search API
ZincSearch User API
ZincSearch Version API
Where this information came from

This is an independent, third-party profile of ZincSearch Index API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.