PaperCut Hive/Pocket System Health Monitoring API

Overview

The System Health Monitoring API is your window into the heartbeat of your environment. By providing authenticated endpoints for real-time health and usage metrics, this integration empowers administrators to connect the health of PaperCut Hive and Pocket with their external monitoring tools.

The Road Ahead

This release is more than just a new feature. It represents a major milestone in our journey toward a robust, developer-first ecosystem for PaperCut Hive and Pocket.

We aren’t just handing over data, we are laying the foundational architecture for a wide range of upcoming APIs. By participating in this phase, your influence goes beyond simple bug reporting.

We want to know: How seamless was your integration experience? Your feedback on the ease of use and developer workflow will directly inform the design and standards of every API we build from here on out. Together, we’re defining how you interact with the future of PaperCut.

Join the Percolator

We are opening access through the Percolator to gather real-world feedback and fine-tune the experience before General Availability. Your insights today will directly shape the future of our upcoming APIs we open up.

Feature highlights at a glance

• System status: Returns the overall status of the PaperCut Hive/Pocket cloud service for your region and any active incidents affecting that region.
• Job statistics: Get statistics for print, scan, copy, and fax jobs processed within your organization.
• Subscription details: Returns subscription details, including the end date and days remaining.

The System Health Monitoring API integration is simple to integrate and can be accessed using standard HTTPS requests.

Prerequisites

Before you begin integrating with the System Health Monitoring API, ensure you have the following:

• Admin access: You must have administrative permissions for the PaperCut Hive/Pocket Admin Console.
• Organization ID: Your unique orgId (found in your browser URL when logged into the Admin Console).
• API key: A valid key generated with the appropriate Scopes assigned.

Real-world scenarios

How can the System Health Monitoring API help your IT team? Here are a few ways we envision you using it to explain real-world value:

• Automated incident alerting: Connect the /system-status endpoint to your IT helpdesk. Check the service_status field. If the status is Major Outage (total loss of functionality in a region) or Partial Outage (specific subset of features down), trigger an automated alert to your IT team.
• Job monitoring dashboards: Use the /job-stats endpoint to monitor how jobs flow through PaperCut or to detect unusual spikes/drops in print/copy/fax/scan activity that might indicate a problem. Monitor the completed counts for print jobs and track cancelled print jobs to see if users are frequently abandoning jobs due to slow performance.
• Proactive subscription management: Use the /subscription endpoint for automated license management to ensure your organization never faces an accidental service interruption due to an expired subscription. Poll this endpoint once per day, check the days_remaining value, and set an automation to send an email to the procurement department when days_remaining is less than 30.