IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Resynchronize clusters Restart cluster »

› › › ›

Search clusters

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Search clusters

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use search deployments instead.

Retrieves the information for all of the Elasticsearch clusters that match the specified query.

Request

edit

POST /api/v1/clusters/elasticsearch/_search

Request body

edit

(SearchRequest) (Optional) The search query to run. When not specified, all of the clusters are matched.

Responses

edit

200

(ElasticsearchClustersInfo)

A list of Elasticsearch clusters that matched the given search query.

400

(BasicFailedReply)

The search request failed.

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/_search \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "from" : 0,
   "query" : {
      "bool" : {
         "filter" : [
            null
         ],
         "minimum_should_match" : 0,
         "must" : [
            null
         ],
         "must_not" : [
            null
         ],
         "should" : [
            null
         ]
      },
      "exists" : {
         "field" : "string"
      },
      "match" : {
         "some_property" : {
            "analyzer" : "string",
            "minimum_should_match" : 0,
            "operator" : "string",
            "query" : "string"
         }
      },
      "match_all" : {},
      "match_none" : {},
      "nested" : {
         "path" : "string",
         "query" : null,
         "score_mode" : "string"
      },
      "prefix" : {
         "some_property" : {
            "boost" : 0.1,
            "value" : "string"
         }
      },
      "query_string" : {
         "allow_leading_wildcard" : true,
         "analyzer" : "string",
         "default_field" : "string",
         "default_operator" : "string",
         "query" : "string"
      },
      "range" : {
         "some_property" : {
            "boost" : 0.1,
            "format" : "string",
            "gt" : {},
            "gte" : {},
            "lt" : {},
            "lte" : {},
            "time_zone" : "string"
         }
      },
      "term" : {
         "some_property" : {
            "value" : {}
         }
      }
   },
   "size" : 0,
   "sort" : [
      {}
   ]
}
'

« Resynchronize clusters Restart cluster »