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


POST /foreman_tasks/api/tasks/callback
Send data to the task from external executor (such as smart_proxy_dynflow)

Params

Param name Description
callback
optional

Value:

Must be a Hash

callback[task_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.

callback[step_id]
optional

The id of the step inside the execution plan to send the event to


Value:

Must be String

data
optional

Data to be sent to the action


Value:

Must be Hash