Proxy HTTP PUT requestedit

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.

Requestedit

PUT /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}

Path parametersedit

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

proxy_path

string

Y

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

ref_id

string

Y

User-specified RefId for the Resource

resource_kind

string; allowed values: [elasticsearch, kibana, enterprise_search]

Y

The kind of resource

Headersedit

Name Type Required Description

X-Management-Request

string

Y

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 bodyedit

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

Responsesedit

200

(GenericResponse)

The request has been processed successfully through the proxy.

404

(BasicFailedReply)

  • 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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_not_found, clusters.cluster_not_found])
The error codes associated with the response
449

(BasicFailedReply)

Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

Request exampleedit

curl -XPUT https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H X-Management-Request: string \
-H 'Content-Type: application/json'