Documentation


Searchly exposes ElasticSearch’s JSON API.

It is best to follow ElasticSearch’s API documentation to start with Searchly.

Multiple versions of Elastisearch are available at Searchly, therefore be sure to checkout the right version documentation of Elasticsearch.

Searchly API url structure;

https://site:{api-key}@xyz.searchly.com/{indexName}

You can find your connection url at your dashboard.

For instance if your api key is “abcdefg123456” and you have created an index named 'articles', API url for this index can be seen below;

https://site:abcdefg123456@xyz-us-east-1.searchly.com/articles

After signing up to Searchly, you can test basic features with ease.

$ curl -XPUT http://site:{apiKey}@xyz.searchly.com/articles

This command will create an index with given name 'articles' under your account.

Add a document to index:

$ curl -XPOST http://site:{apiKey}@xyz.searchly.com/articles/article -d '{ "name":"First Article","owner": "me" }'
$ curl -XGET http://site:{apiKey}@xyz.searchly.com/articles/_search?q=name:First

architecture

  • Searchly is running on Amazon Web Services US East and EU West region.

  • Dashboard is used for managing subscriptions, memberships and provides a GUI.

  • Rest Gateway is responsible for authorization and authentication of search requests.