Forming requests to the status API

Sections

When forming requests to the status API, specify the port that corresponds to the service you want to view the status for.

The path prefix is /status, so, for example, the URL to get the statuses for all services as JSON on port 8140 is https://<DNS NAME OF YOUR CONSOLE HOST>:8140/status/v1/services. This retrieves the statuses for Code Manager and Puppet Server.

To access that URL using curl commands, run:

cert="$(puppet config print hostcert)"
cacert="$(puppet config print localcacert)"
key="$(puppet config print hostprivkey)"
uri="https://$(puppet config print server):8140/status/v1/services"

curl --cert "$cert" --cacert "$cacert" --key "$key" "$uri"

See Usage notes for curl examples for information about forming curl commands.

If enabled, the HTTP status endpoints are available on port 8123. See Authenticating to the status API to enable HTTP.

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.
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.