github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/processors/http.md

---
title: http
type: processor
status: stable
categories: ["Integration"]
---

<!--
     THIS FILE IS AUTOGENERATED!

     To make changes please edit the contents of:
     lib/processor/http.go
-->

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


Performs an HTTP request using a message batch as the request body, and replaces
the original message parts with the body of the response.


<Tabs defaultValue="common" values={[
  { label: 'Common', value: 'common', },
  { label: 'Advanced', value: 'advanced', },
]}>

<TabItem value="common">

```yaml
# Common config fields, showing default values
label: ""
http:
  url: http://localhost:4195/post
  verb: POST
  headers:
    Content-Type: application/octet-stream
  rate_limit: ""
  timeout: 5s
  parallel: false
```

</TabItem>
<TabItem value="advanced">

```yaml
# All config fields, showing default values
label: ""
http:
  url: http://localhost:4195/post
  verb: POST
  headers:
    Content-Type: application/octet-stream
  metadata:
    include_prefixes: []
    include_patterns: []
  oauth:
    enabled: false
    consumer_key: ""
    consumer_secret: ""
    access_token: ""
    access_token_secret: ""
    request_url: ""
  oauth2:
    enabled: false
    client_key: ""
    client_secret: ""
    token_url: ""
    scopes: []
  jwt:
    enabled: false
    private_key_file: ""
    signing_method: ""
    claims: {}
  basic_auth:
    enabled: false
    username: ""
    password: ""
  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: ""
  timeout: 5s
  retry_period: 1s
  max_retry_backoff: 300s
  retries: 3
  backoff_on:
    - 429
  drop_on: []
  successful_on: []
  proxy_url: ""
  parallel: false
```

</TabItem>
</Tabs>

If a processed message batch contains more than one message they will be sent in
a single request as a [multipart message](https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html).
Alternatively, message batches can be sent in parallel by setting the field
`parallel` to `true`.

The `rate_limit` field can be used to specify a rate limit
[resource](/docs/components/rate_limits/about) to cap the rate of requests
across all parallel components service wide.

The URL and header values of this type can be dynamically set using function
interpolations described [here](/docs/configuration/interpolation#bloblang-queries).

In order to map or encode the payload to a specific request body, and map the
response back into the original payload instead of replacing it entirely, you
can use the [`branch` processor](/docs/components/processors/branch).

## Response Codes

Benthos considers any response code between 200 and 299 inclusive to indicate a
successful response, you can add more success status codes with the field
`successful_on`.

When a request returns a response code within the `backoff_on` field
it will be retried after increasing intervals.

When a request returns a response code within the `drop_on` field it
will not be reattempted and is immediately considered a failed request.

## Adding Metadata

If the request returns an error response code this processor sets a metadata
field `http_status_code` on the resulting message.

Use the field `extract_headers` to specify rules for which other
headers should be copied into the resulting message from the response.

## Error Handling

When all retry attempts for a message are exhausted the processor cancels the
attempt. These failed messages will continue through the pipeline unchanged, but
can be dropped or placed in a dead letter queue according to your config, you
can read about these patterns [here](/docs/configuration/error_handling).

## Examples

<Tabs defaultValue="Branched Request" values={[
{ label: 'Branched Request', value: 'Branched Request', },
]}>

<TabItem value="Branched Request">


This example uses a [`branch` processor](/docs/components/processors/branch/) to strip the request message into an empty body, grab an HTTP payload, and place the result back into the original message at the path `repo.status`:

```yaml
pipeline:
  processors:
    - branch:
        request_map: 'root = ""'
        processors:
          - http:
              url: https://hub.docker.com/v2/repositories/jeffail/benthos
              verb: GET
        result_map: 'root.repo.status = this'
```

</TabItem>
</Tabs>

## Fields

### `url`

The URL to connect to.
This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries).


Type: `string`  
Default: `"http://localhost:4195/post"`  

### `verb`

A verb to connect with


Type: `string`  
Default: `"POST"`  

```yaml
# Examples

verb: POST

verb: GET

verb: DELETE
```

### `headers`

A map of headers to add to the request.
This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries).


Type: `object`  
Default: `{"Content-Type":"application/octet-stream"}`  

```yaml
# Examples

headers:
  Content-Type: application/octet-stream
```

### `metadata`

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


Type: `object`  

### `metadata.include_prefixes`

Provide a list of explicit metadata key prefixes to match against.


Type: `array`  
Default: `[]`  

```yaml
# Examples

include_prefixes:
  - foo_
  - bar_

include_prefixes:
  - kafka_

include_prefixes:
  - content-
```

### `metadata.include_patterns`

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


Type: `array`  
Default: `[]`  

```yaml
# Examples

include_patterns:
  - .*

include_patterns:
  - _timestamp_unix$
```

### `oauth`

Allows you to specify open authentication via OAuth version 1.


Type: `object`  

### `oauth.enabled`

Whether to use OAuth version 1 in requests.


Type: `bool`  
Default: `false`  

### `oauth.consumer_key`

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


Type: `string`  
Default: `""`  

### `oauth.consumer_secret`

