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 Dead Host - Update operation, it updates the configuration of a "dead host" entry in the NPM system. Dead hosts typically represent domains or hosts that are no longer active or should be disabled/marked accordingly.

Common scenarios where this node is beneficial include:

  • Automating the update of dead host entries when domain statuses change.
  • Managing SSL and HTTP/2 settings for dead hosts.
  • Applying advanced configurations or toggling security features like HSTS on dead hosts.

Practical example:

  • Automatically updating a dead host's domain list and enabling SSL enforcement after detecting changes in domain availability.

Properties

Name Meaning
ID The unique numeric identifier of the dead host entry to update.
Domain Names A collection of one or more domain names associated with the dead host.
Options Various configuration options for the dead host:
  SSL Forced Boolean flag to enforce SSL usage for the dead host.
  HTTP2 Support Boolean flag to enable HTTP/2 protocol support.
  HSTS Enable Boolean flag to enable HTTP Strict Transport Security (HSTS).
  HSTS Subdomains Boolean flag to apply HSTS policy to subdomains as well.
  Certificate ID Numeric ID referencing an SSL certificate to associate with the dead host.
  Advanced Config Free-text field for entering advanced custom configuration directives.

Output

The node outputs a JSON array containing the result of the update operation. Typically, this includes confirmation of success and details about the updated dead host entry. The exact structure depends on the API response from the NPM instance but generally confirms that the dead host was updated with the specified properties.

No binary data output is involved in this operation.

Dependencies

  • Requires access to an Nginx Proxy Manager instance with API enabled.
  • Needs credentials including URL, email, and password to authenticate and obtain an API token.
  • The node performs an authentication request to generate a token before executing the update.
  • Proper API permissions are necessary to update dead host entries.

Troubleshooting

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

  • Invalid ID or resource not found
    Ensure the ID property corresponds to an existing dead host entry in the NPM instance.

  • Validation errors on domain names or options
    Confirm that domain names are valid strings and options are set according to allowed types (booleans or numbers).

  • Network or connectivity issues
    Check network access to the NPM API endpoint and firewall settings.

Links and References

Discussion