List Job Events for a Host
/api/v2/hosts/{id}/job_events/
Make a GET request to this resource to retrieve a list of job events associated with the selected host.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The count field indicates the total number of job events
found for the given query. The next and previous fields provides links to
additional results if there are more than will fit on a single page. The
results list contains zero or more job event records.
Results
Each job event data structure includes the following fields:
id: Database ID for this job event. (integer)type: Data type for this job event. (choice)url: URL for this job event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job event was created. (datetime)modified: Timestamp when this job event was last modified. (datetime)job: (id)event: (choice)runner_on_failed: Host Failedrunner_on_start: Host Startedrunner_on_ok: Host OKrunner_on_error: Host Failurerunner_on_skipped: Host Skippedrunner_on_unreachable: Host Unreachablerunner_on_no_hosts: No Hosts Remainingrunner_on_async_poll: Host Pollingrunner_on_async_ok: Host Async OKrunner_on_async_failed: Host Async Failurerunner_item_on_ok: Item OKrunner_item_on_failed: Item Failedrunner_item_on_skipped: Item Skippedrunner_retry: Host Retryrunner_on_file_diff: File Differenceplaybook_on_start: Playbook Startedplaybook_on_notify: Running Handlersplaybook_on_include: Including Fileplaybook_on_no_hosts_matched: No Hosts Matchedplaybook_on_no_hosts_remaining: No Hosts Remainingplaybook_on_task_start: Task Startedplaybook_on_vars_prompt: Variables Promptedplaybook_on_setup: Gathering Factsplaybook_on_import_for_host: internal: on Import for Hostplaybook_on_not_import_for_host: internal: on Not Import for Hostplaybook_on_play_start: Play Startedplaybook_on_stats: Playbook Completedebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Error
counter: (integer)event_display: (string)event_data: (json)event_level: (integer)failed: (boolean)changed: (boolean)uuid: (string)parent_uuid: (string)host: (id)host_name: (string)playbook: (string)play: (string)task: (string)role: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)
Sorting
To specify that job events are returned in a particular
order, use the order_by query string parameter on the GET request.
?order_by=name
Prefix the field name with a dash - to sort in reverse:
?order_by=-name
Multiple sorting fields may be specified by separating the field names with a
comma ,:
?order_by=name,some_other_field
Pagination
Use the page_size query string parameter to change the number of results
returned for each request. Use the page query string parameter to retrieve
a particular page of results.
?page_size=100&page=2
The previous and next links returned with the results will set these query
string parameters automatically.
Searching
Use the search query string parameter to perform a case-insensitive search
within all designated text fields of a model.
?search=findme
(Added in Ansible Tower 3.1.0) Search across related fields:
?related__search=findme
Request
- application/json
-
page: integer
A page number within the paginated result set.
-
page_size: integer
Number of results to return per page.
-
search: string
A search term.
Response
- application/json
200 Response
object-
changed:
boolean
Title:
ChangedRead Only:true -
counter:
integer
Title:
CounterRead Only:trueMinimum Value:0 -
created:
string
Title:
CreatedRead Only:true -
end_line:
integer
Title:
End lineRead Only:trueMinimum Value:0 -
event(required):
string
Title:
EventAllowed Values:[ "runner_on_failed", "runner_on_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error" ] -
event_data:
object Event data
Title:
Event data -
event_display:
string
Title:
Event displayRead Only:trueMinimum Length:1 -
event_level:
integer
Title:
Event levelRead Only:true -
failed:
boolean
Title:
FailedRead Only:true -
host:
integer
Title:
HostRead Only:true -
host_name:
string
Title:
Host nameRead Only:trueMinimum Length:1 -
id:
integer
Title:
IDRead Only:true -
job:
string
Title:
JobRead Only:true -
modified:
string
Title:
ModifiedRead Only:true -
parent_uuid:
string
Title:
Parent uuidRead Only:trueMinimum Length:1 -
play:
string
Title:
PlayRead Only:trueMinimum Length:1 -
playbook:
string
Title:
PlaybookRead Only:trueMinimum Length:1 - related: string
-
role:
string
Title:
RoleRead Only:trueMinimum Length:1 -
start_line:
integer
Title:
Start lineRead Only:trueMinimum Value:0 -
stdout:
string
Title:
StdoutRead Only:trueMinimum Length:1 -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
task:
string
Title:
TaskRead Only:trueMinimum Length:1 -
type:
string
Title:
TypeRead Only:true -
url:
string
Title:
UrlRead Only:true -
uuid:
string
Title:
UuidRead Only:trueMinimum Length:1 -
verbosity:
integer
Title:
VerbosityRead Only:trueMinimum Value:0
objectEvent data