Available in PaperCut NG and PaperCut MF.

PaperCut NG/MF System Health interface reference

The PaperCut NG/MF System Health interface provides URL endpoints that your monitoring tool can retrieve. The way in which this is done is dependent on the tool you are using.

The PaperCut NG/MF System Health interface has multiple layers of URLs, each containing different types of information. The following types of URLs are provided:


The advanced information URLs can be used only with monitoring tools that support JSON. The status URLs are simple OK/Error status indicators, so you can use either the HTTP response codes or the JSON attribute.


By default, PaperCut will make a query to the database to update the System Health information every 15 seconds. Depending on the intervals that the Health APIApplication Programming Interface (API) is a set of routines, protocols, and tools for building software and applications. An API expresses a software component in terms of its operations, inputs, outputs, and underlying types, defining functionalities that are independent of their respective implementations, which allows definitions and implementations to vary without compromising the interface. is called, you may see an increase in the number of database connections made as PaperCut tries to retrieve up-to-date information.