PaperCut Health API icon

PaperCut Health API

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

Actions10

Overview

This node interacts with the PaperCut MF / NG health monitoring API, specifically targeting the Status resource and its Printers operation. It is designed to check the status of printers managed by PaperCut, allowing users to monitor printer health and quickly identify issues within their printing environment.

Common scenarios:

  • Monitoring the operational status of all printers in an organization.
  • Setting up automated alerts or workflows if too many printers are reporting errors.
  • Integrating printer health checks into broader IT monitoring dashboards.

Practical example:
A system administrator could use this node in an n8n workflow to regularly poll the status of all printers, and if the number of printers in error exceeds a certain threshold, trigger a notification or create a support ticket.

Properties

Name Type Meaning
In Error Threshold Number Threshold for allowed printers with errors. If exceeded, may trigger action or alert.

Output

The node outputs a json field containing the response from the PaperCut Health API regarding the status of printers. The structure typically includes information about each printer's status, such as whether it is online, offline, or in error. The exact fields depend on the API response but generally include identifiers and status indicators for each printer.

If binary data is output (not typical for this operation), it would represent raw API responses or logs.

Dependencies

  • External Service: Requires access to a running instance of the PaperCut MF / NG server with the health monitoring API enabled.
  • API Credentials: Needs valid credentials (paperCutHealthApi) configured in n8n, including:
    • domain: The base URL of the PaperCut server.
    • selfSigned: Boolean indicating if SSL certificate validation should be skipped (for self-signed certificates).
  • n8n Configuration: Ensure 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 Errors: If the PaperCut server is unreachable (wrong domain, network/firewall issues), requests will fail.
  • Threshold Misconfiguration: Setting the "In Error Threshold" too low may cause frequent false positives; too high may miss real issues.

Common Error Messages:

  • 401 Unauthorized: Check your API credentials and permissions.
  • 404 Not Found: Verify the base URL and that the health API is enabled on the server.
  • SSL Certificate Error: If using a self-signed certificate, ensure selfSigned is set to true in credentials.

Links and References

Discussion