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 within n8n workflows. Specifically, the "Access List" resource with the "Get" operation retrieves details of a particular access list by its ID. This is useful for scenarios where you want to automate the retrieval and processing of access control configurations, such as auditing access lists, syncing them with other systems, or dynamically adjusting proxy rules based on external data.

Practical examples include:

  • Fetching an access list to verify which clients have access before deploying new proxy hosts.
  • Automating reports on access list usage and ownership.
  • Integrating access list data into broader security or compliance workflows.

Properties

Name Meaning
ID The unique numeric identifier of the access list to retrieve.
Additional Fields Optional parameters to customize the returned data:
- Expand Owner Boolean flag to include detailed information about the owner of the access list.
- Expand Clients Boolean flag to include detailed information about clients associated with the access list.
- Expand Items Boolean flag to include detailed information about items within the access list.
- Filter A string filter to narrow down results by name (used when retrieving multiple access lists).

Output

The node outputs JSON data representing the requested access list. Depending on the additional fields selected, this JSON may include expanded details about the owner, clients, and items related to the access list. The structure typically contains identifiers, names, and relevant metadata describing the access list configuration.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to an Nginx Proxy Manager instance.
  • Needs credentials including the URL, email, and password for authentication.
  • The node authenticates by requesting a token from the NPM API before performing operations.
  • No additional external services are required beyond the NPM API.

Troubleshooting

  • Login failed: No token received: This error indicates that authentication with the NPM API failed. Verify that the provided credentials (URL, email, password) are correct and that the NPM instance is reachable.
  • Invalid ID or Access List Not Found: If the specified ID does not correspond to any existing access list, the node may return an error or empty result. Double-check the ID value.
  • Network Issues: Ensure that the n8n instance can reach the NPM API endpoint without firewall or network restrictions.
  • Permission Issues: The user account used for authentication must have sufficient permissions to read access lists.

Links and References

Discussion