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 Devices & Printers resource and the Status operation, this node retrieves the current status of a specified device or printer managed by your PaperCut system. This is useful for monitoring the operational state of printers and devices, enabling automated workflows for alerting, maintenance, or reporting.

Practical examples:

  • Automatically check if a specific printer is online before sending print jobs.
  • Monitor device statuses and trigger notifications if a device goes offline.
  • Integrate device health checks into broader IT automation workflows.

Properties

Name Type Meaning
Type options Select whether you want to check the status of a "Device" or a "Printer".
Device or Printer ID number The unique identifier of the device or printer whose status you wish to retrieve.

Output

The node outputs a json object containing the status information of the specified device or printer. The exact structure depends on the PaperCut Health API response, but typically includes fields such as:

  • Status (e.g., online/offline/error)
  • Device or printer details (ID, name, type)
  • Additional metadata relevant to the device/printer's health

If the node supports binary output (e.g., logs or reports), it will be included in the binary property, but for this operation, the focus is on JSON status data.

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 the domain and any necessary authentication details.
  • n8n Configuration: Ensure that SSL certificate validation settings match your environment (e.g., self-signed certificates).

Troubleshooting

Common Issues:

  • Invalid Device or Printer ID: If the provided ID does not exist, the node may return an error or empty result. Double-check the ID value.
  • Authentication Errors: Incorrect or missing API credentials will prevent successful API calls. Verify your credential setup in n8n.
  • Network/SSL Issues: If the PaperCut server uses a self-signed certificate and SSL validation is not configured correctly, connection errors may occur.

Error Messages:

  • "401 Unauthorized": Check your API credentials.
  • "404 Not Found": The specified device or printer ID does not exist.
  • "Connection refused" or SSL errors: Review your network settings and SSL configuration.

Links and References

Discussion