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


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

參數

參數名字 描述
id
選填

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

參數

參數名字 描述
search
選填

Resume tasks matching search string


Value:

Must be String

task_ids
選填

Resume specific tasks by id


Value:

Must be an array of any type


GET /foreman_tasks/api/tasks
List tasks

參數

參數名字 描述
search
選填

Search string


Value:

Must be String

page
選填

Page number, starting at 1


Value:

Must be a number.

per_page
選填

Number of results per page to return


Value:

Must be a number.

order
選填

Sort field and order, eg. 'name DESC'


Value:

Must be String

sort
選填

Hash version of 'order' param


Value:

Must be a Hash

sort[by]
選填

Field to sort the results on


Value:

Must be String

sort[order]
選填

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)

參數

參數名字 描述
callback
選填

Value:

Must be a Hash

callback[task_id]
選填

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]
選填

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


Value:

Must be String

data
選填

Data to be sent to the action


Value:

Must be Hash