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, for the Access List - Create operation, it enables creating new access lists that control client access based on IP addresses or authentication credentials.

Typical use cases include:

  • Defining IP-based allowlists or blocklists to restrict access to certain proxy hosts.
  • Creating user/password combinations for HTTP basic authentication on proxied services.
  • Combining multiple authorization methods and access rules in a single access list.

For example, you might create an access list named "Internal Network" that allows all clients from a specific subnet and requires username/password authentication for others.

Properties

Name Meaning
Name The name of the access list to be created.
Options A collection of optional settings and rules:
  Satisfy Any Boolean flag indicating if any one of the authorization methods is sufficient (true), or if all must be satisfied (false).
  Pass Auth Boolean flag indicating whether to pass authentication information through the proxy.
  Authorization One or more username/password pairs used for HTTP basic authentication. Each entry requires:
• Username (string)
• Password (string, hidden input)
  Access One or more client IP addresses or subnets allowed by this access list. Each entry includes:
• IP / Subnet (string)
• Directive (hidden, default "allow")

Output

The node outputs a JSON array containing the response from the Nginx Proxy Manager API after creating the access list. This typically includes details of the newly created access list such as its ID, name, options, and associated authorization and client entries.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Nginx Proxy Manager instance accessible via its API.
  • Requires credentials including the URL of the NPM instance and valid login credentials (email and password) to obtain an API token.
  • The node internally authenticates by requesting a token from the /api/tokens endpoint before performing operations.
  • No additional external dependencies beyond the NPM API and n8n's HTTP request capabilities.

Troubleshooting

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

  • Invalid input errors
    Ensure that required fields like the access list name, usernames, passwords, and IP/subnet addresses are correctly filled and formatted.

  • API connectivity issues
    Confirm network connectivity to the NPM API endpoint and that no firewall or proxy blocks the requests.

  • Permission errors
    The API user must have sufficient permissions to create access lists. Check user roles in NPM.

Links and References

Discussion