Proxy HTTP GET request

GET /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}

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

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

Path parameters

  • deployment_id string Required

    Identifier for the Deployment

  • resource_kind string Required

    The kind of resource

    Values are elasticsearch, kibana, or enterprise_search.

  • 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

Body

The JSON payload to proxy to the deployment resource.

string string

Responses

  • 200

    The request has been processed successfully through the proxy.

    Hide response attribute Show response attribute object
  • 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)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or clusters.cluster_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
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"
      ]
    }
  ]
}