Status API

We've updated our documentation to remove harmful terminology.
Sections

The status API allows you to check the health of PE components and services. It can be useful for automated monitoring of your infrastructure, removing unhealthy service instances from a load-balanced pool, checking configuration values, or troubleshooting issues in PE.

You can check the overall health of the console service, as well as the health of the individual services within the console service:
  • Activity service
  • Classifier service
  • PuppetDB
  • Puppet Server
  • Role-based access control (RBAC) service
  • Code Manager service

The endpoints provide overview health information in an overall healthy/error/unknown status field, and fine-detail information such as the availability of the database, the health of other required services, or connectivity to the primary server.

How helpful was this page?

If you leave us your email, we may contact you regarding your feedback. For more information on how Puppet uses your personal information, see our privacy policy.

Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.