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. GET /es/
  2. GET /es/_license
  3. GET /es/_xpack
  4. POST /es/_search
  5. POST /es/_msearch
  6. POST /es/:target/_search
  7. POST /es/:target/_msearch
  8. GET /es/_index_template
  9. PUT /es/_index_template/:target
  10. GET /es/_index_template/:target
  11. HEAD /es/_index_template/:target
  12. DELETE /es/_index_template/:target
  13. GET /es/:target/_mapping
  14. PUT /es/:target/_mapping
  15. GET /es/:target/_settings
  16. PUT /es/:target/_settings
  17. POST /es/_analyze
  18. POST /es/:target/_analyze
  19. POST /es/_bulk
  20. POST /es/:target/_bulk
  21. POST /es/:target/_doc
  22. PUT /es/:target/_doc/:id
  23. PUT /es/:target/_create/:id
  24. POST /es/:target/_create/:id
  25. POST /es/:target/_update/:id
  26. DELETE /es/:target/_doc/:id