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


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

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 all cancellable tasks

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 all stoppable tasks

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 field and order, eg. ‘id 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