Proxy HTTP GET request
Proxies the HTTP GET request to the deployment resource. You must specify the X-Management-Request
HTTP header. NOTE: Use this endpoint for management purposes. It does not provide high performance.
Headers
-
You must specify the
X-Management-Request
HTTP header with valuetrue
. NOTE: Use this endpoint for management purposes. It does not provide high performance.
Path parameters
-
Identifier for the Deployment
-
The kind of resource
Values are
elasticsearch
,kibana
, orenterprise_search
. -
User-specified RefId for the Resource (or '_main' if there is only one)
-
The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health
Responses
-
The request has been processed successfully through the proxy.
-
- The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found
) - The Resource specified by {ref_id} cannot be found. (code:
deployments.deployment_resource_not_found
) - The Resource specified by {ref_id} cannot be found. (code:
clusters.cluster_not_found
)
- The Deployment specified by {deployment_id} cannot be found. (code:
GET
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
curl \
-X GET https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} \
-H "X-Management-Request: string" \
-d '"string"'
Request examples
# Headers
X-Management-Request: string
# Payload
string
Response examples (200)
{
"value": "string"
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}