.. _envoy_api_file_api/filter/http/health_check.proto:

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

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

.. _envoy_api_msg_filter.http.HealthCheck:

filter.http.HealthCheck
-----------------------

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


.. code-block:: json

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

.. _envoy_api_field_filter.http.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_filter.http.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_filter.http.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.