Query parameters

• expect_status string

  The expected status

Responses

• 200 application/json

  Returns health information on all the proxies

  Hide response attributes Show response attributes object

  • observed_proxies_count integer(int32) Required

    Total number of proxies

  • expected_proxies_count integer(int32) Required

    Expected minimum number of proxies

  • allocations array[object] Required

    Allocations for proxies

    Hide allocations attributes Show allocations attributes object

    The allocation status for a specified type, such as Elasticsearch, Kibana, or APM. The status is part of the overall proxy health information.

    • allocations_type string Required

      The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)

    • max_allocations integer(int32) Required

      The maximum number of allocations

    • proxies_at_max_allocations integer(int32) Required

      The number of proxies that have the maximum number of allocations

  • filtered_groups array[object] Required

    Filtered groups of proxies with associated status

    Hide filtered_groups attributes Show filtered_groups attributes object

    The health status of a filtered proxy group.

    • group object Required

      Settings of the filtered group

      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

        Selects proxies by matching a proxy metadata item.

        • 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"

  • status string Required

    "Health status for all proxies. One of "Green", "Yellow" or "Red"

• 417 application/json

  The health status is worse than the expected one.

  Hide response attributes Show response attributes object

  • observed_proxies_count integer(int32) Required

    Total number of proxies

  • expected_proxies_count integer(int32) Required

    Expected minimum number of proxies

  • allocations array[object] Required

    Allocations for proxies

    Hide allocations attributes Show allocations attributes object

    The allocation status for a specified type, such as Elasticsearch, Kibana, or APM. The status is part of the overall proxy health information.

    • allocations_type string Required

      The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)

    • max_allocations integer(int32) Required

      The maximum number of allocations

    • proxies_at_max_allocations integer(int32) Required

      The number of proxies that have the maximum number of allocations

  • filtered_groups array[object] Required

    Filtered groups of proxies with associated status

    Hide filtered_groups attributes Show filtered_groups attributes object

    The health status of a filtered proxy group.

    • group object Required

      Settings of the filtered group

      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

        Selects proxies by matching a proxy metadata item.

        • 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"

  • status string Required

    "Health status for all proxies. One of "Green", "Yellow" or "Red"