Command endpoints
Use the command
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.
You can:
- POST /command/deploy: Run Puppet on demand.
- POST /command/stop: Stop an orchestrator job that is currently running.
- POST /command/stop_plan: Stop an orchestrator plan job that is currently running.
- POST /command/task: Run a task on a set of nodes.
- POST /command/task_target: Define a set of tasks and nodes/node groups you can use to escalate privileges for users who would otherwise not be able to run those tasks or run tasks on those nodes or node groups.
- POST /command/plan_run: Run a plan.
- POST /command/environment_plan_run: Run a plan in a specified environment.
The schedule_deploy
, schedule_task
, and schedule_plan
endpoints are deprecated. Instead, use POST /scheduled_jobs/environment_jobs.