Proxy HTTP GET request
editProxy HTTP GET request
editProxies 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.
Request
editGET /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one) |
|
|
Y |
The kind of resource |
Headers
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
You must specify the |
Request body
edit(string
) The JSON payload to proxy to the deployment resource.
Responses
edit-
200
-
The request has been processed successfully through the proxy.
-
404
-
-
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
-
The Deployment specified by {deployment_id} cannot be found. (code:
Request example
editcurl -XGET 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/text'