Path parameters

• proxy_id string Required

  The identifier for the proxy

Responses

• 200 application/json

  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

  • healthy boolean Required

    Specifies if the proxy is healthy

  • zone string

    The zone.

  • allocations array[object] Required

    Allocation information by type.

    The single proxy allocation for a specified type, such as Elasticsearch, Kibana, or APM.

    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

      The number of proxy allocations.

      Hide counts attributes Show counts attributes object

      • allocations integer(int32) Required

        The allocations count.

      • connectors integer(int32) Required

        The connector count.

• 404 application/json

  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