Nginx Proxy Manager (NPM) icon

Nginx Proxy Manager (NPM)

Interact with your NPM instance
Join our community

Actions38

Overview

This node integrates with an Nginx Proxy Manager (NPM) instance to manage proxy hosts programmatically. Specifically, the Create Proxy Host operation allows users to define new proxy hosts that forward incoming requests to specified backend services. This is useful for automating the setup of reverse proxies, managing multiple domains, and configuring advanced routing rules without manual intervention in the NPM UI.

Common scenarios include:

  • Automatically provisioning proxy hosts for new web applications or microservices.
  • Managing domain forwarding and SSL settings at scale.
  • Configuring custom paths and advanced options for different backend services.

For example, you can create a proxy host that listens on multiple domain names and forwards traffic to an internal HTTP service running on a specific port, optionally enabling SSL, WebSocket support, and HTTP/2.

Properties

Name Meaning
Domain Names One or more domain names for the proxy host. Each domain is specified as a string.
Forward Host The hostname or IP address where the proxy will forward incoming requests.
Forward Port The port number on the forward host to which traffic will be sent.
Forward Scheme The protocol used when forwarding requests: either HTTP or HTTPS.
Options A collection of optional settings for the proxy host:
  Access List ID Numeric ID of an access list to restrict access to the proxy host.
  Certificate ID Numeric ID of an SSL certificate to use for HTTPS connections.
  SSL Forced Boolean flag to force SSL usage (redirect HTTP to HTTPS).
  Block Exploits Boolean flag to enable blocking of common exploits.
  Advanced Config Custom advanced configuration text for fine-tuning the proxy host behavior.
  Allow Websocket Upgrade Boolean flag to allow WebSocket protocol upgrades through the proxy.
  HTTP2 Support Boolean flag to enable HTTP/2 support.
  Forward Scheme Protocol used for forwarding inside locations (can override main forward scheme).
  Enabled Boolean flag to enable or disable the proxy host.
  HSTS Enable Boolean flag to enable HTTP Strict Transport Security headers.
  HSTS Subdomains Boolean flag to apply HSTS policy to subdomains.
  Locations One or more location blocks defining path-based forwarding rules. Each location includes:
    Path URL path prefix for this location (e.g., /api).
    Forward Scheme Protocol used for forwarding requests matching this location.
    Forward Host Hostname or IP to forward requests for this location.
    Forward Port Port number on the forward host for this location.
    Advanced Config Custom advanced configuration specific to this location.

Output

The node outputs JSON data representing the created proxy host resource as returned by the Nginx Proxy Manager API. This typically includes details such as:

  • The unique ID of the proxy host.
  • The configured domain names.
  • Forwarding details (host, port, scheme).
  • Status flags (enabled, SSL forced, etc.).
  • Any additional metadata or timestamps.

No binary data output is involved.

Dependencies

  • Requires an active Nginx Proxy Manager instance accessible via its REST API.
  • Requires credentials including:
    • The base URL of the NPM API.
    • An email and password for authentication to obtain an API token.
  • The node uses these credentials to authenticate and perform API calls.
  • No other external dependencies are required.

Troubleshooting

  • Login failed: No token received
    This error indicates that authentication to the NPM API failed. Verify that the provided email, password, and URL are correct and that the NPM instance is reachable.

  • Invalid or missing required properties
    Ensure all required fields such as domain names, forward host, and forward port are provided and correctly formatted.

  • API request failures
    Network issues, incorrect URLs, or insufficient permissions may cause API call failures. Check connectivity and credential permissions.

  • Misconfiguration of advanced options
    Incorrect advanced config syntax may cause proxy host creation to fail or behave unexpectedly. Validate any custom config snippets.

Links and References

Discussion