It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Get health for a filtered group of proxies
editGet health for a filtered group of proxies
editGet the health status of a filtered group of proxies.
Request
editGET /api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
"The identifier for the filtered group of proxies |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
The expected status |
Responses
edit-
200
-
(
ProxiesFilteredGroupHealth
) Returns health information on a filtered group of proxies -
417
-
(
ProxiesFilteredGroupHealth
) The health status is worse than the expected one. -
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://{{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health \ -H "Authorization: ApiKey $ECE_API_KEY"