Connect

http_client

Sends messages to a HTTP server.

Common
Advanced

output:
  label: ""
  http_client:
    url: "" # No default (required)
    verb: POST
    headers: {}
    rate_limit: "" # No default (optional)
    timeout: 5s
    max_in_flight: 64
    batching:
      count: 0
      byte_size: 0
      period: ""
      check: ""

output:
  label: ""
  http_client:
    url: "" # No default (required)
    verb: POST
    headers: {}
    metadata:
      include_prefixes: []
      include_patterns: []
    dump_request_log_level: ""
    oauth:
      enabled: false
      consumer_key: ""
      consumer_secret: ""
      access_token: ""
      access_token_secret: ""
    oauth2:
      enabled: false
      client_key: ""
      client_secret: ""
      token_url: ""
      scopes: []
      endpoint_params: {}
    basic_auth:
      enabled: false
      username: ""
      password: ""
    jwt:
      enabled: false
      private_key_file: ""
      signing_method: ""
      claims: {}
      headers: {}
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []
    extract_headers:
      include_prefixes: []
      include_patterns: []
    rate_limit: "" # No default (optional)
    timeout: 5s
    retry_period: 1s
    max_retry_backoff: 300s
    retries: 3
    follow_redirects: true
    backoff_on:
      - 429
    drop_on: []
    successful_on: []
    proxy_url: "" # No default (optional)
    disable_http2: false
    batch_as_multipart: false
    propagate_response: false
    max_in_flight: 64
    batching:
      count: 0
      byte_size: 0
      period: ""
      check: ""
      processors: [] # No default (optional)
    multipart: []

Message sends

The body of the request sent to the HTTP server is the raw contents of the message payload. If the message has multiple parts (is a batch), the request is sent according to RFC1341. To disable this behavior, set the batch_as_multipart field to false.

When message retries are exhausted, this output rejects a message. Typically, a pipeline then continues attempts to send the message until it succeeds, whilst applying back pressure.

Dynamic URL and header settings

You can set the url and headers values dynamically using function interpolations.

Propagate responses

To propagate HTTP responses back to the input source, set the propagate_response field to true . This feature is only available for inputs that support synchronous responses.

Performance

For improved performance, this output sends:

Multiple messages in parallel. Adjust the max_in_flight field value to tune the maximum number of in-flight messages (or message batches).
Messages as batches. You can configure batches at both input and output level. For more information, see Message Batching.

Fields

`backoff_on[]`

A list of status codes that indicate a request failure and trigger retries with an increasing backoff period between attempts.

Type: array<int>

Default:

- 429

`basic_auth`

Configure basic authentication for requests from this component.

Type: object

`basic_auth.enabled`

Whether to use basic authentication in requests.

Type: bool

Default: false

`basic_auth.password`

The password to use for authentication. Used together with username for basic authentication.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`basic_auth.username`

The username of the account credentials to authenticate as. Used together with password for basic authentication.

Type: string

Default: ""

`batch_as_multipart`

When set to true, sends all messages in a batch as a single request using RFC1341.

When set to false, sends messages in a batch as individual requests.

Type: bool

Default: false

`batching`

Configure a batching policy.

Type: object

# Examples:
batching:
  byte_size: 5000
  count: 0
  period: 1s

# ---

batching:
  count: 10
  period: 1s

# ---

batching:
  check: this.contains("END BATCH")
  count: 0
  period: 1m

`batching.byte_size`

The maximum total size (in bytes) that a batch can reach before it is flushed. When the combined size of all messages in the batch reaches or exceeds this limit, the batch is immediately sent to the next stage (such as a processor or output).

Set to 0 to disable size-based batching. When disabled, messages are flushed based on other conditions (such as count or period).

Type: int

Default: 0

`batching.check`

A Bloblang query that returns a boolean value indicating whether a message should end a batch.

Type: string

Default: ""

# Examples:
check: this.type == "end_of_transaction"

`batching.count`

The number of messages at which the batch is flushed. Set to 0 to disable count-based batching.

Type: int

Default: 0

`batching.period`

The length of time after which an incomplete batch is flushed regardless of its size. This field accepts Go duration format strings such as 100ms, 1s, or 5s. Supported time units are ns, us, ms, s, m, and h.

Type: string

Default: ""

# Examples:
period: 1s

# ---

period: 1m

# ---

period: 500ms

`batching.processors[]`

A list of processors to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. All resulting messages are flushed as a single batch, so splitting the batch into smaller batches with these processors has no effect.

Type: array<processor>

# Examples:
processors:
  - archive:
      format: concatenate


# ---

processors:
  - archive:
      format: lines


# ---

processors:
  - archive:
      format: json_array

