GET /foreman_tasks/api/tasks/summary
Show task summary


GET /foreman_tasks/api/tasks/:id
Show task details

Params

Param Name Description
id
Optional

UUID of the task


Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

POST /foreman_tasks/api/tasks/bulk_search
List dynflow tasks for uuids


POST /foreman_tasks/api/tasks/bulk_resume
Resume all paused error tasks

Params

Param Name Description
search
Optional

Resume tasks matching search string


Value: Must be String
task_ids
Optional

Resume specific tasks by id


Value: Must be an array of any type

GET /foreman_tasks/api/tasks
List tasks

Params

Param Name Description
search
Optional

Search string


Value: Must be String
page
Optional

Page number, starting at 1


Value: Must be a number.
per_page
Optional

Number of results per page to return


Value: Must be a number.
order
Optional

Sort field and order, eg. 'name DESC'


Value: Must be String
sort
Optional

Hash version of 'order' param


Value: Must be a Hash
sort[by]
Optional

Field to sort the results on


Value: Must be String
sort[order]
Optional

How to order the sorted results (e.g. ASC for ascending)


Value: Must be String