Forming requests to the status API

This version is no longer supported, maintained, or updated. For current versions, see Puppet Enterprise support lifecycle.
Sections

The HTTPS status endpoints are available on the console services API server, which uses port 4433 by default.

The path prefix is /status, so, for example, the URL to get the statuses for all services as JSON is https://<DNS NAME OF YOUR CONSOLE HOST>:4433/status/v1/services.

To access that URL using curl commands, run:

curl https://<DNS NAME OF YOUR CONSOLE HOST>:4433/status/v1/services \
    --cert /etc/puppetlabs/puppet/ssl/certs/<WHITELISTED CERTNAME>.pem \
    --key /etc/puppetlabs/puppet/ssl/private_keys/<WHITELISTED CERTNAME>.pem \
    --cacert /etc/puppetlabs/puppet/ssl/certs/ca.pem

If enabled, the HTTP status endpoints are available on port 8123.

Tip: To change the port, locate the PE Console node group in the console, and in the puppet_enterprise::profile::console class, set the console_services_plaintext_status_port parameter to your desired port number.
How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.