Status API

You can use the status API to check the health of Puppet Enterprise (PE) components and services. It is useful for automatically monitoring your infrastructure, removing unhealthy service instances from a load-balanced pool, checking configuration values, or troubleshooting issues in PE.

The status API endpoints listen on several ports. You can use the endpoints to query all services on a specified port or query an individual service on a specified port. The ports and services on each port are as follows:
Status API category Port Services
Console-services status API 4433
  • RBAC
  • Activity service
  • Classifier
Puppet Server status API 8140
  • Code Manager
  • File sync client
  • File sync storage
  • Puppet Server

  • PCP broker (compilers)

  • PCP broker v2 (compilers)
Orchestrator status API 8143
  • Orchestrator
  • PCP broker (primary server)
  • PCP broker v2 (primary server)
PuppetDB status API 8081 PuppetDB
Important: The status API documentation uses default ports. If you changed a service's port, you might need to change the port number in your endpoint request.

Endpoint responses can return an overall health status (healthy, error, or unknown) and detailed information, such as database availability, the health of other required services, or connectivity to the primary server.