API Basics

FlexSearch follows the following basic URI convention:

[HTTP VERB] http://{servername}:{portnumber}/{resource}/{resourceId}/{sub-resource|operation}

For example if the users wants to check the status of index with name test then the indexname in the above URI will be replaced by test and the operation will become status:

GET /inidices/test/status HTTP/1.1

The various Http verbs are mapped to the following operations:

VerbDescription
GETGet a resource
POSTCreate a resource
PUTUpdate/Create a resource
DELETEDelete a resource

Formats

FlexSearch supports 2 response formats out of the box:

  • JSON
  • MessagePack

JSONP support

To embed the response in a jsonp callback, append ?callback=myCallback