SETTINGS & DATA

Proxy Configuration

Named proxy profiles for routing HTTP and HTTPS traffic through intermediary servers — corporate proxies, debugging tools, and staging environments.

Overview

API Studio supports named proxy profiles for routing requests through HTTP/HTTPS proxy servers. Proxy profiles are managed centrally and referenced by requests — credentials never leak into saved collections.

Corporate proxies — route all traffic through your organization's proxy gateway

Debugging proxies — inspect traffic with Charles, Fiddler, or mitmproxy

Staging environments — route requests through environment-specific proxies

Storage: Proxy profiles are stored in .openpost/config.json. Credentials (username/password) are stored with the profile — they are never saved in collection files or individual requests.

Creating Profiles

Open the Settings popup (gear icon) → scroll to the Proxy section → click + Add Proxy.

Each profile contains:

name

Display label for the profile

protocol

http or https

host

Hostname or IP address

port

Port number (1024–65535)

username

Optional — for authenticated proxies

password

Optional — for authenticated proxies

Multiple profiles are supported. Common examples:

Corporate proxy.corp.com:8080

Debug localhost:8888

Configuration Fields

Field	Type	Description
name	string	Display label for the profile
protocol	'http' \| 'https'	Proxy protocol
host	string	Hostname or IP address
port	number	Port number (1024–65535)
username	string?	Optional — for authenticated proxies
password	string?	Optional — for authenticated proxies

Security note: Credentials are stored in config.json only — they are never written to collections.json or saved with individual requests. Safe to commit collections to git.

Default Proxy

Set one profile as the workspace default. All requests will route through the default proxy unless explicitly overridden per-request.

Select a profile in Settings → Proxy → click Set as Default

Choose No Proxy to bypass — requests go direct

Useful in corporate environments where all traffic must go through a gateway

Per-Request Proxy

Override the default proxy for individual requests via the Settings tab (Advanced Mode required).

The proxy dropdown shows:

Default None Corporate Debug ... all profiles

Saved with the request as proxyId (references ProxyConfig.id)

Only the reference is saved — credentials stay in config.json

Different tabs can use different proxies simultaneously

CLI Proxy

Manage proxy profiles from the command line:

Add a proxy profile

openpost proxy add "Corp" --host proxy.corp.com --port 8080

Set default proxy

openpost proxy set-default "Corp"

Override proxy on run commands

openpost run "My Collection" --proxy "Corp"

Data Storage → Settings →