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, allowing users to manage proxy hosts programmatically. Specifically, the Update Proxy Host operation lets you modify existing proxy host configurations on your NPM server.

Typical use cases include:

  • Updating domain names associated with a proxy host.
  • Changing forwarding settings such as host, port, and scheme.
  • Adjusting security options like SSL enforcement, HSTS, and exploit blocking.
  • Managing advanced configuration snippets or enabling HTTP2 and WebSocket support.
  • Modifying location-specific routing rules within the proxy host.

For example, you might update a proxy host to add new domains, change the backend server it forwards to, or enable SSL enforcement for better security.

Properties

Name Meaning
ID The unique numeric identifier of the proxy host to update.
Domain Names A collection of one or more domain names associated with the proxy host. Each domain is specified as a string.
Options A collection of optional settings for the proxy host:
- Forward Host The hostname or IP address where requests should be forwarded.
- Forward Port The port number on the forward host to which traffic will be sent.
- Access List ID Numeric ID of an access list to apply to this proxy host (e.g., for IP whitelisting/blacklisting).
- Certificate ID Numeric ID of the SSL certificate to use for this proxy host.
- SSL Forced Boolean flag to enforce SSL (redirect HTTP to HTTPS).
- Block Exploits Boolean flag to enable blocking of common web exploits.
- Advanced Config Free-text field for adding custom Nginx configuration snippets.
- 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 when forwarding traffic; options are "http" or "https".
- Enabled Boolean flag indicating whether the proxy host is active.
- HSTS Enable Boolean flag to enable HTTP Strict Transport Security headers.
- HSTS Subdomains Boolean flag to apply HSTS policy to subdomains.
- Locations A collection of location-specific routing rules, each containing:
  - Path URL path prefix for this location rule.
  - Forward Scheme Protocol ("http" or "https") used for forwarding in this location.
  - Forward Host Hostname or IP address to forward requests matching this path.
  - Forward Port Port number on the forward host for this location.
  - Advanced Config Custom Nginx configuration snippet specific to this location.

Output

The node outputs a JSON array containing the response from the Nginx Proxy Manager API after updating the proxy host. This typically includes details about the updated proxy host resource, such as its ID, domain names, forwarding settings, and status flags.

No binary data output is produced by this operation.

Dependencies

  • Requires an Nginx Proxy Manager instance accessible via its API.
  • Requires credentials including the NPM URL, email, and password to authenticate and obtain an API token.
  • The node uses these credentials to perform authenticated HTTP requests to the NPM API endpoints.

Troubleshooting

  • Login failed: No token received
    This error indicates that authentication with the NPM API failed, possibly due to incorrect credentials or network issues. Verify the email, password, and URL provided in the credentials. Ensure the NPM instance is reachable and the API endpoint is correct.

  • Invalid or missing required parameters
    Make sure all required fields, especially the proxy host ID and domain names, are correctly set. Missing or malformed inputs can cause the API to reject the request.

  • API request failures
    Network errors, permission issues, or invalid configuration values may cause the update to fail. Check the NPM server logs and ensure the user has sufficient permissions.

  • Incorrect forwarding settings
    Misconfigured forward host, port, or scheme can lead to inaccessible services. Double-check these values correspond to valid backend servers.

Links and References

Discussion