Foreman tasks

>>>

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

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
>>>

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

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
id
optional

UUID of the task

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

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

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
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

For every search it returns the list of tasks that satisfty the condition. The reason for supporting multiple searches is the UI that might be ending needing periodic updates on task status for various searches at the same time. This way, it is possible to get all the task statuses with one request.

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
searches
optional

List of uuids to fetch info about

Validations:

  • Must be an Array of nested elements
searches[search_id]
optional

Arbitraty value for client to identify the the request parts with results. It's passed in the results to be able to pair the requests and responses properly.

Validations:

  • String
searches[type]
optional

Validations:

  • Must be one of: user, resource, task.
searches[task_id]
optional

In case :type = 'task', find the task by the uuid

Validations:

  • String
searches[user_id]
optional

In case :type = 'user', find tasks for the user

Validations:

  • String
searches[resource_type]
optional

In case :type = 'resource', what resource type we're searching the tasks for

Validations:

  • String
searches[resource_type]
optional

In case :type = 'resource', what resource id we're searching the tasks for

Validations:

  • String
searches[action_types]
optional

Return just tasks of given action type, e.g. `[“Actions::Katello::Repository::Synchronize”]`

Validations:

  • Must be one of: String.
searches[active_only]
optional

Validations:

  • Must be one of: true, false, 1, 0.
searches[page]
optional

Validations:

  • String
searches[per_page]
optional

Validations:

  • String
>>>

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

Resumes all selected resumable tasks. If neither a search query nor an explicit list of task IDs is provided, it tries to resume all tasks in paused state with result error.

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

Resume tasks matching search string

Validations:

  • String
task_ids
optional

Resume specific tasks by ID

Validations:

  • Must be an array of any type
>>>

POST /foreman_tasks/api/tasks/bulk_cancel
Cancel selected cancellable tasks

Cancels all selected cancellable tasks. 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

Cancel tasks matching search string

Validations:

  • String
task_ids
optional

Cancel specific tasks by ID

Validations:

  • Must be an array of any type
>>>

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
>>>

GET /foreman_tasks/api/tasks
List tasks

GET /foreman_tasks/api/tasks/:parent_task_id/sub_tasks
Show sub_tasks details

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
parent_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..
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.
>>>

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

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
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
callbacks
optional

Validations:

  • Must be an Array of nested elements
callbacks[callback]
optional

Validations:

  • Hash
callbacks[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..
callbacks[callback][step_id]
optional

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

Validations:

  • String
callbacks[data]
optional

Data to be sent to the action

Validations:

  • Hash