:plugin: http
:type: input
:default_codec: plain

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Http input plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

Using this input you can receive single or multiline events over http(s).
Applications can send an HTTP POST request with a body to the endpoint started by this
input and Logstash will convert it into an event for subsequent processing. Users 
can pass plain text, JSON, or any formatted data and use a corresponding codec with this
input. For Content-Type `application/json` the `json` codec is used, but for all other
data formats, `plain` codec is used.

This input can also be used to receive webhook requests to integrate with other services
and applications. By taking advantage of the vast plugin ecosystem available in Logstash
you can trigger actionable events right from your application.

==== Blocking Behavior

The HTTP protocol doesn't deal well with long running requests. This plugin will either return 
a 429 (busy) error when Logstash is backlogged, or it will time out the request. 

If a 429 error is encountered clients should sleep, backing off exponentially with some random 
jitter, then retry their request.

This plugin will block if the Logstash queue is blocked and there are available HTTP input threads.
This will cause most HTTP clients to time out. Sent events will still be processed in this case. This
behavior is not optimal and will be changed in a future release. In the future, this plugin will always 
return a 429 if the queue is busy, and will not time out in the event of a busy queue. 

==== Security
This plugin supports standard HTTP basic authentication headers to identify the requester.
You can pass in a username, password combination while sending data to this input

You can also setup SSL and send data securely over https, with an option of validating 
the client's certificate. Currently, the certificate setup is through 
https://docs.oracle.com/cd/E19509-01/820-3503/ggfen/index.html[Java Keystore 
format]


[id="plugins-{type}s-{plugin}-options"]
==== Http Input Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-additional_codecs>> |<<hash,hash>>|No
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-keystore>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-response_headers>> |<<hash,hash>>|No
| <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-verify_mode>> |<<string,string>>, one of `["none", "peer", "force_peer"]`|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
input plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-additional_codecs"]
===== `additional_codecs` 

  * Value type is <<hash,hash>>
  * Default value is `{"application/json"=>"json"}`

Apply specific codecs for specific content types.
The default codec will be applied only after this list is checked
and no codec for the request's content-type is found

[id="plugins-{type}s-{plugin}-host"]
===== `host` 

  * Value type is <<string,string>>
  * Default value is `"0.0.0.0"`

The host or ip to bind

[id="plugins-{type}s-{plugin}-keystore"]
===== `keystore` 

  * Value type is <<path,path>>
  * There is no default value for this setting.

The JKS keystore to validate the client's certificates

[id="plugins-{type}s-{plugin}-keystore_password"]
===== `keystore_password` 

  * Value type is <<password,password>>
  * There is no default value for this setting.

Set the truststore password

[id="plugins-{type}s-{plugin}-password"]
===== `password` 

  * Value type is <<password,password>>
  * There is no default value for this setting.

Password for basic authorization

[id="plugins-{type}s-{plugin}-port"]
===== `port` 

  * Value type is <<number,number>>
  * Default value is `8080`

The TCP port to bind to

[id="plugins-{type}s-{plugin}-response_headers"]
===== `response_headers` 

  * Value type is <<hash,hash>>
  * Default value is `{"Content-Type"=>"text/plain"}`

specify a custom set of response headers

[id="plugins-{type}s-{plugin}-ssl"]
===== `ssl` 

  * Value type is <<boolean,boolean>>
  * Default value is `false`

SSL Configurations

Enable SSL

[id="plugins-{type}s-{plugin}-threads"]
===== `threads` 

  * Value type is <<number,number>>
  * Default value is `4`

Maximum number of threads to use

[id="plugins-{type}s-{plugin}-user"]
===== `user` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Username for basic authorization

[id="plugins-{type}s-{plugin}-verify_mode"]
===== `verify_mode` 

  * Value can be any of: `none`, `peer`, `force_peer`
  * Default value is `"none"`

Set the client certificate verification method. Valid methods: none, peer, force_peer



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:default_codec!: