HTTP

NAME	RUNTIME	TYPE	VERSION
http_client	wombat	sink	latest

Sends messages to an HTTP server.

When the number of retries expires the output will reject the message, the behavior after this will depend on the pipeline but usually this simply means the send is attempted again until successful whilst applying back pressure.

The URL and header values of this type can be dynamically set using function interpolations described in Bloblang queries.

The body of the HTTP request is the raw contents of the message payload.

It's possible to propagate the response from each HTTP request back to the input source by setting propagate_response to true. Only inputs that support synchronous responses are able to make use of these propagated responses.

Configuration

Name	Type	Optional	Secret	Description
url	string	no	no	The URL to connect to.
verb	string	yes	no	A verb to connect with. The value defaults to `"POST"`.
headers	headers	yes	no	A map of headers to add to the request. The value defaults to `{}`.
metadata	metadata	no	no	Specify optional matching rules to determine which metadata keys should be added to the HTTP request as headers.
dump_request_log_level	string	yes	no	EXPERIMENTAL: Optionally set a level at which the request and response payload of each request made will be logged. The value should be one of `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL` or ``. The value defaults to `""`.
oauth	oauth	no	no	Allows you to specify open authentication via OAuth version 1.
oauth2	oauth2	no	no	Allows you to specify open authentication via OAuth version 2 using the client credentials token flow.
basic_auth	basic_auth	no	no	Allows you to specify basic authentication.
tls	tls	no	no	Custom TLS settings can be used to override system defaults.
extract_headers	extract_headers	no	no	Specify which response headers should be added to resulting synchronous response messages as metadata. Header keys are lowercased before matching, so ensure that your patterns target lowercased versions of the header keys that you expect. This field is not applicable unless `propagate_response` is set to `true`.
timeout	string	yes	no	A static timeout to apply to requests. The value defaults to `"5s"`.
retry_period	string	yes	no	The base period to wait between failed requests. The value defaults to `"1s"`.
max_retry_backoff	string	yes	no	The maximum period to wait between failed requests. The value defaults to `"300s"`.
retries	int	yes	no	The maximum number of retry attempts to make. The value defaults to `3`.
follow_redirects	bool	yes	no	Whether or not to transparently follow redirects, i.e. responses with 300-399 status codes. If disabled, the response message will contain the body, status, and headers from the redirect response and the processor will not make a request to the URL set in the Location header of the response. The value defaults to `true`.
backoff_on	[]int	yes	no	A list of status codes whereby the request should be considered to have failed and retries should be attempted, but the period between them should be increased gradually. The value defaults to `[429]`.
drop_on	[]int	yes	no	A list of status codes whereby the request should be considered to have failed but retries should not be attempted. This is useful for preventing wasted retries for requests that will never succeed. Note that with these status codes the request is dropped, but message that caused the request will not be dropped. The value defaults to `[]`.
successful_on	[]int	yes	no	A list of status codes whereby the attempt should be considered successful, this is useful for dropping requests that return non-2XX codes indicating that the message has been dealt with, such as a 303 See Other or a 409 Conflict. All 2XX codes are considered successful unless they are present within `backoff_on` or `drop_on`, regardless of this field. The value defaults to `[]`.
proxy_url	string	no	no	An optional HTTP proxy URL.
disable_http2	bool	yes	no	Whether or not to disable disable HTTP/2. The value defaults to `false`.
batch_as_multipart	bool	yes	no	Send message batches as a single request using https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html[RFC1341^]. If disabled messages in batches will be sent as individual requests. The value defaults to `false`.
propagate_response	bool	yes	no	Whether responses from the server should be propagated back to the input. The value defaults to `false`.
max_in_flight	int	yes	no	The maximum number of parallel message batches to have in flight at any given time. The value defaults to `64`.
batching	batching	no	no	Allows you to configure a batching policy.

Headers

Name	Type	Optional	Secret	Description

Metadata

