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, dead hosts, proxy hosts, and more. Specifically, the "Dead Host" resource with the "Get Many" operation retrieves multiple dead host entries from the NPM system. This is useful for monitoring or managing hosts that are currently unreachable or inactive.

Practical scenarios include:

  • Auditing dead hosts to clean up unused or problematic entries.
  • Integrating dead host data into monitoring dashboards.
  • Automating notifications or remediation workflows based on dead host status.

Properties

Name Meaning
Additional Fields Optional parameters to refine the query:
- Expand Owner Boolean flag to include detailed owner information in the response.
- Expand Certificate Boolean flag to include detailed certificate information related to the dead hosts.
- Filter A string to filter dead hosts by name, narrowing down the results returned.

Output

The node outputs a JSON array where each item represents a dead host entry retrieved from the NPM instance. Each entry may include details such as the host's name, status, and optionally expanded owner and certificate information depending on the input properties.

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

Dependencies

  • Requires an active connection to an Nginx Proxy Manager instance.
  • Needs credentials including URL, email, and password to authenticate and obtain an API token.
  • The node uses the NPM API token to perform requests securely.
  • No additional external services are required beyond the NPM API.

Troubleshooting

  • Login failed: No token received: Indicates authentication failure. Verify that the provided URL, email, and password credentials are correct and that the NPM instance is reachable.
  • Empty or no results returned: Check the filter parameter; an overly restrictive filter might yield no matches.
  • API connectivity issues: Ensure network connectivity to the NPM server and that the API endpoint is accessible.
  • Permission errors: Confirm that the user account used has sufficient permissions to read dead host data.

Links and References

Discussion