Create Proxy Host With Letsencrypt
create_proxy_host_with_letsencryptRequest a Let's Encrypt certificate, then create a proxy host with HTTPS forced for new TLS-enabled hosts; use when no certificate exists yet.
Instructions
Request a Let's Encrypt certificate, then create a proxy host using that certificate with HTTPS forced. Use this for a new TLS-enabled proxy; use create_proxy_host when a certificate already exists or HTTPS forcing is not wanted. This triggers a certificate request before creating the host; failures report failed_step and any created certificate. Returns ok plus certificate and proxy_host objects on success. Set dry_run=True to preview the exact request without changing NPM.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | Email address supplied to Let's Encrypt for certificate requests. | ||
| dry_run | No | When True, return the exact request preview without changing NPM. | |
| 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. | |
| 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 | |||