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 "Proxy Host" resource with the "Status" operation enables users to enable or disable a particular proxy host by its ID. This is useful for scenarios where you want to quickly toggle the availability of a proxy host without deleting or recreating it, such as temporarily disabling access during maintenance or troubleshooting.

Practical examples:

  • Temporarily disable a proxy host during server upgrades.
  • Enable a proxy host after resolving connectivity issues.
  • Automate status changes based on external monitoring alerts.

Properties

Name Meaning
ID The unique numeric identifier of the proxy host whose status you want to change or check.
Enabled Boolean flag to set the proxy host's status: true to enable, false to disable it.

Output

The node outputs a JSON array containing the response from the Nginx Proxy Manager API related to the status update or retrieval of the specified proxy host. The exact structure depends on the API response but typically includes details about the proxy host and its current status.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is purely JSON-based.

Dependencies

  • Requires an active Nginx Proxy Manager instance accessible via its API.
  • Needs credentials including URL, email, and password to authenticate and obtain an API token.
  • The node uses HTTP requests to interact with the NPM API endpoints.
  • Proper configuration of the API credentials within n8n is necessary for successful execution.

Troubleshooting

  • Login failed: No token received: This error occurs if authentication with the NPM API fails. Verify that the URL, email, and password credentials are correct and that the NPM instance is reachable.
  • Invalid ID or resource not found: Ensure the proxy host ID exists in your NPM instance.
  • Network errors or timeouts: Check network connectivity between n8n and the NPM server.
  • Permission issues: Confirm that the API user has sufficient permissions to modify proxy hosts.

Links and References

Discussion