---
title: Http Client
slug: telemetry-pipeline/http-client
docTags: 
createdAt: 2025-04-20T17:04:22.091Z
---

## 🔐 Authentication (auth)

Specify how the HTTP source authenticates incoming requests.

- strategy (required):

Choose between basic or bearer.

- user (required for basic):

Username for basic auth.

- password (required for basic):

Password for basic auth.

- token (required for bearer):

Bearer token for authentication.



## 📥 Decoding (decoding)

Configure how to interpret the incoming payload.



- codec (default: bytes):

Choose how the payload should be decoded.

Options: bytes, avro, gelf, influxdb, json, native, native\_json, protobuf, syslog, vrl.



Codec-specific settings:

- avro:

schema: Avro schema string (required).

strip\_schema\_id\_prefix: Remove Confluent-style schema ID prefix.

- gelf, influxdb, json, native\_json, syslog:

lossy: Replace invalid UTF-8 sequences.

- protobuf:

desc\_file: Path to the descriptor set.

message\_type: Fully qualified message type.

- vrl:

source: VRL program to decode the message (required).

timezone: Timezone used for timestamp parsing (local by default).



## 🧱 Framing (framing)

Control how byte streams are split into messages.

- method (default: bytes):

Select the framing strategy.

Options: bytes, character\_delimited, chunked\_gelf, length\_delimited, newline\_delimited, octet\_counting.



Framing-specific settings:

- character\_delimited:

delimiter: ASCII character that separates frames (required).

- max\_length: Max size of a frame.

chunked\_gelf:

- decompression: How to decompress chunks (Auto, Gzip, Zlib, None; default: Auto).
- max\_length, pending\_messages\_limit, timeout\_secs (default: 5).

length\_delimited:

- length\_field\_is\_big\_endian (default: true)
- length\_field\_length, length\_field\_offset, max\_frame\_length

newline\_delimited and octet\_counting:

- max\_length: Max size of a frame.



## 🌐 Endpoint & Request Details

- endpoint (required):

Full URL path to receive incoming requests.

- method (default: GET):

HTTP method accepted (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD).

- headers:

Optional HTTP headers to expect.

- query:

Optional query parameters to expect.



## 📡 Scraping Settings

Use when pulling data from an HTTP endpoint.

- scrape\_interval\_secs (default: 15):

Time between scrape attempts.

- scrape\_timeout\_secs (default: 5):

Max time allowed per scrape.



### 🌍 Proxy (proxy)

Control proxy behavior for outgoing HTTP(S) requests.

- enabled (default: true):

Turn proxying on or off.

- http, https:

URIs of the proxy servers.

- no\_proxy:

List of domains or CIDRs that bypass the proxy.



### 🔒 TLS Settings (tls)

Secure the connection with TLS.

- enabled:

Enable TLS encryption.

- crt\_file, key\_file, key\_pass:

TLS certificate, key, and optional passphrase.

- ca\_file:

Additional trusted CA cert.

- server\_name:

Override for SNI.

- alpn\_protocols:

List of supported ALPN protocols.

- verify\_certificate:

Validate the client or server certificate.

- verify\_hostname:

Ensure the hostname matches the certificate.

![](https://api.archbee.com/api/optimize/g9cApVza9NIhSh0pjZYtA/wrsfnLE8Z58JG12vgnuhz_image.png)