ZincSearch API
Zinc Search engine API documents https://zincsearch-docs.zinc.dev
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Zinc Search engine API documents https://zincsearch-docs.zinc.dev
Endpoints 48
Index
- POSTAnalyze
/api/_analyze - GETList indexes
/api/index - POSTCreate index
/api/index - GETGet index metadata
/api/index/:index - DELETEDelete index
/api/index/:index - HEADChecks if the index exists
/api/index/:index - POSTResfresh index
/api/index/:index/refresh - GETList index Name
/api/index_name - POSTAnalyze
/api/:index/_analyze - GETGet index mappings
/api/:index/_mapping - PUTSet index mappings
/api/:index/_mapping - GETGet index settings
/api/:index/_settings - PUTSet index Settings
/api/:index/_settings - POSTAdd or remove index alias for compatible ES
/es/_aliases - GETList index teplates
/es/_index_template - POSTCreate update index template
/es/_index_template - GETGet index template
/es/_index_template/:name - PUTCreate update index template
/es/_index_template/:name - DELETEDelete template
/es/_index_template/:name - PUTCreate index for compatible ES
/es/:index - HEADChecks if the index exists for compatible ES
/es/:index - GETGet index mappings for compatible ES
/es/:index/_mapping - GETGet index alias for compatible ES
/es/:target/_alias/:target_alias
Document
- POSTBulk documents
/api/_bulk - POSTBulkv2 documents
/api/_bulkv2 - POSTCreate or update document
/api/:index/_doc - GETget document with id
/api/:index/_doc/:id - PUTCreate or update document with id
/api/:index/_doc/:id - DELETEDelete document
/api/:index/_doc/:id - POSTMulti documents
/api/:index/_multi - POSTUpdate document with id
/api/:index/_update/:id - POSTES bulk documents
/es/_bulk
User
- PUTUpdate own name and/or password
/api/account - POSTLogin
/api/login - GETList user
/api/user - PUTUpdate user
/api/user - POSTCreate user
/api/user - DELETEDelete user
/api/user/:id
Permission
- GETList permissions
/api/permissions
Role
- GETList role
/api/role - POSTCreate role
/api/role - DELETEDelete role
/api/role/:id
Search
- POSTSearch V1
/api/:index/_search - POSTSearch V2 MultipleSearch for compatible ES
/es/_msearch - POSTSearches the index and deletes all matched documents
/es/:index/_delete_by_query - POSTSearch V2 DSL for compatible ES
/es/:index/_search
- GETGet healthz
/healthz - GETGet version
/version
API details
- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 48 operations on 34 pathsPOST 19GET 15PUT 7DELETE 5HEAD 2
- Main resources
- Index 23Document 9User 6Search 4Role 3Permission 1
- Description format
- Swagger 2.0, API version
1.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- ZincSearch's published OpenAPI description (zincsearch/zincsearch) (Apache-2.0)
How to test the ZincSearch API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ZincSearch API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Analyze” (POST /api/_analyze), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ZincSearch API?
Zinc Search engine API documents https://zincsearch-docs.zinc.dev It is listed under Data & analytics and has 48 endpoints.
Who publishes the ZincSearch API?
It is listed from ZincSearch's public API description (an OpenAPI document), not published by ZincSearch on Swastik Codes. Anyone who controls zinc.dev can claim the profile by adding a DNS TXT record.
How do I authenticate with the ZincSearch API?
With HTTP Basic authentication (username and password).
How many endpoints does the ZincSearch API have?
48 operations on 34 paths (19 POST, 15 GET, 7 PUT, 5 DELETE, 2 HEAD). The largest groups are Index, Document, User, Search.
Is forking the ZincSearch API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.