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


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

Parametri

Nome parametro Descrizione
id
opzionale

UUID of the task

Validations:

  • 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

Parametri

Nome parametro Descrizione
search
opzionale

Resume tasks matching search string

Validations:

  • Must be a String

task_ids
opzionale

Resume specific tasks by ID

Validations:

  • Must be an array of any type


GET /foreman_tasks/api/tasks
List tasks

Parametri

Nome parametro Descrizione
search
opzionale

Search string

Validations:

  • Must be a String

page
opzionale

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opzionale

Number of results per page to return

Validations:

  • Must be a number.

order
opzionale

Sort field and order, e.g. 'name DESC'

Validations:

  • Must be a String

sort
opzionale

Hash version of 'order' param

Validations:

  • Must be a Hash

sort[by]
opzionale

Field to sort the results on

Validations:

  • Must be a String

sort[order]
opzionale

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

Validations:

  • Must be a String


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

Parametri

Nome parametro Descrizione
callback
opzionale

Validations:

  • Must be a Hash

callback[task_id]
opzionale

UUID of the task

Validations:

  • 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]
opzionale

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

Validations:

  • Must be a String

data
opzionale

Data to be sent to the action

Validations:

  • Must be a Hash