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. Index
    1. Create / Update
    2. Delete
    3. List
    4. Get Mapping
    5. Update Mapping
    6. Get Settings
    7. Update Settings
    8. Analyze
    9. Refresh Data
    10. Check Exists
  2. Document
    1. Create
    2. Create with id
    3. Update
    4. Delete
    5. Bulk
    6. Bulk V2
    7. Multi
  3. Search
    1. Search
    2. Search Types
    3. Aggregations
    4. Highlight
  4. User
    1. Create / Update
    2. Delete
    3. List
  5. Version
  6. Metrics