WEB Crawler API

This API is deprecated, please refer to the new RESTFul API instead.


The web crawler API can start or stop the web crawler.


  • use (required): The name of the index.
  • login (optional): The login parameter. This becomes required once you create a user.
  • key (optional): The key parameter related to the login (api key). This becomes required once you create a user.
  • action: The action to perform: start, stop, and know status of the index.
  • runOnce: The runOnce parameter is to specify whether the crawler should run only once, or forever. This is a Boolean parameter.


HTTP request


HTTP response

This indicates that 14 documents has been deleted from the index:

    <entry key="info">STARTED</entry>
    <entry key="status">OK</entry>

View/edit on GitHub

comments powered by Disqus