Nginx Proxy Manager (NPM) icon

Nginx Proxy Manager (NPM)

Interact with your NPM instance

Overview

This node integrates with an Nginx Proxy Manager (NPM) instance, allowing users to manage various aspects of their proxy setup programmatically. Specifically, the Setting - Update operation enables updating configuration settings related to how NPM handles certain HTTP responses or pages.

Common scenarios for this operation include customizing the behavior of error pages (like 404), redirecting traffic to a different URL, or setting up custom HTML pages for specific responses. For example, you might use this node to update the "404 Page" content to provide a branded error message or configure a redirect to a maintenance page during downtime.

Properties

Name Meaning
Action The type of setting to update. Options:
- Congratulation Page
- 404 Page
- No Response (444)
- Redirect
- Custom Page
Redirect To The URL to redirect to when the "Redirect" action is selected.
Custom Page The HTML content to display when the "Custom Page" action is selected.

Output

The node outputs a JSON array containing the result of the update operation. Typically, this will include confirmation of success or details about the updated setting. The exact structure depends on the response from the Nginx Proxy Manager API but generally includes status and any relevant messages.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to an Nginx Proxy Manager instance.
  • Needs credentials including the NPM URL, email, and password to authenticate and obtain an API token.
  • The node uses the NPM API to perform updates; thus, the NPM instance must have its API enabled and accessible.

Troubleshooting

  • Login failed: No token received: This error indicates authentication failure. Verify that the provided email and password are correct and that the NPM API endpoint is reachable.
  • Invalid or missing required fields: Ensure that when selecting the "Redirect" action, the "Redirect To" URL is provided, and when selecting "Custom Page," valid HTML content is supplied.
  • API connectivity issues: Confirm network access to the NPM instance and that the base URL is correctly configured in the credentials.
  • Unexpected API errors: Check the NPM server logs for more detailed error information if the node returns generic failure messages.

Links and References

Discussion