Puppet orchestrator API v1 endpoints
Use this API to gather details about the orchestrator jobs you run.
-
Puppet orchestrator API: forming requests
Instructions on interacting with this API. -
Puppet orchestrator API: command endpoint
Use the/command
endpoint to start and stop orchestrator jobs for tasks and plans. -
Puppet orchestrator API: events endpoint
Use the/events
endpoint to learn about events that occurred during an orchestrator job. -
Puppet orchestrator API: inventory endpoint
Use the/inventory
endpoint to discover which nodes can be reached by the orchestrator. -
Puppet orchestrator API: jobs endpoint
Use the/jobs
endpoint to examine orchestrator jobs and their details. -
Puppet orchestrator API: scheduled jobs endpoint
Use the/scheduled_jobs
endpoint to gather information about orchestrator jobs scheduled to run. -
Puppet orchestrator API: plans endpoint
Use the/plans
endpoint to see all known plans in your environments. -
Puppet orchestrator API: plan jobs endpoint
Use the/plan_jobs
endpoint to view details about plan jobs you have run. -
Puppet orchestrator API: tasks endpoint
Use the/tasks
endpoint to view details about the tasks pre-installed by PE and those you've installed. -
Puppet orchestrator API: root endpoint
Use the/orchestrator
endpoint to return metadata about the orchestrator API. -
Puppet orchestrator API: usage endpoint
Use the/usage
endpoint to view details about the active nodes in your deployment. -
Puppet orchestrator API: scopes endpoint
Use thescopes
endpoint to retrieve resources for task constraints. -
Puppet orchestrator API: error responses
From time to time, you might encounter an error using the orchestrator API. In such cases, you receive an error response.
Related information