Clusters - Elasticsearch - Proxy

Proxies HTTP DELETE request to the cluster

Proxies HTTP DELETE 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

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

Path parameters

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

Name Type Required Description

X-Management-Request

string

Y

X-Management-Request header value. Needs to be set to true

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XDELETE {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/proxy/{elasticsearch_path} \
-u $CLOUD_USER:$CLOUD_KEY \
-H X-Management-Request: string

Proxies HTTP GET request to the cluster

Proxies HTTP GET 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

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

Path parameters

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

Name Type Required Description

X-Management-Request

string

Y

X-Management-Request header value. Needs to be set to true

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/proxy/{elasticsearch_path} \
-u $CLOUD_USER:$CLOUD_KEY \
-H X-Management-Request: string

Proxies HTTP POST request to the cluster

Proxies HTTP POST 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

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

Path parameters

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

Name Type Required Description

X-Management-Request

string

Y

X-Management-Request header value. Needs to be set to true

Request body

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

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/proxy/{elasticsearch_path} \
-u $CLOUD_USER:$CLOUD_KEY \
-H X-Management-Request: string

Proxies HTTP PUT request to the cluster

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

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

Path parameters

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

Name Type Required Description

X-Management-Request

string

Y

X-Management-Request header value. Needs to be set to true

Request body

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

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/proxy/{elasticsearch_path} \
-u $CLOUD_USER:$CLOUD_KEY \
-H X-Management-Request: string