# Get eligible remote clusters

**POST /deployments/eligible-remote-clusters**

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


## Servers
- https://api.elastic-cloud.com/api/v1: https://api.elastic-cloud.com/api/v1 ()



## Parameters


### Query parameters
- **version** (string)
  The version of the Elasticsearch cluster cluster that will potentially be configured to have remote clusters.

### Body: application/json (object)
(Optional) The search query to run against all deployments containing eligible remote clusters. When not specified, all the eligible deployments are matched.
- **from** (integer(int32))
  Deprecated, use cursor for a more scalable approach to paging.
- **cursor** (string)
  To retrieve the next page of hits, set this to the cursor value of the previous response. When set, all other fields are ignored.
- **size** (integer(int32))
  The maximum number of search results to return.
- **query** (object)
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
- **sort** (array[object])
  An array of fields to sort the search results by. Defaults to query rank and last modified date descending.


## Responses
### 200
List of deployments which contains eligible remote clusters for a specific version

#### Body: application/json (object)
- **return_count** (integer(int32))
  The number of deployments actually returned, either as deployment instances or as minimalMetadata objects
- **match_count** (integer(int32))
  If a query is supplied, then the total number of deployments that matched
- **deployments** (array[object])

- **minimal_metadata** (array[object])

- **cursor** (string)
  To retrieve the next batch of deployments from this search, specify this value in the cursor field of the next search request. For paginated searches, it is recommended to sort on a static and unique field, like deployment or cluster id. A static and unique sort avoids concurrent updates causing a deployment to move across pages and becoming a duplicate or lost entry. The default sort of rank and modified date is often good for getting a particular deployment into the first page, but if a not yet seen deployment is modified in between page requests, then it would be left out from the next page.

### 400
The provided version is invalid. (code: `stackpack.invalid_version`)
#### Headers
- **x-cloud-error-codes** (string)
  The error codes associated with the response

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request


[Powered by Bump.sh](https://bump.sh)