Get health for a filtered group of proxies

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

Get the health status of a filtered group of proxies.

Path parameters

proxies_filtered_group_id string Required

"The identifier for the filtered group of proxies

Query parameters

expect_status string

The expected status

Responses

200

Returns health information on a filtered group of proxies
Hide response attributes Show response attributes object
- group object Required
  
  A set of proxy filters with an expected number of matching proxies.
  
  Additional properties are allowed.
  
  Hide group attributes Show group attributes object
  
  id string
  
  Identifier of the filtered group of proxies
  
  filters array[object] Required
  
  Filters to be matched
  
  Hide filters attributes Show filters attributes object
  
  key string Required
  
  Key of the proxy metadata item to be matched
  
  value string Required
  
  Value of the proxy metadata item to be matched
  
  expected_proxies_count integer(int32) Required
  
  Expected minimum number of proxies matching all filters in this group
- observed_proxies_count integer(int32) Required
  
  The number of proxies that match all of the filters in the group
- status string Required
  
  "Health status for this filtered group. One of "Green", "Yellow" or "Red"
417

The health status is worse than the expected one.
Hide response attributes Show response attributes object
- group object Required
  
  A set of proxy filters with an expected number of matching proxies.
  
  Additional properties are allowed.
  
  Hide group attributes Show group attributes object
  
  id string
  
  Identifier of the filtered group of proxies
  
  filters array[object] Required
  
  Filters to be matched
  
  Hide filters attributes Show filters attributes object
  
  key string Required
  
  Key of the proxy metadata item to be matched
  
  value string Required
  
  Value of the proxy metadata item to be matched
  
  expected_proxies_count integer(int32) Required
  
  Expected minimum number of proxies matching all filters in this group
- observed_proxies_count integer(int32) Required
  
  The number of proxies that match all of the filters in the group
- status string Required
  
  "Health status for this filtered group. One of "Green", "Yellow" or "Red"

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

curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health

Response examples (200)

{
  "group": {
    "id": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "expected_proxies_count": 42
  },
  "observed_proxies_count": 42,
  "status": "string"
}

Response examples (417)

{
  "group": {
    "id": "string",
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "expected_proxies_count": 42
  },
  "observed_proxies_count": 42,
  "status": "string"
}