Create Stream
create_streamForward raw TCP or UDP traffic from a public port to a destination host and port in Nginx Proxy Manager, with optional dry-run preview.
Instructions
Create a TCP/UDP port forward from an incoming port to a destination host and port. Use this for raw TCP or UDP forwarding; use proxy-host tools for HTTP/HTTPS domain routing. NPM stores the stream configuration and applies it through normal config handling. Returns the created stream object with its ID, ports, and protocol flags. 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. | |
| incoming_port | Yes | Public TCP/UDP port number accepted by this stream. | |
| tcp_forwarding | No | Whether this stream forwards TCP traffic. | |
| udp_forwarding | No | Whether this stream forwards UDP traffic. | |
| forwarding_host | Yes | Hostname or IP address receiving stream traffic. | |
| forwarding_port | Yes | Destination TCP/UDP port number. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||