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
      • expected_proxies_count integer(int32) Required

        Expected number of proxies

      • signature_secret string Required

        Secret string for signature generation

      • signature_valid_for_millis integer(int64) Required

        Signature validity in milliseconds

      • http_settings object Required

        HTTP settings

        Hide http_settings attributes Show http_settings attributes object
        • disconnected_cutoff integer(int64) Required

          Cutoff interval after disconnection in milliseconds

        • minimum_proxy_services integer(int32) Required

          Minimum number of proxy instances

        • sso_settings object Required

          Settings related to single-sign-on

          Hide sso_settings attributes Show sso_settings attributes object
          • max_age integer(int64) Required

            Maximum age of single-sign-on token in milliseconds

          • sso_secret string Required

            Secret string for single-sign-on

          • dont_log_requests boolean Required

            If true, don't log requests

          • default_redirect_path string Required

            Default path where users are redirected after a successful single-sign-on

        • dashboards_base_url string Required

          Base URL for the dashboard

    • proxies array[object] Required

      Proxies

      Information about a proxy.

      Hide proxies attributes Show proxies 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

          Proxy allocation counts.

          Hide counts attributes Show counts attributes object
          • allocations integer(int32) Required

            The allocations count.

          • connectors integer(int32) Required

            The connector count.

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