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, for the Dead Host - Delete operation, it enables the removal of a dead host entry from the NPM system. This is useful in scenarios where a previously unreachable or inactive host should be cleaned up to maintain an accurate and efficient proxy configuration.

Practical examples include:

  • Automatically deleting dead hosts detected during health checks.
  • Manually removing stale or obsolete dead host entries to prevent routing issues.

Properties

Name Meaning
ID The unique numeric identifier of the dead host to delete. This property is required for the delete operation.

Output

The node outputs a JSON array containing the result of the delete operation. Typically, this will confirm whether the deletion was successful. The exact structure depends on the API response but generally includes success status and possibly a message.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential with email and password to authenticate against the Nginx Proxy Manager API.
  • The node performs an authentication request to obtain a token before executing resource-specific operations.
  • The base URL of the NPM instance must be configured in the credentials.

Troubleshooting

  • Login failed: No token received: This error indicates that authentication to the NPM API failed. Verify that the provided email, password, and URL are correct and that the NPM instance is reachable.
  • Invalid or missing ID: Ensure that the "ID" property is provided and corresponds to an existing dead host entry.
  • Network errors or timeouts: Check network connectivity to the NPM server and ensure the API endpoint is accessible.
  • Permission issues: Confirm that the API user has sufficient permissions to delete dead hosts.

Links and References

Discussion