Nginx Proxy Manager (NPM) icon

Nginx Proxy Manager (NPM)

Interact with your NPM instance

Overview

The node integrates with an Nginx Proxy Manager (NPM) instance, allowing users to manage various NPM resources programmatically. Specifically, for the Certificate resource with the Get Many operation, it retrieves multiple SSL/TLS certificates from the NPM server. This is useful for scenarios where you want to list all certificates managed by NPM, filter them by name, or expand related owner information.

Practical examples include:

  • Automating audits of all SSL certificates in your proxy manager.
  • Filtering certificates by name to find specific ones.
  • Retrieving detailed owner information for certificates to verify ownership or permissions.

Properties

Name Meaning
Additional Fields Collection of optional parameters:
- Expand Owner Boolean flag to include detailed owner information in the response (true/false).
- Filter String to filter the certificates by their name; only certificates matching this string are returned.

Output

The output is a JSON array where each element represents a certificate object retrieved from the NPM instance. Each certificate object typically includes details such as its ID, name, expiration date, and other metadata. If the "Expand Owner" option is enabled, the owner field will contain expanded user information instead of just an identifier.

No binary data is output by this operation.

Dependencies

  • Requires an active connection to an Nginx Proxy Manager instance.
  • Needs credentials including the URL, email, and password to authenticate and obtain an API token.
  • The node uses the NPM API token to perform authenticated requests.

Troubleshooting

  • Login failed: No token received: This error indicates that authentication with the NPM instance failed. Verify that the provided URL, email, and password are correct and that the NPM server is reachable.
  • Empty or no results returned: Check if the filter string is too restrictive or if there are actually no certificates matching the criteria.
  • API connectivity issues: Ensure network connectivity to the NPM server and that the API endpoint is accessible.

Links and References

Discussion