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

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ 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

Validations:

  • String

task_ids
optional

Resume specific tasks by ID

Validations:

  • Must be an array of any type


GET /foreman_tasks/api/tasks
List tasks

Params

Param name Description
search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • number.

per_page
optional

Number of results per page to return

Validations:

  • number.

order
optional

Sort field and order, e.g. ‘name DESC’

Validations:

  • String

sort
optional

Hash version of ‘order’ param

Validations:

  • Hash

sort[by]
optional

Field to sort the results on

Validations:

  • String

sort[order]
optional

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

Validations:

  • 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

Validations:

  • Hash

callback[task_id]
optional

UUID of the task

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

callback[step_id]
optional

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

Validations:

  • String

data
optional

Data to be sent to the action

Validations:

  • Hash