A secret used to establish ownership of the consumer key.


Type: `string`  
Default: `""`  

### `oauth.access_token`

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


Type: `string`  
Default: `""`  

### `oauth.access_token_secret`

A secret provided in order to establish ownership of a given access token.


Type: `string`  
Default: `""`  

### `oauth.request_url`

The URL of the OAuth provider.


Type: `string`  
Default: `""`  

### `oauth2`

Allows you to specify open authentication via OAuth version 2 using the client credentials token flow.


Type: `object`  

### `oauth2.enabled`

Whether to use OAuth version 2 in requests.


Type: `bool`  
Default: `false`  

### `oauth2.client_key`

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


Type: `string`  
Default: `""`  

### `oauth2.client_secret`

A secret used to establish ownership of the client key.


Type: `string`  
Default: `""`  

### `oauth2.token_url`

The URL of the token provider.


Type: `string`  
Default: `""`  

### `oauth2.scopes`

A list of optional requested permissions.


Type: `array`  
Default: `[]`  
Requires version 3.45.0 or newer  

### `jwt`

BETA: Allows you to specify JWT authentication.


Type: `object`  

### `jwt.enabled`

Whether to use JWT authentication in requests.


Type: `bool`  
Default: `false`  

### `jwt.private_key_file`

A file with the PEM encoded via PKCS1 or PKCS8 as private key.


Type: `string`  
Default: `""`  

### `jwt.signing_method`

A method used to sign the token such as RS256, RS384 or RS512.


Type: `string`  
Default: `""`  

### `jwt.claims`

A value used to identify the claims that issued the JWT.


Type: `object`  
Default: `{}`  

### `basic_auth`

Allows you to specify basic authentication.


Type: `object`  

### `basic_auth.enabled`

Whether to use basic authentication in requests.


Type: `bool`  
Default: `false`  

### `basic_auth.username`

A username to authenticate as.


Type: `string`  
Default: `""`  

### `basic_auth.password`

A password to authenticate with.


Type: `string`  
Default: `""`  

### `tls`

Custom TLS settings can be used to override system defaults.


Type: `object`  

### `tls.enabled`

Whether custom TLS settings are enabled.


Type: `bool`  
Default: `false`  

### `tls.skip_cert_verify`

Whether to skip server side certificate verification.


Type: `bool`  
Default: `false`  

### `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`.


Type: `bool`  
Default: `false`  
Requires version 3.45.0 or newer  

### `tls.root_cas`

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.


Type: `string`  
Default: `""`  

```yaml
# Examples

root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----
```

### `tls.root_cas_file`

An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.


Type: `string`  
Default: `""`  

```yaml
# Examples

root_cas_file: ./root_cas.pem
```

### `tls.client_certs`

A list of client certificates to use. For each certificate either the fields `cert` and `key`, or `cert_file` and `key_file` should be specified, but not both.


Type: `array`  
Default: `[]`  

```yaml
# Examples

client_certs:
  - cert: foo
    key: bar

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

### `tls.client_certs[].cert`

A plain text certificate to use.


Type: `string`  
Default: `""`  

### `tls.client_certs[].key`

A plain text certificate key to use.


Type: `string`  
Default: `""`  

### `tls.client_certs[].cert_file`

The path to a certificate to use.


Type: `string`  
Default: `""`  

### `tls.client_certs[].key_file`

The path of a certificate key to use.


Type: `string`  
Default: `""`  

### `extract_headers`

Specify which response headers should be added to resulting messages as metadata. Header keys are lowercased before matching, so ensure that your patterns target lowercased versions of the header keys that you expect.


Type: `object`  

### `extract_headers.include_prefixes`

Provide a list of explicit metadata key prefixes to match against.


Type: `array`  
Default: `[]`  

```yaml
# Examples

include_prefixes:
  - foo_
  - bar_

include_prefixes:
  - kafka_

include_prefixes:
  - content-
```

### `extract_headers.include_patterns`

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


Type: `array`  
Default: `[]`  

```yaml
# Examples

include_patterns:
  - .*

include_patterns:
  - _timestamp_unix$
```

### `rate_limit`

An optional [rate limit](/docs/components/rate_limits/about) to throttle requests by.


Type: `string`  
Default: `""`  

### `timeout`

A static timeout to apply to requests.


Type: `string`  
Default: `"5s"`  

### `retry_period`

The base period to wait between failed requests.


Type: `string`  
Default: `"1s"`  

### `max_retry_backoff`

The maximum period to wait between failed requests.


Type: `string`  
Default: `"300s"`  

### `retries`

The maximum number of retry attempts to make.


Type: `int`  
Default: `3`  

### `backoff_on`

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.


Type: `array`  
Default: `[429]`  

### `drop_on`

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.


Type: `array`  
Default: `[]`  

### `successful_on`

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.


Type: `array`  
Default: `[]`  

### `proxy_url`

An optional HTTP proxy URL.


Type: `string`  
Default: `""`  

### `parallel`

When processing batched messages, whether to send messages of the batch in parallel, otherwise they are sent within a single request.


Type: `bool`  
Default: `false`