.. _envoy_v3_api_file_envoy/admin/v3/tap.proto:

Tap
===


.. _envoy_v3_api_msg_admin.v3.TapRequest:

admin.v3.TapRequest
-------------------

`[admin.v3.TapRequest proto] <https://github.com/envoyproxy/envoy/blob/v1.14.0/api/envoy/admin/v3/tap.proto#L18>`_

The /tap admin request body that is used to configure an active tap session.

.. code-block:: json

  {
    "config_id": "...",
    "tap_config": "{...}"
  }

.. _envoy_v3_api_field_admin.v3.TapRequest.config_id:

config_id
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The opaque configuration ID used to match the configuration to a loaded extension.
  A tap extension configures a similar opaque ID that is used to match.
  
  
.. _envoy_v3_api_field_admin.v3.TapRequest.tap_config:

tap_config
  (:ref:`config.tap.v3.TapConfig <envoy_v3_api_msg_config.tap.v3.TapConfig>`, *REQUIRED*) The tap configuration to load.