Deleting a FTP repository

Use this API to delete a repository accessed over FTP.

Requirement: OpenSearchServer v1.5

The URLs and HTTP methods used by this API are different from other OSS APIs, please give this document a careful read..

Call parameters

URL: /services/rest/crawler/file/repository/remove/ftp/{index_name}/{result_type}?path={path}&username={username}&host={host}&ssl={ssl}

Method: DELETE

URL parameters:

  • index_name (required): The name of the index.
  • result_type (required): The type of returned result (json or xml).
  • path (required): path used by this repository.
  • username (required): username used by this repository.
  • host (required): host used by this repository.
  • ssl (required): whether the repository to delete is configured for SSL (true or false)

Success response

Repository has been deleted.

HTTP code:
200

Content (json):

{
  "successful":true
}

Error response

The request failed. The reason is provided in the content.

HTTP code:
500

Sample call

Using CURL:
Simple call:

curl -XDELETE -H \
     http://localhost:8080/services/rest/crawler/file/repository/remove/ftp/my_index/json?path=/test&username=ftpuser&host=mysite.com&ssl=true

Using jQuery:

$.ajax({ 
   type: "DELETE",
   dataType: "json",
   url: "http://localhost:8080/services/rest/crawler/file/repository/remove/ftp/my_index/json?path=/test&username=ftpuser&host=mysite.com&ssl=true"
}).done(function (data) {
   console.log(data);
});

View/edit on GitHub


comments powered by Disqus