Home

This documentation describe the APIs of OpenSearchServer v1.5

General documentation

• How to install OpenSearchServer on your server
• Do you want to contribute ? How to build OpenSearchServer using the source code
• The new OpenSearchServer FAQ is online: Dealing with memory, geolocation, selenium integration,...

API Documentation

• Authentication
• Index: create | delete | list | exists
• Field: list | get | create, update | delete | [set default / unique] (wiki/Field-set-default-unique)
• Document:
  • Injection: put json | put xml | put text
  • Removal: delete by field | delete by query | delete json
• Search Template: list | get | delete
• Search (by field): search | template search | template create, update
• Search (by pattern): search | template search | template create, update
• Auto-completion: create, update | list | build | query | delete
• WEB Crawler start | stop | status | crawl URL
  • inclusion patterns: insert | list | delete
  • exclusion patterns: insert | list | delete
  • URL database: inject URLs
• REST Crawler: list | run
• Synonyms: list lists | delete | check | get | create, update

---

OpenSearchServer web site