Get proxy health
- GET /platform/infrastructure/proxies/health
WARNING This endpoint is deprecated and scheduled to be removed in the next major version.
Get the health status of all proxies.
Query Parameters
-
expect_statusstring The expected status
Responses
Returns health information on all the proxies
-
observed_proxies_countintegerrequired -
Total number of proxies
-
expected_proxies_countintegerrequired -
Expected minimum number of proxies
-
allocationsProxiesAllocationsInforequired -
Allocations for proxies
-
allocations_typestringrequired -
The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)
-
max_allocationsintegerrequired -
The maximum number of allocations
-
proxies_at_max_allocationsintegerrequired -
The number of proxies that have the maximum number of allocations
-
filtered_groupsProxiesFilteredGroupHealthrequired -
Filtered groups of proxies with associated status
-
groupProxiesFilteredGrouprequired -
A set of proxy filters with an expected number of matching proxies.
-
idstring -
Identifier of the filtered group of proxies
-
filtersProxiesFilterrequired -
Filters to be matched
-
expected_proxies_countintegerrequired -
Expected minimum number of proxies matching all filters in this group
-
observed_proxies_countintegerrequired -
The number of proxies that match all of the filters in the group
-
statusstringrequired -
"Health status for this filtered group. One of "Green", "Yellow" or "Red"
-
statusstringrequired -
"Health status for all proxies. One of "Green", "Yellow" or "Red"
The health status is worse than the expected one.
-
observed_proxies_countintegerrequired -
Total number of proxies
-
expected_proxies_countintegerrequired -
Expected minimum number of proxies
-
allocationsProxiesAllocationsInforequired -
Allocations for proxies
-
allocations_typestringrequired -
The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)
-
max_allocationsintegerrequired -
The maximum number of allocations
-
proxies_at_max_allocationsintegerrequired -
The number of proxies that have the maximum number of allocations
-
filtered_groupsProxiesFilteredGroupHealthrequired -
Filtered groups of proxies with associated status
-
groupProxiesFilteredGrouprequired -
A set of proxy filters with an expected number of matching proxies.
-
idstring -
Identifier of the filtered group of proxies
-
filtersProxiesFilterrequired -
Filters to be matched
-
expected_proxies_countintegerrequired -
Expected minimum number of proxies matching all filters in this group
-
observed_proxies_countintegerrequired -
The number of proxies that match all of the filters in the group
-
statusstringrequired -
"Health status for this filtered group. One of "Green", "Yellow" or "Red"
-
statusstringrequired -
"Health status for all proxies. One of "Green", "Yellow" or "Red"