`disable_http2`

Whether to disable HTTP/2. By default, HTTP/2 is enabled.

Requires version 4.47.0 or later.

Type: bool

Default: false

`drop_on[]`

A list of status codes that indicate a request failure where retries should not be attempted. This helps avoid unnecessary retries for requests that are unlikely to succeed.

In these cases, the request is dropped, but the message that triggered the request is retained.

Type: array<int>

Default: []

`dump_request_log_level`

EXPERIMENTAL: Set the logging level for the request and response payloads of each HTTP request.

Requires version 4.12.0 or later.

Type: string

Default: ""

Options: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, ""

`extract_headers`

Specify which response headers to add to the resulting synchronous response messages as metadata. Header keys are automatically converted to lowercase before matching, so make sure that your patterns target the lowercase versions of the expected header keys.

This field is only applicable when propagate_response is set to true.

Type: object

`extract_headers.include_patterns[]`

A list of explicit metadata key regular expression (re2) patterns to match against.

Type: array<string>

Default: []

# Examples:
include_patterns:
  - .*

# ---

include_patterns:
  - _timestamp_unix$

`extract_headers.include_prefixes[]`

A list of explicit metadata key prefixes to match against.

Type: array<string>

Default: []

# Examples:
include_prefixes:
  - foo_
  - bar_

# ---

include_prefixes:
  - kafka_

# ---

include_prefixes:
  - content-

`follow_redirects`

Whether to transparently follow redirects, that is, responses with HTTP status codes in the 300-399 range. If set to false, the response message includes the body, status, and headers from the redirect response, and the component does not make a request to the URL specified in the Location header.

Requires version 4.39.0 or later.

Type: bool

Default: true

`headers`

A map of headers to add to the request.

This field supports interpolation functions.

Type: object<string>

Default: {}

# Examples:
headers:
  Content-Type: application/octet-stream
  traceparent: ${! tracing_span().traceparent }

`jwt`

Beta

Configure JSON Web Token (JWT) authentication. This feature is in beta and may change in future releases. JWTs provide secure, stateless authentication between services.

Type: object

`jwt.claims`

A map of claims to include in the JWT. Claims pass the identity of the authenticated entity to the service provider.

Type: object

Default: {}

`jwt.enabled`

Whether to use JWT authentication in requests.

Type: bool

Default: false

`jwt.headers`

Additional key-value pairs to include in the JWT header (optional). These headers provide extra metadata for JWT processing.

Type: object

Default: {}

`jwt.private_key_file`

Path to a file containing the PEM-encoded private key using PKCS#1 or PKCS#8 format. The private key must be compatible with the algorithm specified in the signing_method field.

Type: string

Default: ""

`jwt.signing_method`

The cryptographic algorithm used to sign the JWT. Supported algorithms are RS256, RS384, RS512, and EdDSA. This algorithm must be compatible with the private key specified in the private_key_file field.

Type: string

Default: ""

`max_in_flight`

The maximum number of parallel message batches to have in flight at any given time. Increase this value to improve throughput.

Type: int

Default: 64

`max_retry_backoff`

The maximum period to wait between failed requests.

Type: string

Default: 300s

`metadata`

Specify matching rules that determine which metadata keys should be added to the HTTP request as headers.

Type: object

`metadata.include_patterns[]`

A list of explicit metadata key regular expression (re2) patterns to match against.

Type: array<string>

Default: []

# Examples:
include_patterns:
  - .*

# ---

include_patterns:
  - _timestamp_unix$

`metadata.include_prefixes[]`

A list of explicit metadata key prefixes to match against.

Type: array<string>

Default: []

# Examples:
include_prefixes:
  - foo_
  - bar_

# ---

include_prefixes:
  - kafka_

# ---

include_prefixes:
  - content-

`multipart[]`

EXPERIMENTAL: Create explicit multipart HTTP requests by specifying an array of parts to add to a request. Each part consists of content headers and a data field, which can be populated dynamically.

If populated, this field overrides the default request creation behavior.

Requires version 3.63.0 or later.

Type: array<object>

Default: []

`multipart[].body`

The body of the individual message part.

This field supports interpolation functions.

Type: string

Default: ""

# Examples:
body: ${! this.data.part1 }

`multipart[].content_disposition`

The content disposition of the individual message part.

This field supports interpolation functions.

Type: string

Default: ""

# Examples:
content_disposition: form-data; name="bin"; filename='${! @AttachmentName }

`multipart[].content_type`

The content type of the individual message part.

This field supports interpolation functions.

Type: string

Default: ""

# Examples:
content_type: application/bin

`oauth`

Configure OAuth version 1.0 authentication for secure API access.

Type: object

`oauth.access_token`

