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 resources such as access lists, certificates, proxy hosts, redirection hosts, and more. Specifically, for the Redirection Host resource with the Status operation, the node enables toggling the enabled/disabled status of a redirection host by its ID. This is useful in scenarios where you want to programmatically activate or deactivate URL redirections managed by NPM without manually accessing the NPM dashboard.

Practical examples include:

  • Temporarily disabling a redirection during maintenance.
  • Enabling a redirection after deploying a new service.
  • Automating redirection status changes based on external triggers or workflows.

Properties

Name Meaning
ID The unique numeric identifier of the redirection host to update or query.
Enabled Boolean flag indicating whether the redirection host should be enabled (true) or disabled (false).

Output

The node outputs JSON data representing the result of the requested operation on the redirection host. Typically, this includes confirmation of the status change or details about the redirection host's current state. The exact structure depends on the NPM API response but generally contains fields like the redirection host's ID, status, and related metadata.

No binary data output is expected from this operation.

Dependencies

  • Requires an active Nginx Proxy Manager instance accessible via its API.
  • Requires credentials including the NPM instance URL, an email, and password for authentication.
  • The node authenticates by requesting a token from the NPM API before performing operations.
  • Proper API permissions are necessary to modify redirection hosts.

Troubleshooting

  • Login failed: No token received: Indicates authentication failure. Verify that the provided email, password, and URL are correct and that the NPM API is reachable.
  • Invalid ID or resource not found: Ensure the redirection host ID exists in your NPM instance.
  • Permission denied or unauthorized errors: Check that the API user has sufficient rights to modify redirection hosts.
  • Network issues or incorrect base URL can cause request failures; verify connectivity and configuration.
  • If the status does not update as expected, confirm that the boolean value for "Enabled" is correctly set.

Links and References

Discussion