Get proxy

GET /platform/infrastructure/proxies/{proxy_id}

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.

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

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X GET "${API_URL}/platform/infrastructure/proxies/${PROXY_ID}" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "proxy_id": "string",
  "runner_id": "string",
  "host_ip": "string",
  "public_hostname": "string",
  "metadata": {},
  "healthy": false,
  "zone": "string",
  "allocations": [
    {
      "allocations_type": "elasticsearch",
      "counts": {
        "allocations": 0,
        "connectors": 0
      }
    }
  ]
}

Generated from the API spec

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

Generated from the API spec