PaperCut Health API icon

PaperCut Health API

Interact with the PaperCut MF / NG health monitoring api
Join our community

Actions10

Overview

This custom n8n node, PaperCut Health API, is designed to interact with the PaperCut MF / NG health monitoring API. Specifically, when using the Status resource and the Database Server operation, the node checks the health status of the database server component within a PaperCut environment. This can be useful for IT administrators who want to automate monitoring and alerting for their PaperCut installation's backend database connectivity.

Practical Example:
An administrator could use this node in an n8n workflow to periodically check if the number of successful database connections falls below a certain threshold, triggering notifications or remediation steps if issues are detected.

Properties

Name Type Meaning
Connections Threshold Percentage Number The minimum acceptable percentage of successful database connections. If actual value falls below this threshold, it is considered an error.

Output

The node outputs a json object containing the health status of the PaperCut database server. The structure typically includes:

  • Status indicators (e.g., healthy/unhealthy)
  • Current percentage of successful database connections
  • Any errors or warnings related to database connectivity

Note: The exact output fields depend on the PaperCut Health API response for the database server status endpoint.

Dependencies

  • External Service: Requires access to a running PaperCut MF / NG instance with its health monitoring API enabled.
  • API Credentials: Needs valid credentials (paperCutHealthApi) configured in n8n, including domain and (optionally) self-signed certificate handling.
  • n8n Configuration: Ensure that the credentials are set up in n8n under the name paperCutHealthApi.

Troubleshooting

Common Issues:

  • Invalid Credentials: If the provided API credentials are incorrect or lack necessary permissions, authentication errors will occur.
  • Network Issues: Connectivity problems between n8n and the PaperCut server may result in timeouts or unreachable host errors.
  • Threshold Misconfiguration: Setting the "Connections Threshold Percentage" too high or too low may lead to false positives or missed alerts.

Error Messages & Resolutions:

  • 401 Unauthorized: Check your API credentials and permissions.
  • Connection Timeout: Verify network connectivity and the PaperCut server address.
  • Threshold Error: Adjust the "Connections Threshold Percentage" to a realistic value based on your environment.

Links and References

Discussion