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 NPM resources programmatically. Specifically, the "Redirection Host" resource with the "Get Many" operation enables retrieving multiple redirection host entries from the NPM system. This is useful for scenarios where you want to list or filter existing redirection hosts configured in your proxy manager, such as auditing redirects, monitoring configurations, or automating management tasks.

Practical examples include:

  • Fetching all redirection hosts to display them in a dashboard.
  • Filtering redirection hosts by name to find specific redirect rules.
  • Expanding related data like owner or certificate details for comprehensive reports.

Properties

Name Meaning
Additional Fields Optional parameters to customize the retrieval:
- Expand Owner Boolean option to include detailed information about the owner of each redirection host.
- Expand Certificate Boolean option to include detailed information about the SSL certificate used.
- Filter A string to filter the results by the redirection host's name.

Output

The node outputs a JSON array containing objects representing redirection hosts retrieved from the NPM instance. Each object includes standard properties of a redirection host and may include expanded owner and certificate details if those options are enabled.

If binary data were involved (not indicated here), it would typically represent files or certificates, but this operation focuses on JSON data only.

Dependencies

  • Requires connection to an Nginx Proxy Manager API endpoint.
  • Needs credentials including URL, email, and password to authenticate and obtain an access token.
  • The node internally handles authentication by requesting a token before making API calls.
  • No additional external dependencies beyond the NPM API and valid credentials.

Troubleshooting

  • Login failed: No token received: Indicates authentication failure. Verify that the provided URL, email, and password are correct and that the NPM API is accessible.
  • Empty or no results returned: Check the filter string; ensure it matches existing redirection host names. Also verify that the user has permission to view redirection hosts.
  • API connectivity issues: Confirm network access to the NPM instance and that the API endpoint is reachable.
  • Unexpected response structure: May occur if the NPM API version changes. Ensure compatibility between the node and the NPM version.

Links and References

Discussion