Get proxy

GET /platform/infrastructure/proxies/{proxy_id}

Retrieves a single proxy by ID.

Path parameters

  • proxy_id string Required

    The identifier for the proxy

Responses

  • 200

    The information for the proxy specified by {proxy_id}.

    Hide response attributes Show response attributes object
    • proxy_id string Required

      The proxy identifier

    • runner_id string

      Identifier of the runner for the proxy

    • host_ip string Required

      IP of the host the proxy runs on

    • public_hostname string Required

      Public hostname of the host the proxy runs on

    • metadata object Required

      Arbitrary metadata associated with the proxy

      Additional properties are allowed.

    • healthy boolean Required

      Specifies if the proxy is healthy

    • zone string

      The zone.

    • allocations array[object] Required

      Allocation information by type.

      Hide allocations attributes Show allocations attributes object
      • allocations_type string Required

        The type of proxy allocations

        Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.

      • counts object Required

        Proxy allocation counts.

        Additional properties are allowed.

        Hide counts attributes Show counts attributes object
  • 404

    Unable to find the {proxy_id} specified proxy. Edit your request, then try again. (code: proxies.proxy_not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is proxies.proxy_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 /platform/infrastructure/proxies/{proxy_id} 
curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/proxies/{proxy_id}
Response examples (200) 
{
  "proxy_id": "string",
  "runner_id": "string",
  "host_ip": "string",
  "public_hostname": "string",
  "metadata": {},
  "healthy": true,
  "zone": "string",
  "allocations": [
    {
      "allocations_type": "elasticsearch",
      "counts": {
        "allocations": 42,
        "connectors": 42
      }
    }
  ]
}
Response examples (404) 
# Headers
x-cloud-error-codes: proxies.proxy_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}