Puppet orchestrator API: error responses

(↓ expand all ↓) (↑ collapse all ↑) | (↓ open menu ↓) (↑ close menu ↑)

Puppet Enterprise 2016.5

  1. Error response description

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"
  }
}
Back to top