.. _param-omhttp-httpheaderkey:
.. _omhttp.parameter.input.httpheaderkey:

httpheaderkey
=============

.. index::
   single: omhttp; httpheaderkey
   single: httpheaderkey

.. summary-start

Defines the single custom HTTP header name to send with each omhttp request.

.. summary-end

This parameter applies to :doc:`../../configuration/modules/omhttp`.

:Name: httpheaderkey
:Scope: input
:Type: word
:Default: input=none
:Required?: no
:Introduced: Not specified

Description
-----------
The header key. Currently only a single additional header/key pair is configurable with this parameter. To specify multiple headers use the :ref:`param-omhttp-httpheaders` parameter. This parameter, along with :ref:`param-omhttp-httpheadervalue`, may be deprecated in the future.

Input usage
-----------
.. _omhttp.parameter.input.httpheaderkey-usage:

.. code-block:: rsyslog

   module(load="omhttp")

   action(
       type="omhttp"
       httpHeaderKey="X-Event-Source"
       httpHeaderValue="logs"
   )

See also
--------
See also :doc:`../../configuration/modules/omhttp`.