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 PaperCut MF / NG health monitoring API. Specifically, when using the Statistics resource and the Recent Errors Count operation, this node retrieves the number of errors that have occurred within a specified recent time window (in minutes). This is useful for administrators who want to monitor system health, quickly identify error spikes, or set up automated alerts based on error frequency.

Practical examples:

  • Automatically notify IT staff if there are more than a certain number of errors in the last 30 minutes.
  • Generate periodic reports on error trends over the past few hours.
  • Trigger workflows to investigate or remediate issues when error counts exceed thresholds.

Properties

Name Type Meaning
Minutes Number Number of minutes to look back for counting recent errors. Max value 240.

Output

The node outputs a json object containing the count of recent errors within the specified time window. The exact structure may depend on the API response, but typically includes at least:

{
  "errorCount": <number>
}
  • errorCount: The number of errors detected in the last X minutes (as specified by the "Minutes" property).

Dependencies

  • External Service: Requires access to a running instance of the PaperCut MF / NG server with the 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).
  • n8n Configuration: Ensure network connectivity between n8n and the PaperCut server.

Troubleshooting

Common Issues:

  • Invalid Credentials: If the API key or domain is incorrect, authentication will fail. Double-check your credential settings.
  • SSL Certificate Errors: If your PaperCut server uses a self-signed certificate and you haven't enabled "Skip SSL Certificate Validation," connection attempts may fail.
  • Minutes Value Out of Range: If you specify a value greater than 240 for "Minutes," the API may return an error or ignore the request.

Error Messages:

  • 401 Unauthorized: Check your API credentials.
  • Connection Refused/Timeout: Ensure the PaperCut server is reachable from n8n.
  • Invalid Parameter: Make sure "Minutes" is a number between 1 and 240.

Links and References

Discussion