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 Get proxies settings »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.4] ›RESTful API ›API reference ›Platform - proxies

Get proxy health

edit

Get proxy health

edit

Get the health status of all proxies.

Request

edit

GET /api/v1/platform/infrastructure/proxies/health

Query parameters

edit
Name Type Required Description

expect_status

string

N

The expected status

Responses

edit
200

(ProxiesHealth) Returns health information on all the proxies

417

(ProxiesHealth) 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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies/health \
-H "Authorization: ApiKey $ECE_API_KEY"
« Get health for a filtered group of proxies Get proxies settings »