Get proxies

GET /platform/infrastructure/proxies

Retrieves an overview of all proxies.

Responses

  • 200 application/json

    An overview of all proxies.

    Hide response attributes Show response attributes object
    • proxies_count integer(int32) Required

      Number of proxies

    • settings object Required

      Settings

      Hide settings attributes Show settings attributes object
    • proxies array[object] Required

      Proxies

      Information about a proxy.

      Hide proxies attributes Show proxies attributes object
      • proxy_id string Required

        The proxy identifier

      • 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

          Proxy allocation counts.

          Hide counts attributes Show counts attributes object
GET /platform/infrastructure/proxies
curl \
 --request GET 'https://{{hostname}}/api/v1/platform/infrastructure/proxies' \
 --user "username:password"