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, the Redirection Host - Get operation retrieves details about a particular redirection host configured in NPM by its ID. This is useful for automation workflows that need to query or verify redirection rules without manual intervention.

Practical examples include:

  • Automatically fetching redirection host details to audit or report on URL redirects.
  • Integrating with other systems to dynamically adjust or monitor redirect configurations.
  • Using retrieved data to trigger conditional logic in workflows based on redirect host properties.

Properties

Name Meaning
ID The unique numeric identifier of the redirection host to retrieve.
Additional Fields Optional extra parameters to customize the request:
- Expand Owner Boolean flag to include detailed information about the owner of the redirection host.
- Expand Certificate Boolean flag to include detailed information about the SSL certificate associated.
- Filter A string filter to narrow down results by name (used when retrieving multiple hosts).

Output

The output is a JSON object representing the redirection host's details as returned by the Nginx Proxy Manager API. It typically includes fields such as:

  • The redirection host's ID, domain names, and forwarding URLs.
  • Status flags and configuration options.
  • Optionally expanded nested objects for the owner and certificate if requested.

If binary data were involved (not applicable here), it would be summarized accordingly, but this operation returns structured JSON data only.

Dependencies

  • Requires an active connection to an Nginx Proxy Manager instance.
  • Needs credentials including the NPM URL, email, and password to authenticate and obtain an access token.
  • The node uses the NPM API token authentication mechanism internally.
  • 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 URL, email, and password credentials are correct and that the NPM instance is reachable.

  • Resource or Operation not found
    Ensure that the resource is set to "Redirection Host" and the operation to "Get". Also, confirm that the specified ID exists in the NPM instance.

  • Empty or unexpected response
    Check if the ID corresponds to an existing redirection host. If using expand options, ensure the related entities (owner, certificate) exist.

  • Network issues
    Confirm network connectivity to the NPM server and that no firewall or proxy blocks the requests.

Links and References

Discussion