Puppet orchestrator API: error responses

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

Error response description

Every error response from the Puppet orchestrator will be a JSON response. Each response will be an object containing the following keys:

  • 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"
  }
}
How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.