Find your dream job at PaperCut

Choose your language

Choose your login

Contact us

Help Center menu

PRODUCT MANUALS

PaperCut NG & PaperCut MF Manual

PRODUCTS FEATURED

Status summary URLs

The summary status URLs provide status indicators for the various components (such as printers or devices) in your PaperCut NG/MF implementation. You can use either the JSON attribute on each of these URLs, or the HTTP response codes depending on the capabilities of your monitoring tool.

These URLs provide the following HTTP response codes that can be consumed by most monitoring tools:

  • 200—Success

  • 500—Error

For example, if a Site Server is offline, the /api/health/site-servers/status URL will return a status code of 500 (Error).

If you use the JSON attribute in the URL, more detailed status information is available when the status is not OK, for example, “Invalid license status: EXPIRED”.

EXAMPLE

The following status summary URLs are available.

URLAttributeDescription
/statusstatusA summary status of the PaperCut NG/MF system health. This is either OK or an error message is displayed. An error is displayed when one or more of the following conditions occur:
  • The Application server cannot connect to the database
  • The number of active database connections is greater than 90%
  • Less than 1 GB available disk space
  • An invalid license is in use
  • Site Server is offline
  • The Job Ticketing service is offline
 messageA description of the URL.
/application-server/status?
disk-threshold-mb=1024
statusIndicates whether or not the available hard disk space on the Application Server is below a predefined threshold.By default, the threshold for this value is 1,024 MB. You can change this threshold by changing the ?disk-threshold-mb=1024 value.This is either OK or an error message is displayed.
 commentA description of the URL.
/site-servers/statusstatusIndicates whether or not any Site Servers are offline.This is either OK or an error message is displayed.
 commentA description of the URL.
/print-providers/statusstatusIndicates whether or not any Print Providers are offline.This is either OK or an error message is displayed.
 commentA description of the URL.
/web-print/status?servers-in-error-threshold=0statusIndicates whether or not a predefined number of Web Print servers are offline.By default, the threshold for this key is 0, which means, it will be in error if any Web Print servers are offline. You can change this threshold by changing the ?servers-in-error-threshold=0 value.This is either OK or ERROR.
 commentA description of the URL.
 messageA description of the status.
/job-ticketing/statusstatusIndicates whether or not the Job Ticketing can connect with the Application Server.The status is either OK or ERROR. An error is returned when:
  • Job Ticketing is first installed, but has not yet received a call from the Job Ticketing service.
  • The PaperCut NG/MF server has restarted, but has not yet received a call from the Job Ticketing service.
  • Job Ticketing is installed, but has not contacted the PaperCut NG/MF server in the last 6 minutes.
 commentA description of the URL.
 messageA description of the status.
/license/statusstatusIndicates whether or not any licenses are invalid. The system health interface checks the following license types:
  • User
  • Site Server
  • Payment Gateway
  • Advanced Client
  • Devices
This is either OK or an error message is displayed.
 commentA description of the URL.
/database/status?connections-threshold-percentage=90statusIndicates whether or not the Application Server can connect to the database.By default, the threshold for this key is 90, which means, it will be in error if less than 90% of the connections from the Application Server to the database are working. You can change this threshold by changing the ?threshold-percentage=90 value.This is either OK or an error message is displayed.
 commentA description of the URL.
/web-print/status?servers-in-error-threshold=0statusIndicates whether or not a predefined number of Web Print servers are offline.By default, the threshold for this key is 0, which means, it will be in error if any Web Print servers are offline. You can change this threshold by changing the ?servers-in-error-threshold=0 value.This is either OK or ERROR.
 commentA description of the URL.
 messageA description of the status.
/printers/status?in-error-threshold=0statusIndicates whether or not a predefined number of printers are offline.By default, the threshold for this key is 0, which means, it will be in error if any printers are offline. You can change this threshold by changing the ?in-error-threshold=0 value.This is either OK or an error message is displayed.
 commentA description of the URL.
 messageA description of the status.
/devices/status?offline-threshold=0statusIndicates whether or not a predefined number of devices are offline.By default, the threshold for this key is 0, which means, it will be in error if any devices are offline. You can change this threshold by changing the ?offline-threshold=0 value.This is either OK or an error message is displayed.
 commentA description of the URL.
 messageA description of the status.
/mobility-print-servers/statusstatusIndicates whether or not any Mobility Print servers are offline.This is either OK or an error message is displayed.
 commentA description of the URL.

Comments