Get proxies
- GET /platform/infrastructure/proxies
Retrieves an overview of all proxies.
Response
An overview of all proxies.
-
proxies_countintegerrequired -
Number of proxies
-
settingsProxiesSettingsrequired -
WARNING This object is deprecated and scheduled to be removed in the next major version.
-
expected_proxies_countintegerrequired -
Expected number of proxies
-
signature_secretstringrequired -
Secret string for signature generation
-
signature_valid_for_millisintegerrequired -
Signature validity in milliseconds
-
http_settingsProxiesHttpSettingsrequired -
WARNING This object is deprecated and scheduled to be removed in the next major version.
-
disconnected_cutoffintegerrequired -
Cutoff interval after disconnection in milliseconds
-
minimum_proxy_servicesintegerrequired -
Minimum number of proxy instances
-
sso_settingsProxiesSSOSettingsrequired -
WARNING This object is deprecated and scheduled to be removed in the next major version.
-
max_ageintegerrequired -
Maximum age of single-sign-on token in milliseconds
-
sso_secretstringrequired -
Secret string for single-sign-on
-
Name of the HTTP cookie used for single-sign-on
-
dont_log_requestsbooleanrequired -
If true, don't log requests
-
default_redirect_pathstringrequired -
Default path where users are redirected after a successful single-sign-on
-
Name of the cookie that bypasses maintenance
-
dashboards_base_urlstringrequired -
Base URL for the dashboard
-
Secret string for the HTTP cookie
-
User key for the HTTP cookie
-
proxiesProxyInforequired -
Proxies
-
proxy_idstringrequired -
The proxy identifier
-
runner_idstring -
Identifier of the runner for the proxy
-
host_ipstringrequired -
IP of the host the proxy runs on
-
public_hostnamestringrequired -
Public hostname of the host the proxy runs on
-
metadataobjectrequired -
Arbitrary metadata associated with the proxy
-
healthybooleanrequired -
Specifies if the proxy is healthy
-
zonestring -
The zone.
-
allocationsProxyAllocationInforequired -
Allocation information by type.
-
allocations_type -
The type of proxy allocations
-
Values:
elasticsearchkibanaapmintegrations_serverappsearchenterprise_search -
countsProxyAllocationCountsrequired -
The number of proxy allocations.
-
allocationsintegerrequired -
The allocations count.
-
connectorsintegerrequired -
The connector count.