ContextQMD
Back to Genai Toolbox

HTTP Source

docs/en/integrations/http/source.md

1.5.03.9 KB
Original Source

About

The HTTP Source allows Toolbox to retrieve data from arbitrary HTTP endpoints. This enables Generative AI applications to access data from web APIs and other HTTP-accessible resources.

Available Tools

{{< list-tools >}}

Example

yaml
kind: source
name: my-http-source
type: http
baseUrl: https://api.example.com/data
timeout: 10s # default to 30s
headers:
  Authorization: Bearer ${API_KEY}
  Content-Type: application/json
queryParams:
  param1: value1
  param2: value2
# returnFullError: false
# disableSslVerification: false

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

Reference

fieldtyperequireddescription
typestringtrueMust be "http".
baseUrlstringtrueThe base URL for the HTTP requests (e.g., https://api.example.com).
timeoutstringfalseThe timeout for HTTP requests (e.g., "5s", "1m", refer to ParseDuration for more examples). Defaults to 30s.
headersmap[string]stringfalseDefault headers to include in the HTTP requests.
queryParamsmap[string]stringfalseDefault query parameters to include in the HTTP requests.
returnFullErrorboolfalseInclude raw upstream response bodies in error messages for non-2xx responses. Defaults to false.
disableSslVerificationboolfalseDisable SSL certificate verification. This should only be used for local development. Defaults to false.
allowPrivateNetworksboolfalseAllow requests and redirects to loopback and private networks (RFC 1918 / link-local). Defaults to false.
allowedIpRanges[]stringfalseList of IP addresses or CIDR blocks to explicitly allow (whitelisted overrides).
customBlockedIpRanges[]stringfalseList of IP addresses or CIDR blocks to explicitly block.

Advanced Usage

SSRF Protection (SSRF Guard)

By default, the HTTP source implements strict protection against Server-Side Request Forgery (SSRF) and DNS Rebinding (TOCTOU) attacks. It automatically intercepts, resolves, and blocks connection requests to private IP ranges, loopback ranges (such as 127.0.0.1), and link-local ranges (e.g. AWS/GCP metadata service at 169.254.169.254).

To override the default protection or block custom ranges, configure allowPrivateNetworks, allowedIpRanges, and customBlockedIpRanges:

yaml
kind: source
name: my-http-source
type: http
baseUrl: https://internal.corp/api
allowedIpRanges:
  - 10.0.0.0/24         # Explicitly trust internal subnet
customBlockedIpRanges:
  - 10.0.0.99           # Block a specific sensitive host inside the subnet