The value used to gain access to the protected resources on behalf of the user.

Type: string

Default: ""

`oauth.access_token_secret`

The secret that establishes ownership of the access_token in OAuth 1.0 authentication.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`oauth.consumer_key`

The value used to identify this component or client to the service provider.

Type: string

Default: ""

`oauth.consumer_secret`

The secret that establishes ownership of the consumer key in OAuth 1.0 authentication.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`oauth.enabled`

Whether to enable OAuth version 1.0 authentication for requests.

Type: bool

Default: false

`oauth2`

Configures authentication with OAuth version 2 using the client credentials token flow. To exchange a refresh token instead, add a grant_type parameter with the value refresh_token and a refresh_token parameter with the token to endpoint_params.

Type: object

`oauth2.client_key`

A value used to identify the client to the token provider.

Type: string

Default: ""

`oauth2.client_secret`

The secret used to establish ownership of the client key.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`oauth2.enabled`

Whether to use OAuth version 2 in requests.

Type: bool

Default: false

`oauth2.endpoint_params`

A map of optional parameters to send to the token provider with client credentials token requests. Each value must be an array of strings.

Requires version 4.21.0 or later.

Type: object

Default: {}

# Examples:
endpoint_params:
  audience:
    - https://example.com
  resource:
    - https://api.example.com

`oauth2.scopes[]`

A list of requested permissions (optional).

Requires version 3.45.0 or later.

Type: array<string>

Default: []

`oauth2.token_url`

The URL of the token provider.

Type: string

Default: ""

`propagate_response`

Whether to propagate server responses back to the input.

Type: bool

Default: false

`proxy_url`

An HTTP proxy URL (optional).

Type: string

`rate_limit`

A rate limit to throttle requests by (optional).

Type: string

`retries`

The maximum number of retry attempts to make.

Type: int

Default: 3

`retry_period`

The period to wait between failed requests before retrying. For status codes listed in backoff_on, this is the starting period, which increases with each attempt up to max_retry_backoff.

Type: string

Default: 1s

`successful_on[]`

A list of HTTP status codes that should be considered successful, even if they are not 2XX codes. This is useful for handling cases where non-2XX codes indicate that the request was processed successfully, such as 303 See Other or 409 Conflict.

By default, all 2XX codes are considered successful unless they are specified in the backoff_on or drop_on fields, regardless of this field.

Type: array<int>

Default: []

`timeout`

A static timeout to apply to requests.

Type: string

Default: 5s

`tls`

Configure Transport Layer Security (TLS) settings to secure network connections. This includes options for standard TLS as well as mutual TLS (mTLS) authentication where both client and server authenticate each other using certificates. Key configuration options include enabled to enable TLS, client_certs for mTLS authentication, root_cas/root_cas_file for custom certificate authorities, and skip_cert_verify for development environments.

Type: object

`tls.client_certs[]`

A list of client certificates for mutual TLS (mTLS) authentication. Configure this field to enable mTLS, authenticating the client to the server with these certificates.

You must set tls.enabled: true for the client certificates to take effect.

Certificate pairing rules: For each certificate item, provide either:

Inline PEM data using both cert and key or
File paths using both cert_file and key_file.

Mixing inline and file-based values within the same item is not supported.

Type: array<object>

Default: []

# Examples:
client_certs:
  - cert: foo
    key: bar


# ---

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key

`tls.client_certs[].cert`

The plaintext certificate to use for TLS authentication. Must be paired with the corresponding private key in the key field when using inline PEM data for mTLS client certificates.

Type: string

Default: ""

`tls.client_certs[].cert_file`

The path to a file containing the certificate to use for TLS authentication. Must be paired with the corresponding private key file in the key_file field when using file-based configuration for mTLS client certificates.

Type: string

Default: ""

`tls.client_certs[].key`

Private key for mTLS client certificate as inline PEM data. Must correspond to the client certificate specified in the cert field. Use this field together with cert when providing certificate data inline rather than through files.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`tls.client_certs[].key_file`

Path to private key file for mTLS client certificate in PEM format. Must correspond to the client certificate specified in the cert_file field. Use this field together with cert_file when loading certificate data from files.

Type: string

Default: ""

`tls.client_certs[].password`

The password to use for the private key (specified in the key or key_file fields), if it is password-protected. The PKCS#1 and PKCS#8 formats are supported. Supports environment variable interpolation for secure password management.

The pbeWithMD5AndDES-CBC algorithm is obsolete and not supported for the PKCS#8 format. This algorithm does not authenticate the ciphertext, making it vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Requires version 4.3.0 or later.

Type: string

Default: ""

# Examples:
password: foo

# ---

password: ${KEY_PASSWORD}

