Get the hostname list

Use this API to get the list of hostnames present in the URL database.

The number of known URL per hostname are also returned.

Requirement: OpenSearchServer v1.5

Call parameters

URL: /services/rest/index/{index_name}/crawler/web/hostnames

Method: GET

HTTP Header:

  • Content-Type (required): application/json
  • Accept (optional returned type): application/json or application/xml

URL parameters:

  • index_name (required): The name of the index.
  • min_count (optional): A filter to get only the hostname who have equals or more URL than this parameter.

Success response

HTTP code:

Content (application/json):

"successful": true,
"hostnames": {
"": 2231,
"": 1,
"": 310

Error response

The insertion failed. The reason why is provided in the content.

HTTP code:

Sample call

Using CURL:

curl -XPUT -H "Content-Type: application/json" \
-d '[""]' \

View/edit on GitHub