IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get health for a filtered group of proxies Get proxies settings »

› › › ›

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

Request example

edit

curl -XGET https://{{hostname}}/api/v1/platform/infrastructure/proxies/health \
-H "Authorization: ApiKey $ECE_API_KEY"

« Get health for a filtered group of proxies Get proxies settings »