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

The Document API from ZincSearch — 7 operation(s) for document.

ZincSearch Document API is one of 8 APIs that ZincSearch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 5 JSON Schemas.

This API exposes 9 operations across 7 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

9 operations 7 paths 6 schemas 1 DELETE1 GET6 POST1 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 Document API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 1 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Document 9
POST
/api/_bulk
Bulk documents
Bulk body → 200500
POST
/api/_bulkv2
Bulkv2 documents
Bulkv2 body → 200400500
POST
/api/{index}/_doc
Create or update document
IndexDocument 1 param body → 200400500
GET
/api/{index}/_doc/{id}
get document with id
GetDocument 2 params → 200400500
PUT
/api/{index}/_doc/{id}
Create or update document with id
IndexDocumentWithID 2 params body → 200400500
DELETE
/api/{index}/_doc/{id}
Delete document
DeleteDocument 2 params → 200400500
POST
/api/{index}/_multi
Multi documents
Multi 1 param body → 200400500
POST
/api/{index}/_update/{id}
Update document with id
UpdateDocument 2 params body → 200400500
POST
/es/_bulk
ES bulk documents
ESBulk body → 200500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are meta.Hit (8 properties), meta.HTTPResponseDocument (3 properties), meta.JSONIngest (2 properties), meta.HTTPResponseID (2 properties). Each schema is shown below with its type and property counts.

meta.HTTPResponseRecordCount
object
2 properties
meta.HTTPResponseID
object
2 properties
meta.Hit
object
8 properties
meta.JSONIngest
object
2 properties
meta.HTTPResponseDocument
object
3 properties
meta.HTTPResponseError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zincsearch-document-api-openapi.yml Raw ↑

Other APIs ZincSearch publishes across the network.

ZincSearch Healthz API
ZincSearch Index 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 Document 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.