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. Specifically for the Certificate resource with the Create (with Let's Encrypt) operation, it enables automated creation of SSL/TLS certificates using Let's Encrypt for specified domain names. This is useful for automating secure HTTPS setup on web servers managed by NPM without manual certificate generation or renewal.

Common scenarios include:

  • Automatically provisioning SSL certificates for new domains added to a proxy host.
  • Renewing or creating certificates in bulk for multiple domains.
  • Integrating certificate management into CI/CD pipelines or infrastructure automation workflows.

Example: A user can input one or more domain names, and the node will request Let's Encrypt certificates for those domains via the NPM API, simplifying secure site deployment.

Properties

Name Meaning
Domain Names A collection of one or more domain names for which the Let's Encrypt certificate will be created. Each domain must be specified as a string.

The property supports multiple domain entries, allowing batch certificate creation.

Output

The node outputs JSON data representing the result of the certificate creation request. This typically includes details about the newly created certificate such as its ID, associated domains, expiration date, and status.

If the operation succeeds, the output JSON confirms the certificate has been issued or queued for issuance by Let's Encrypt through NPM.

No binary data output is indicated for this operation.

Dependencies

  • Requires access to an Nginx Proxy Manager instance with API enabled.
  • Needs credentials including the NPM URL, email, and password to authenticate and obtain an API token.
  • The node internally authenticates by requesting a token from the NPM API before performing operations.
  • No additional external services beyond Let's Encrypt (handled by NPM) are required.

Troubleshooting

  • Login failed: No token received: Indicates authentication failure with the NPM API. Verify that the provided URL, email, and password credentials are correct and that the NPM API is accessible.
  • Invalid domain names: Ensure all domain names are valid and properly formatted strings.
  • API errors from NPM: Could occur if the NPM instance is down, misconfigured, or rate-limited by Let's Encrypt. Check NPM logs and network connectivity.
  • Permission issues: The API user must have sufficient permissions to create certificates in NPM.

Links and References

Discussion