---
type: api
title: Get proxy health
description: > WARNING
url: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/cloud-enterprise/operation/operation-get-proxies-health
resource: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/cloud-enterprise/operation/operation-get-proxies-health
products:
  - Elastic Cloud Enterprise
---

# Get proxy health

Authentication: required

## Paths

- `GET` `/platform/infrastructure/proxies/health`

## Description

> WARNING
> This endpoint is deprecated and scheduled to be removed in the next major version.

Get the health status of all proxies.

## Query string parameters

- `expect_status` (string) — optional
  The expected status

## Responses

#### `200`

Returns health information on all the proxies

`application/json`

- `observed_proxies_count` (integer · format: int32)
  Total number of proxies
- `expected_proxies_count` (integer · format: int32)
  Expected minimum number of proxies
- `allocations` (object[])
  Allocations for proxies
  - `allocations_type` (string)
    The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)
  - `max_allocations` (integer · format: int32)
    The maximum number of allocations
  - `proxies_at_max_allocations` (integer · format: int32)
    The number of proxies that have the maximum number of allocations
- `filtered_groups` (object[])
  Filtered groups of proxies with associated status
  - `group` (object)
    A set of proxy filters with an expected number of matching proxies.
    - `id` (string)
      Identifier of the filtered group of proxies
    - `filters` (object[])
      Filters to be matched
      - `key` (string)
        Key of the proxy metadata item to be matched
      - `value` (string)
        Value of the proxy metadata item to be matched
    - `expected_proxies_count` (integer · format: int32)
      Expected minimum number of proxies matching all filters in this group
  - `observed_proxies_count` (integer · format: int32)
    The number of proxies that match all of the filters in the group
  - `status` (string)
    "Health status for this filtered group. One of "Green", "Yellow" or "Red"
- `status` (string)
  "Health status for all proxies. One of "Green", "Yellow" or "Red"
#### `417`

The health status is worse than the expected one.

`application/json`

- `observed_proxies_count` (integer · format: int32)
  Total number of proxies
- `expected_proxies_count` (integer · format: int32)
  Expected minimum number of proxies
- `allocations` (object[])
  Allocations for proxies
  - `allocations_type` (string)
    The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)
  - `max_allocations` (integer · format: int32)
    The maximum number of allocations
  - `proxies_at_max_allocations` (integer · format: int32)
    The number of proxies that have the maximum number of allocations
- `filtered_groups` (object[])
  Filtered groups of proxies with associated status
  - `group` (object)
    A set of proxy filters with an expected number of matching proxies.
    - `id` (string)
      Identifier of the filtered group of proxies
    - `filters` (object[])
      Filters to be matched
      - `key` (string)
        Key of the proxy metadata item to be matched
      - `value` (string)
        Value of the proxy metadata item to be matched
    - `expected_proxies_count` (integer · format: int32)
      Expected minimum number of proxies matching all filters in this group
  - `observed_proxies_count` (integer · format: int32)
    The number of proxies that match all of the filters in the group
  - `status` (string)
    "Health status for this filtered group. One of "Green", "Yellow" or "Red"
- `status` (string)
  "Health status for all proxies. One of "Green", "Yellow" or "Red"
## Code examples

#### curl

```curl
curl -X GET "${API_URL}/platform/infrastructure/proxies/health" \
  -u "${USERNAME}:${PASSWORD}"
```

## Response examples

#### 200

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "observed_proxies_count": 0,
  "expected_proxies_count": 0,
  "allocations": [
    {
      "allocations_type": "string",
      "max_allocations": 0,
      "proxies_at_max_allocations": 0
    }
  ],
  "filtered_groups": [
    {
      "group": {
        "id": "string",
        "filters": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "expected_proxies_count": 0
      },
      "observed_proxies_count": 0,
      "status": "string"
    }
  ],
  "status": "string"
}
```

#### 417

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "observed_proxies_count": 0,
  "expected_proxies_count": 0,
  "allocations": [
    {
      "allocations_type": "string",
      "max_allocations": 0,
      "proxies_at_max_allocations": 0
    }
  ],
  "filtered_groups": [
    {
      "group": {
        "id": "string",
        "filters": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "expected_proxies_count": 0
      },
      "observed_proxies_count": 0,
      "status": "string"
    }
  ],
  "status": "string"
}
```