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 various NPM resources programmatically. Specifically, the "Proxy Host" resource with the "Get Many" operation retrieves multiple proxy host entries from the NPM server.

Typical use cases include:

  • Automating the retrieval of all configured proxy hosts for auditing or reporting.
  • Filtering proxy hosts by name or expanding related details such as owner, access list, or certificate information.
  • Integrating proxy host data into workflows that require dynamic configuration or monitoring of reverse proxies managed by NPM.

For example, a user might want to fetch all proxy hosts whose names contain a specific substring and include detailed information about their associated SSL certificates and access control lists.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the query:
- Expand Owner Boolean flag to include detailed information about the owner of each proxy host.
- Expand Access List Boolean flag to include detailed information about the access list associated with each proxy host.
- Expand Certificate Boolean flag to include detailed information about the SSL certificate linked to each proxy host.
- Filter A string to filter proxy hosts by their name (partial match).

Output

The node outputs an array of JSON objects representing proxy hosts retrieved from the NPM instance. Each object typically contains fields describing the proxy host's configuration, such as domain names, forwarding details, SSL settings, and optionally expanded related entities (owner, access list, certificate) depending on the input properties.

If binary data were involved (e.g., certificates in binary form), it would be summarized here, but this node primarily deals with JSON data.

Dependencies

  • Requires an API key credential with URL, email, and password to authenticate against the Nginx Proxy Manager API.
  • The node performs an initial login request to obtain a token used for subsequent API calls.
  • The NPM instance must be accessible via the provided URL.
  • No additional external dependencies beyond the NPM API and standard HTTP requests.

Troubleshooting

  • Login failed: No token received
    This error indicates authentication failure. Verify that the provided credentials (email, password, and URL) are correct and that the NPM API is reachable.

  • Empty or unexpected results
    If filtering by name returns no results, ensure the filter string matches existing proxy host names. Also, check if the NPM instance has proxy hosts configured.

  • Permission issues
    Insufficient permissions for the API user may cause failures or incomplete data. Confirm the API user has rights to read proxy host information.

  • Network errors
    Connectivity problems between n8n and the NPM server will prevent successful API calls. Check network settings and firewall rules.

Links and References

Discussion