PaperCut Health API icon

PaperCut Health API

Interact with the PaperCut MF / NG health monitoring api

Actions10

Status → Application Server

AI-generated

Overview

The PaperCut Health API node for n8n allows you to interact with the PaperCut MF / NG health monitoring API. Specifically, when using the Status resource and the Application Server operation, this node checks the status of the application server component within your PaperCut environment. This is useful for monitoring disk space and ensuring that the application server is running optimally.

Common scenarios:

  • Automated health checks of your PaperCut Application Server.
  • Alerting or workflow triggers based on low disk space conditions.
  • Integrating PaperCut server health data into broader IT monitoring dashboards.

Example use case:
You can set up a workflow that periodically checks if the application server's available disk space falls below a certain threshold and sends an alert if it does.

Properties

Name Type Meaning
Disk Threshold MB Number Threshold for disk space errors (in megabytes). If the available disk space drops below this value, the node will consider it an error condition.

Output

The node outputs a json object containing the status information of the PaperCut Application Server. The exact structure depends on the API response, but typically includes fields such as:

  • Status indicators (e.g., healthy/unhealthy)
  • Current disk space values
  • Any error or warning messages related to disk space

Note: If the node supports binary output, it would be used for exporting logs or reports, but in this operation, the output is expected to be JSON only.

Dependencies

  • External Service: Requires access to a running PaperCut MF / NG instance 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).

Troubleshooting

Common issues:

  • Invalid Credentials: If the API credentials are incorrect or missing, authentication errors will occur. Ensure the paperCutHealthApi credential is properly configured in n8n.
  • Network Errors: If n8n cannot reach the PaperCut server (due to firewall, DNS, or network issues), requests will fail.
  • Threshold Too High/Low: Setting an unrealistic disk threshold may cause false positives or missed alerts.
  • SSL Certificate Issues: If your PaperCut server uses a self-signed certificate and selfSigned is not set to true, SSL errors may occur.

Error messages and resolutions:

  • "401 Unauthorized": Check your API credentials.
  • "ENOTFOUND" or "ECONNREFUSED": Verify the domain and network connectivity.
  • "Disk space below threshold": Increase available disk space or adjust the threshold property.

Links and References

Discussion