`tls.enable_renegotiation`

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.

Requires version 3.45.0 or later.

Type: bool

Default: false

`tls.enabled`

Whether to enable TLS for secure connections. Set to true to enable TLS encryption. Required to be true for other TLS options (like client_certs, root_cas, etc.) to take effect.

Type: bool

Default: false

`tls.root_cas`

Specify a root certificate authority to use (optional). This is a string that represents a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for inline certificate data or root_cas_file for file-based certificate loading.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

# Examples:
root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----

`tls.root_cas_file`

Specify the path to a root certificate authority file (optional). This is a file, often with a .pem extension, which contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for file-based certificate loading or root_cas for inline certificate data.

Type: string

Default: ""

# Examples:
root_cas_file: ./root_cas.pem

`tls.skip_cert_verify`

Whether to skip server-side certificate verification. Set to true only for testing environments as this reduces security by disabling certificate validation. When using self-signed certificates or in development, this may be necessary, but should never be used in production. Consider using root_cas or root_cas_file to specify trusted certificates instead of disabling verification entirely.

Type: bool

Default: false

`url`

The URL to connect to.

This field supports interpolation functions.

Type: string

`verb`

A verb to connect with.

Type: string

Default: POST

# Examples:
verb: POST

# ---

verb: GET

# ---

verb: DELETE

Was this helpful?

group Ask in the community

mail Share your feedback

What do you think of this page?

Let us know more:

Let us contact you about your feedback:

http_client

Message sends

Dynamic URL and header settings

Propagate responses

Performance

Fields

backoff_on[]

basic_auth

basic_auth.enabled

basic_auth.password

basic_auth.username

batch_as_multipart

batching

batching.byte_size

batching.check

batching.count

batching.period

batching.processors[]

disable_http2

drop_on[]

dump_request_log_level

extract_headers

extract_headers.include_patterns[]

extract_headers.include_prefixes[]

follow_redirects

headers

jwt

jwt.claims

jwt.enabled

jwt.headers

jwt.private_key_file

jwt.signing_method

max_in_flight

max_retry_backoff

metadata

metadata.include_patterns[]

metadata.include_prefixes[]

multipart[]

multipart[].body

multipart[].content_disposition

multipart[].content_type

oauth

oauth.access_token

oauth.access_token_secret

oauth.consumer_key

oauth.consumer_secret

oauth.enabled

oauth2

oauth2.client_key

oauth2.client_secret

oauth2.enabled

oauth2.endpoint_params

oauth2.scopes[]

oauth2.token_url

propagate_response

proxy_url

rate_limit

retries

retry_period

successful_on[]

timeout

tls

tls.client_certs[]

tls.client_certs[].cert

tls.client_certs[].cert_file

tls.client_certs[].key

tls.client_certs[].key_file

tls.client_certs[].password

tls.enable_renegotiation

tls.enabled

tls.root_cas

tls.root_cas_file

tls.skip_cert_verify

url

verb

`backoff_on[]`

`basic_auth`

`basic_auth.enabled`

`basic_auth.password`

`basic_auth.username`

`batch_as_multipart`

`batching`

`batching.byte_size`

`batching.check`

`batching.count`

`batching.period`

`batching.processors[]`

`disable_http2`

`drop_on[]`

`dump_request_log_level`

`extract_headers`

`extract_headers.include_patterns[]`

`extract_headers.include_prefixes[]`

`follow_redirects`

`headers`

`jwt`

`jwt.claims`

`jwt.enabled`

`jwt.headers`

`jwt.private_key_file`

`jwt.signing_method`

`max_in_flight`

`max_retry_backoff`

`metadata`

`metadata.include_patterns[]`

`metadata.include_prefixes[]`

`multipart[]`

`multipart[].body`

`multipart[].content_disposition`

`multipart[].content_type`

`oauth`

`oauth.access_token`

`oauth.access_token_secret`

`oauth.consumer_key`

`oauth.consumer_secret`

`oauth.enabled`

`oauth2`

`oauth2.client_key`

`oauth2.client_secret`

`oauth2.enabled`

`oauth2.endpoint_params`

`oauth2.scopes[]`

`oauth2.token_url`

`propagate_response`

`proxy_url`

`rate_limit`

`retries`

`retry_period`

`successful_on[]`

`timeout`

`tls`

`tls.client_certs[]`

`tls.client_certs[].cert`

`tls.client_certs[].cert_file`

`tls.client_certs[].key`

`tls.client_certs[].key_file`

`tls.client_certs[].password`

`tls.enable_renegotiation`

`tls.enabled`

`tls.root_cas`

`tls.root_cas_file`

`tls.skip_cert_verify`

`url`

`verb`