Puppet orchestrator API: error responses

This version is out of date. For current versions, see Puppet Enterprise support lifecycle.
This release is no longer generally available due to an issue with upgrade
Sections

From time to time, you might encounter an error using the orchestrator API. In such cases, you receive an error response.

Every error response from the Puppet orchestrator is a JSON response. Each response is an object that contains the following keys:
Key Definition
kind The kind of error encountered.
msg The message associated with the error.
details A hash with more information about the error.

For example, if an environment does not exist for a given request, an error is raised similar to the following:

{
  "kind" : "puppetlabs.orchestrator/unknown-environment",
  "msg" : "Unknown environment doesnotexist",
  "details" : {
    "environment" : "doesnotexist"
  }
}
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.