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 aspects of their proxy setup programmatically. Specifically, the "Certificate" resource with the "Test Reachability" operation enables users to verify if specified domain names are reachable and properly configured for SSL certificate issuance or renewal.

Common scenarios include:

  • Validating domain reachability before requesting or renewing SSL certificates.
  • Automating health checks on domains managed by Nginx Proxy Manager.
  • Integrating domain validation steps into CI/CD pipelines for web infrastructure.

For example, a user can input multiple domain names to test if they are accessible from the NPM environment, ensuring that certificate requests will succeed without manual intervention.

Properties

Name Meaning
Domain Names A collection of one or more domain names to test for reachability. Each domain is a string representing a fully qualified domain name (FQDN).

The property supports multiple domain entries, allowing batch testing of several domains in one execution.

Output

The node outputs JSON data containing the results of the reachability tests for the provided domains. The structure typically includes information about each domain's status, such as whether it is reachable or not, and may include additional metadata related to the test outcome.

If the node supports binary data output (not explicitly shown here), it would likely represent logs or diagnostic files related to the reachability tests.

Dependencies

  • Requires an active connection to an Nginx Proxy Manager instance.
  • Needs credentials including a URL, email, and password to authenticate and obtain an API token.
  • The node uses the NPM API to perform operations; thus, the NPM instance must have its API enabled and accessible.
  • No additional external services are required beyond the NPM API.

Troubleshooting

  • Login failed: No token received: This error indicates authentication failure. Verify that the provided credentials (URL, email, password) are correct and that the NPM API is reachable.
  • Domain unreachable or invalid: If the test reports domains as unreachable, ensure that the domains are correctly configured in DNS and accessible from the NPM server network.
  • Network issues or firewall restrictions might prevent successful reachability tests.
  • Ensure that the NPM instance version supports the tested API endpoints.

Links and References

Discussion