Orchestrator API v1
You can use the orchestrator API to run jobs and plans on demand; schedule tasks and plans; get information about jobs, plans, and events; track node usage; and more.
-
Forming orchestrator API requests
The orchestrator API accepts well-formed HTTPS requests and requires authentication. -
Root endpoints
Use theorchestrator
endpoint to get orchestrator API metadata. -
Command endpoints
Use thecommand
endpoints to run Puppet, jobs, and plans on demand or stop in-progress jobs. You can also create task-targets, which provide privilege escalation for users who would otherwise not be able to run certain tasks or run tasks on certain nodes or node groups. -
Inventory endpoints
Use theinventory
endpoints to check whether the orchestrator can reach a node. -
Jobs endpoints
Use thejobs
endpoints to examine jobs and their details. -
Scheduled jobs endpoints
Use thescheduled_jobs
endpoints to query, edit, and delete scheduled orchestrator jobs. -
Plans endpoints
Use theplans
endpoints to get information about plans. -
Plan jobs endpoints
Use theplan_jobs
endpoints to examine plan jobs and their details. -
Tasks endpoints
Use thetasks
endpoints to get information about tasks you've installed and tasks included with Puppet Enterprise (PE). -
Usage endpoints
Use theusage
endpoint to view details about your deployment's active nodes. -
Scopes endpoints
Use thescopes
endpoints to retrieve information about task-targets. -
Orchestrator API error responses
Orchestrator API error responses are formatted as JSON objects.
Related information