POST /foreman_tasks/api/tasks/bulk_stop
Stop selected stoppable tasks

Stops all selected tasks which are not already stopped. Requires a search query or an explicit list of task IDs to be provided.

Errors

Code Description
400 Returned if neither search nor task_ids parameter is provided.

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
search
optional

Stop tasks matching search string

Validations:

  • String
task_ids
optional

Stop specific tasks by ID

Validations:

  • Must be an array of any type