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.
Proxies HTTP PUT request to the clusteredit
Proxies HTTP PUT request to the cluster. Requires that HTTP header X-Management-Request be specified. This endpoint is for management use and does not provide high performance.
Requestedit
PUT /api/v1/clusters/elasticsearch/{cluster_id}/proxy/{elasticsearch_path}
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Elasticsearch cluster |
|
|
Y |
The URL part to proxy to the Elasticsearch cluster. Example: _search or _cat/indices?v&h=i,tm&s=tm:desc |
Headersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
X-Management-Request header value. Needs to be set to true |
Request bodyedit
(string) The JSON payload to proxy to the Elasticsearch cluster
Responsesedit
-
200 -
The request has been processed successfully through the proxy
-
404 -
(
BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPUT {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/proxy/{elasticsearch_path} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H X-Management-Request: string