Skip to content

Commit 3d3b9e7

Browse files
committed
docs(api): document the Proxy URL advanced field and steer proxy credentials to env vars
1 parent 6361b31 commit 3d3b9e7

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

  • apps
    • docs/content/docs/en/workflows/blocks
    • sim/blocks/blocks

apps/docs/content/docs/en/workflows/blocks/api.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ The request payload for POST, PUT, and PATCH, sent as JSON. Type it directly, or
4040
- **Retries.** Number of retry attempts on timeouts, `429` responses, and `5xx` errors. Defaults to 0.
4141
- **Retry delay / Max retry delay (ms).** The exponential-backoff bounds used between retries.
4242
- **Retry non-idempotent methods.** Off by default, so POST and PATCH are not retried, which avoids duplicate writes. Turn it on only when a repeated request is safe.
43+
- **Proxy URL.** Optional `http://` proxy the request egresses through, such as a residential proxy for targets that block datacenter IPs. The proxy host must be publicly reachable, and only the `http://` scheme is supported (an `https://` target still tunnels through it securely). Keep proxy credentials in an environment variable and reference it as `{{PROXY_URL}}` rather than typing them into the field.
4344

4445
## Outputs
4546

apps/sim/blocks/blocks/api.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,9 @@ Example:
127127
id: 'proxyUrl',
128128
title: 'Proxy URL',
129129
type: 'short-input',
130-
placeholder: 'http://user:pass@proxy.host:port',
130+
placeholder: 'http://user:pass@proxy.host:port or {{PROXY_URL}}',
131131
description:
132-
'Optional. Route this request through an http:// proxy (e.g. a residential proxy). Must be http://; the proxy host must be publicly reachable.',
132+
'Optional. Route this request through an http:// proxy (e.g. a residential proxy). Must be http://; the proxy host must be publicly reachable. Keep credentials in an environment variable and reference it like {{PROXY_URL}}.',
133133
mode: 'advanced',
134134
},
135135
],

0 commit comments

Comments
 (0)