IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Update filtered group of proxies Get proxy health »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›API reference ›Platform - proxies

Get health for a filtered group of proxies

edit

Get health for a filtered group of proxies

edit

Get the health status of a filtered group of proxies.

Request

edit

GET /api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health

Path parameters

edit
Name Type Required Description

proxies_filtered_group_id

string

Y

"The identifier for the filtered group of proxies

Query parameters

edit
Name Type Required Description

expect_status

string

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

edit
curl -XGET https://{{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health \
-H "Authorization: ApiKey $ECE_API_KEY"
« Update filtered group of proxies Get proxy health »