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 POST request to the cluster Clusters - Elasticsearch - Support »

› › › ›

Proxies HTTP PUT request to the cluster

edit

Proxies HTTP PUT request to the cluster

edit

DEPRECATED (Scheduled to be removed in the next major version): 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.

Request

edit

PUT /api/v1/clusters/elasticsearch/{cluster_id}/proxy/{elasticsearch_path}

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	Identifier for the Elasticsearch cluster
`elasticsearch_path`	`string`	Y	The URL part to proxy to the Elasticsearch cluster. Example: _search or _cat/indices?v&h=i,tm&s=tm:desc

Headers

edit

Name	Type	Required	Description
`X-Management-Request`	`string`	Y	X-Management-Request header value. Needs to be set to true

Request body

edit

(string) The JSON payload to proxy to the Elasticsearch cluster

Responses

edit

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 example

edit

curl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/proxy/{elasticsearch_path} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H X-Management-Request: string

« Proxies HTTP POST request to the cluster Clusters - Elasticsearch - Support »