File: omhttp-httpheaders.rst

package info (click to toggle)
rsyslog 8.2512.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,464 kB
  • sloc: ansic: 123,809; sh: 42,109; makefile: 5,962; javascript: 1,842; python: 1,222; lex: 607; yacc: 193; perl: 162; sql: 103; tcl: 9; ruby: 2
file content (48 lines) | stat: -rw-r--r-- 1,150 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
.. _param-omhttp-httpheaders:
.. _omhttp.parameter.input.httpheaders:

httpheaders
===========

.. index::
   single: omhttp; httpheaders
   single: httpheaders

.. summary-start

Configures an array of additional HTTP headers that omhttp sends with each request.

.. summary-end

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

:Name: httpheaders
:Scope: input
:Type: array
:Default: input=none
:Required?: no
:Introduced: Not specified

Description
-----------
An array of strings that defines a list of one or more HTTP headers to send with each message. Keep in mind that some HTTP headers are added using other parameters. ``Content-Type`` can be configured using :ref:`param-omhttp-httpcontenttype`, and ``Content-Encoding: gzip`` is added when using the :ref:`param-omhttp-compress` parameter.

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

.. code-block:: rsyslog

   module(load="omhttp")

   action(
       type="omhttp"
       httpHeaders=[
           "X-Insert-Key: key",
           "X-Event-Source: logs"
       ]
   )

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