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.
Search Deploymentsedit
Retrieves the information for all of the Deployments that match the specified query.
Requestedit
POST /api/v1/deployments/_search
Request bodyedit
(SearchRequest) (Optional) The search request to execute. NOTE: When not specified, all of the deployments are matched.
Responsesedit
-
200 -
(
DeploymentsSearchResponse) The list of deployments that match the specified query and belong to the authenticated user -
401 -
(
BasicFailedReply) You are not authorized to perform this action
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/deployments/_search \
-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" : [
{}
]
}
'