It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Deployment - Remote Clusters Get eligible remote clusters »

› › › ›

Get eligible remote clusters

edit

Get eligible remote clusters

edit

Returns the list of deployments which contain eligible remote clusters for a specific version.

Request

edit

POST /api/v1/deployments/eligible-remote-clusters

Query parameters

edit

Name	Type	Required	Description
`version`	`string`	Y	The version of the Elasticsearch cluster cluster that will potentially be configured to have remote clusters.

Request body

edit

(SearchRequest) (Optional) The search query to run against all deployments containing eligible remote clusters. When not specified, all the eligible deployments are matched.

Responses

edit

200

(DeploymentsSearchResponse) List of deployments which contains eligible remote clusters for a specific version

400

(BasicFailedReply) The provided version is invalid. (code: stackpack.invalid_version)

Headers

x-cloud-error-codes (string; allowed values: [stackpack.invalid_version]): The error codes associated with the response

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/deployments/eligible-remote-clusters \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-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" : [
      {}
   ]
}
'

« Deployment - Remote Clusters Get eligible remote clusters »