.. _envoy_api_file_envoy/config/filter/http/health_check/v2/health_check.proto:

Health check
============

Health check :ref:`configuration overview <config_http_filters_health_check>`.

.. _envoy_api_msg_config.filter.http.health_check.v2.HealthCheck:

config.filter.http.health_check.v2.HealthCheck
----------------------------------------------

`[config.filter.http.health_check.v2.HealthCheck proto] <https://github.com/envoyproxy/data-plane-api/blob/master/envoy/config/filter/http/health_check/v2/health_check.proto#L16>`_


.. code-block:: json

  {
    "pass_through_mode": "{...}",
    "endpoint": "...",
    "cache_time": "{...}",
    "cluster_min_healthy_percentages": "{...}"
  }

.. _envoy_api_field_config.filter.http.health_check.v2.HealthCheck.pass_through_mode:

pass_through_mode
  (`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_, *REQUIRED*) Specifies whether the filter operates in pass through mode or not.
  
  
.. _envoy_api_field_config.filter.http.health_check.v2.HealthCheck.endpoint:

endpoint
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) Specifies the incoming HTTP endpoint that should be considered the
  health check endpoint. For example */healthcheck*.
  
  
.. _envoy_api_field_config.filter.http.health_check.v2.HealthCheck.cache_time:

cache_time
  (`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_) If operating in pass through mode, the amount of time in milliseconds
  that the filter should cache the upstream response.
  
  
.. _envoy_api_field_config.filter.http.health_check.v2.HealthCheck.cluster_min_healthy_percentages:

cluster_min_healthy_percentages
  (map<`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, :ref:`type.Percent <envoy_api_msg_type.Percent>`>) If operating in non-pass-through mode, specifies a set of upstream cluster
  names and the minimum percentage of servers in each of those clusters that
  must be healthy in order for the filter to return a 200.