PaperCut Health API icon

PaperCut Health API

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

Actions10

Overview

The PaperCut Health API node for n8n allows you to interact with the health monitoring API of PaperCut MF / NG systems. Specifically, when using the Status resource and the Devices operation, this node checks the status of various devices managed by PaperCut, such as printers or multifunction devices. This is useful for IT administrators who want to monitor device availability and receive alerts if too many devices are offline.

Practical Example:
An IT admin could use this node in an automated workflow to regularly check if the number of offline devices exceeds a certain threshold, and trigger notifications or maintenance tasks accordingly.

Properties

Name Type Meaning
Offline Threshold Number Threshold for allowed offline devices. If exceeded, may trigger actions.

Output

The node outputs a json object containing the status information of devices. The exact structure depends on the PaperCut Health API response, but typically includes:

  • Device identifiers (e.g., name, ID)
  • Online/offline status
  • Additional device health metrics

Note: If the API supports binary data (such as logs or reports), the node may output binary fields, which would contain the relevant file or data blob.

Dependencies

  • External Service: Requires access to a running instance of the PaperCut MF / NG system with its health monitoring API enabled.
  • API Credentials: You must configure the paperCutHealthApi credentials in n8n, including:
    • domain: The base URL of your PaperCut server.
    • selfSigned: Whether to skip SSL certificate validation (for self-signed certificates).

Troubleshooting

Common Issues:

  • Invalid Credentials: If the API key or domain is incorrect, authentication will fail. Double-check your n8n credential settings.
  • Network Errors: Ensure that the n8n instance can reach the PaperCut server (firewall, VPN, etc.).
  • Threshold Misconfiguration: Setting the "Offline Threshold" too low or high may result in missed alerts or false positives.

Error Messages:

  • 401 Unauthorized: Check your API credentials.
  • 404 Not Found: Verify the API endpoint and resource/operation selection.
  • Connection Timeout: Ensure network connectivity and correct server address.

Links and References

Discussion