Proxy HTTP GET request

Auth

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.

Path parameters

deployment_id string required

Identifier for the Deployment

resource_kind enum required

The kind of resource

Values: elasticsearch kibana enterprise_search integrations_server
ref_id string required

User-specified RefId for the Resource (or '_main' if there is only one)

proxy_path string required

The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health

Header parameters

X-Management-Request string required

You must specify the X-Management-Request HTTP header with value true. NOTE: Use this endpoint for management purposes. It does not provide high performance.

Request body

The JSON payload to proxy to the deployment resource.

Type: string

Responses

The request has been processed successfully through the proxy.

application/octet-stream
value string required
  • 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)
application/octet-stream
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response