Proxies
Commands for managing Pre-Configured Proxies.
List Proxies
bt proxies
Lists all Proxies in your tenant with pagination. When run interactively, selecting a Proxy provides options to view details, stream logs, or delete.
Flags
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--management-key | -x | string | BT_MANAGEMENT_KEY env var | Management API key |
--page | -p | integer | 1 | Page number to fetch |
Required Permissions
proxy:read
Example
bt proxies -p 2
Create Proxy
bt proxies create
Creates a new Pre-Configured Proxy. When flags are omitted, the CLI will interactively prompt for required values.
Flags
Basic
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--management-key | -x | string | BT_MANAGEMENT_KEY env var | Management API key |
--name | -n | string | (prompted) | Name of the Proxy |
--destination-url | -u | string | (prompted) | URL to which requests will be proxied |
--application-id | -i | string | — | Application ID (required for node-bt transforms) |
--configuration | -c | file path | — | Path to .env format configuration file |
--require-auth | -a | boolean | true | Require Basis Theory authentication |
Request Transform
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--request-transform-code | -q | file path | — | Path to JavaScript file with request transform logic |
--request-transform-image | string | — | Runtime image: node-bt or node22 | |
--request-transform-timeout | integer | 10 | Timeout in seconds, 1–30 (node22 only) | |
--request-transform-warm-concurrency | integer | 0 | Warm instances, 0–1 (node22 only) | |
--request-transform-resources | string | standard | Resource tier: standard, large, xlarge (node22 only) | |
--request-transform-dependencies | file path | — | Path to JSON dependencies file (node22 only) | |
--request-transform-permissions | string[] | — | Permission grants, repeatable (node22 only) |
Response Transform
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--response-transform-code | -s | file path | — | Path to JavaScript file with response transform logic |
--response-transform-image | string | — | Runtime image: node-bt or node22 | |
--response-transform-timeout | integer | 10 | Timeout in seconds, 1–30 (node22 only) | |
--response-transform-warm-concurrency | integer | 0 | Warm instances, 0–1 (node22 only) | |
--response-transform-resources | string | standard | Resource tier: standard, large, xlarge (node22 only) | |
--response-transform-dependencies | file path | — | Path to JSON dependencies file (node22 only) | |
--response-transform-permissions | string[] | — | Permission grants, repeatable (node22 only) |
Advanced
| Flag | Type | Default | Description |
|---|---|---|---|
--async | boolean | false | Don't wait for the Proxy to be ready (node22 only) |
node-bt runtime requires --application-id for transforms. The node22 runtime does not.--async flag is only valid when at least one transform uses the node22 runtime.Required Permissions
proxy:create
Examples
Create a Proxy with a node22 request transform:
bt proxies create \
-n "My Proxy" \
-u "https://api.example.com" \
--request-transform-code ./request.js \
--request-transform-image node22 \
--request-transform-dependencies ./package.json \
--request-transform-timeout 15
Create a Proxy with legacy node-bt transform:
bt proxies create \
-n "My Proxy" \
-u "https://api.example.com" \
-i "your-application-id" \
--request-transform-code ./request.js \
--request-transform-image node-bt
Update Proxy
bt proxies update <id>
Updates an existing Proxy.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | The Proxy ID to update |
Flags
All flags from Create Proxy, plus:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--watch | -w | boolean | false | Watch code and configuration files for changes and auto-update |
--logs | -l | boolean | false | Stream logs after update |
--watch flag monitors your code and configuration files for changes, automatically redeploying when files are saved. This is useful during development.Required Permissions
proxy:update
Examples
Update and watch for file changes:
bt proxies update 03858bf5-32d3-4a2e-b74b-daeea0883bca \
--request-transform-code ./request.js \
-w
Update and stream logs:
bt proxies update 03858bf5-32d3-4a2e-b74b-daeea0883bca \
--request-transform-code ./request.js \
-l
Delete Proxy
bt proxies delete <id>
Deletes a Proxy. By default, the CLI will prompt for confirmation before deleting.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | The Proxy ID to delete |
Flags
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--management-key | -x | string | BT_MANAGEMENT_KEY env var | Management API key |
--yes | -y | boolean | false | Skip confirmation prompt |
Required Permissions
proxy:delete
Example
bt proxies delete 03858bf5-32d3-4a2e-b74b-daeea0883bca -y
Proxy Logs
bt proxies logs [id]
Streams real-time logs from a Proxy. If no ID is provided, the CLI will prompt you to select a Proxy from a list.
Arguments
| Argument | Required | Description |
|---|---|---|
id | No | The Proxy ID to stream logs from |
Flags
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--management-key | -x | string | BT_MANAGEMENT_KEY env var | Management API key |
--port | -p | integer | — | Port for the local logs server |
proxy:update permission, not just proxy:read.Required Permissions
proxy:update
Example
bt proxies logs 03858bf5-32d3-4a2e-b74b-daeea0883bca -p 3000