Name	Type	Optional	Secret	Description
include_prefixes	[]string	yes	no	Provide a list of explicit metadata key prefixes to match against. The value defaults to `[]`.
include_patterns	[]string	yes	no	Provide a list of explicit metadata key regular expression (re2) patterns to match against. The value defaults to `[]`.

OAuth

Name	Type	Optional	Secret	Description
enabled	bool	yes	no	Whether to use OAuth version 1 in requests. The value defaults to `false`.
consumer_key	string	yes	no	A value used to identify the client to the service provider. The value defaults to `""`.
consumer_secret	string	yes	yes	A secret used to establish ownership of the consumer key. The value defaults to `""`.
access_token	string	yes	no	A value used to gain access to the protected resources on behalf of the user. The value defaults to `""`.
access_token_secret	string	yes	yes	A secret provided in order to establish ownership of a given access token. The value defaults to `""`.
enabled	bool	yes	no	Whether to use OAuth version 2 in requests. The value defaults to `false`.
client_key	string	yes	no	A value used to identify the client to the token provider. The value defaults to `""`.
client_secret	string	yes	yes	A secret used to establish ownership of the client key. The value defaults to `""`.
token_url	string	yes	no	The URL of the token provider. The value defaults to `""`.
scopes	[]string	yes	no	A list of optional requested permissions. The value defaults to `[]`.
endpoint_params	endpoint_params	yes	no	A list of optional endpoint parameters, values should be arrays of strings. The value defaults to `{}`.

OAuth2

Name	Type	Optional	Secret	Description
enabled	bool	yes	no	Whether to use OAuth version 2 in requests. The value defaults to `false`.
client_key	string	yes	no	A value used to identify the client to the token provider. The value defaults to `""`.
client_secret	string	yes	yes	A secret used to establish ownership of the client key. The value defaults to `""`.
token_url	string	yes	no	The URL of the token provider. The value defaults to `""`.
scopes	[]string	yes	no	A list of optional requested permissions. The value defaults to `[]`.
endpoint_params	endpoint_params	yes	no	A list of optional endpoint parameters, values should be arrays of strings. The value defaults to `{}`.

Basic Auth

Name	Type	Optional	Secret	Description
enabled	bool	yes	no	Whether to use basic authentication in requests. The value defaults to `false`.
username	string	yes	no	A username to authenticate as. The value defaults to `""`.
password	string	yes	yes	A password to authenticate with. The value defaults to `""`.

TLS Configuration

Name	Type	Optional	Secret	Description
enabled	bool	yes	no	Whether custom TLS settings are enabled. The value defaults to `false`.
skip_cert_verify	bool	yes	no	Whether to skip server side certificate verification. The value defaults to `false`.
enable_renegotiation	bool	yes	no	Whether to allow the remote server to repeatedly request renegotiation.
				Enable this option if you're seeing the error message `local error: tls: no renegotiation`. The value defaults to `false`.
root_cas	string	yes	yes	An optional root certificate authority to use.
				This is a string, representing a certificate chain from the parent trusted root certificate,
				to possible intermediate signing certificates, to the host certificate. The value defaults to `""`.
client_certs	[]client_certs	yes	no	A list of client certificates to use. . The value defaults to `[]`.

Extract Headers

Name	Type	Optional	Secret	Description
include_prefixes	[]string	yes	no	Provide a list of explicit metadata key prefixes to match against. The value defaults to `[]`.
include_patterns	[]string	yes	no	Provide a list of explicit metadata key regular expression (re2) patterns to match against. The value defaults to `[]`.

Batching

Name	Type	Optional	Secret	Description
count	int	yes	no	A number of messages at which the batch should be flushed. If `0` disables count based batching. The value defaults to `0`.
byte_size	int	yes	no	An amount of bytes at which the batch should be flushed. If `0` disables size based batching. The value defaults to `0`.
period	string	yes	no	A period in which an incomplete batch should be flushed regardless of its size. The value defaults to `""`.
check	string	yes	no	A Bloblang query that should return a boolean value indicating whether a message should end a batch. The value defaults to `""`.