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 proxy healthedit
Get the health status of all proxies.
Requestedit
GET /api/v1/platform/infrastructure/proxies/health
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
The expected status |
Responsesedit
-
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 exampleedit
curl -XGET https://{{hostname}}/api/v1/platform/infrastructure/proxies/health \ -H "Authorization: ApiKey $ECE_API_KEY"