IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Proxy HTTP POST request Clusters - Search »

› › › ›

Proxy HTTP PUT request

edit

Proxy HTTP PUT request

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use proxy PUT request to resource instead.

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/kibana/{cluster_id}/proxy/{kibana_path}

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier
`kibana_path`	`string`	Y	The URL part to proxy to the Kibana cluster. Example: /api/spaces/space or /api/upgrade_assistant/status

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 Kibana 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')

Request example

edit

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

« Proxy HTTP POST request Clusters - Search »