Make a GET request to this resource to retrieve a list of inventory updates associated with the selected inventory source.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of inventory updates 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 inventory update records.

Results

Each inventory update data structure includes the following fields:

• id: Database ID for this inventory update. (integer)
• type: Data type for this inventory update. (choice)
• url: URL for this inventory update. (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 inventory update was created. (datetime)
• modified: Timestamp when this inventory update was last modified. (datetime)
• name: Name of this inventory update. (string)
• description: Optional description of this inventory update. (string)
• unified_job_template: (id)
• launch_type: (choice)
  • manual: Manual
  • relaunch: Relaunch
  • callback: Callback
  • scheduled: Scheduled
  • dependency: Dependency
  • workflow: Workflow
  • webhook: Webhook
  • sync: Sync
  • scm: SCM Update
• status: (choice)
  • new: New
  • pending: Pending
  • waiting: Waiting
  • running: Running
  • successful: Successful
  • failed: Failed
  • error: Error
  • canceled: Canceled
• failed: (boolean)
• started: The date and time the job was queued for starting. (datetime)
• finished: The date and time the job finished execution. (datetime)
• canceled_on: The date and time when the cancel request was sent. (datetime)
• elapsed: Elapsed time in seconds that the job ran. (decimal)
• job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
• execution_node: The node the job executed on. (string)
• source: (choice)
  • file: File, Directory or Script
  • scm: Sourced from a Project
  • ec2: Amazon EC2
  • gce: Google Compute Engine
  • azure_rm: Microsoft Azure Resource Manager
  • vmware: VMware vCenter
  • satellite6: Red Hat Satellite 6
  • openstack: OpenStack
  • rhv: Red Hat Virtualization
  • tower: Ansible Tower
  • custom: Custom Script
• source_path: (string)
• source_script: (id)
• source_vars: Inventory source variables in YAML or JSON format. (string)
• credential: Cloud credential to use for inventory updates. (integer)
• enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)
• enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)
• host_filter: Regex where only matching hosts will be imported into Tower. (string)
• overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
• overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
• custom_virtualenv: (string)
• timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
• verbosity: (choice)
  • 0: 0 (WARNING)
  • 1: 1 (INFO)
  • 2: 2 (DEBUG)
• inventory: (id)
• inventory_source: (id)
• license_error: (boolean)
• org_host_limit_error: (boolean)
• source_project_update: Inventory files from this Project Update were used for the inventory update. (id)

Sorting

To specify that inventory updates 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