Skip to content

API Index

These APIs can be used to programatically interact with ZincSearch.

All APIs must have an authorization header. Authorization header can be created using base64 encoded values of user id and password. For the sake of simplicity it is HTTP basic authentication mechanism.

Header creation mechanism:

Authorization: Basic base64("userId:password")

e.g. Header:

Authorization: Basic YWRtaW46Q29tcGxleHBhc3MjMTIz

Make sure that you are sending the requests over HTTPS.

API List

  1. CreateIndex
  2. DeleteIndex
  3. ListIndexes
  4. Search
  5. UpdateDocumentWithId
  6. UpdateDocument
  7. DeleteDocument
  8. UpdateDocumentsBulk
  9. UpdateIndexMappings
  10. GetIndexMappings
  11. Version
  12. Metrics
  13. CreateUpdateUser
  14. DeleteUser