Get proxy

Auth

Retrieves a single proxy by ID.

Path parameters

proxy_id string required

The identifier for the proxy

Responses

The information for the proxy specified by {proxy_id}.

application/json
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 object[] required

Allocation information by type.

allocations_type enum required

The type of proxy allocations

Values: elasticsearch kibana apm integrations_server appsearch enterprise_search
counts object required

The number of proxy allocations.

allocations integer · format: int32 required

The allocations count.

connectors integer · format: int32 required

The connector count.

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

application/json
errors object[] required

A list of errors that occurred in the failing request

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 string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response