Clusters - Kibana - Proxy

Proxy HTTP DELETE request

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

DELETE /api/v1/clusters/kibana/{cluster_id}/proxy/{kibana_path}

Path parameters

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

Name Type Required Description

X-Management-Request

string

Y

When set to true, includes the X-Management-Request header value.

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/kibana/{cluster_id}/proxy/{kibana_path} \
-u $CLOUD_USER:$CLOUD_KEY \
-H X-Management-Request: string

Proxy HTTP GET request

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

GET /api/v1/clusters/kibana/{cluster_id}/proxy/{kibana_path}

Path parameters

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

Name Type Required Description

X-Management-Request

string

Y

When set to true, includes the X-Management-Request header value.

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/kibana/{cluster_id}/proxy/{kibana_path} \
-u $CLOUD_USER:$CLOUD_KEY \
-H X-Management-Request: string

Proxy HTTP POST request

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

POST /api/v1/clusters/kibana/{cluster_id}/proxy/{kibana_path}

Path parameters

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

Name Type Required Description

X-Management-Request

string

Y

When set to true, includes the X-Management-Request header value.

Request body

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

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/kibana/{cluster_id}/proxy/{kibana_path} \
-u $CLOUD_USER:$CLOUD_KEY \
-H X-Management-Request: string

Proxy HTTP PUT request

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

PUT /api/v1/clusters/kibana/{cluster_id}/proxy/{kibana_path}

Path parameters

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

Name Type Required Description

X-Management-Request

string

Y

When set to true, includes the X-Management-Request header value.

Request body

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

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/kibana/{cluster_id}/proxy/{kibana_path} \
-u $CLOUD_USER:$CLOUD_KEY \
-H X-Management-Request: string