Create Proxy Host
create_proxy_hostCreate a proxy host that routes domains to an HTTP or HTTPS upstream without requesting a certificate. Set dry_run=True to preview changes without altering NPM.
Instructions
Create a proxy host that routes the supplied domains to an HTTP or HTTPS upstream. Use this when configuring proxying without requesting a certificate; use create_proxy_host_with_letsencrypt to request one and force HTTPS. NPM stores the host configuration and applies it through its normal config handling. Returns the created host object with its ID, domains, and forwarding settings. Set dry_run=True to preview the exact request without changing NPM.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | When True, return the exact request preview without changing NPM. | |
| ssl_forced | No | Whether NPM redirects HTTP requests to HTTPS. | |
| domain_names | Yes | Domain names routed by this host or certificate. | |
| forward_host | Yes | Upstream hostname or IP address. | |
| forward_port | Yes | Upstream TCP port number. | |
| access_list_id | No | NPM access-list ID to attach; omit for no access list. | |
| block_exploits | No | Whether NPM enables its exploit-blocking option. | |
| certificate_id | No | NPM certificate ID to attach; omit for no certificate. | |
| forward_scheme | Yes | Upstream scheme: http or https. | |
| caching_enabled | No | Whether NPM enables proxy caching. | |
| allow_websocket_upgrade | No | Whether NPM allows WebSocket upgrades. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||