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.

« Proxy HTTP POST request Clusters - Kibana - CRUD »

› › › ›

Proxy HTTP PUT request

edit

Proxy HTTP PUT request

edit

DEPRECATED (Scheduled to be removed in the next major version): Proxies the HTTP PUT request to the cluster. You must specify the X-Management-Request HTTP header. NOTE: Use this endpoint for management purposes. It does not provide high performance.

Request

edit

PUT /api/v1/clusters/enterprise_search/{cluster_id}/proxy/{enterprise_search_path}

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The EnterpriseSearch deployment identifier
`enterprise_search_path`	`string`	Y	The URL part to proxy to the EnterpriseSearch cluster. Example: /api/ent/v1/internal/read_only_mode or /api/ent/v1/internal/health

Headers

edit

Name	Type	Required	Description
`X-Management-Request`	`string`	Y	When set to `true`, includes the X-Management-Request header value.

Request body

edit

(string) The JSON payload that is used to proxy the EnterpriseSearch deployment.

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/enterprise_search/{cluster_id}/proxy/{enterprise_search_path} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H X-Management-Request: string

« Proxy HTTP POST request Clusters - Kibana - CRUD »