List Inventories

get

/api/v2/inventories/

Make a GET request to this resource to retrieve the list of inventories.

The resulting data structure contains:

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

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

Results

Each inventory data structure includes the following fields:

  • id: Database ID for this inventory. (integer)
  • type: Data type for this inventory. (choice)
  • url: URL for this inventory. (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 was created. (datetime)
  • modified: Timestamp when this inventory was last modified. (datetime)
  • name: Name of this inventory. (string)
  • description: Optional description of this inventory. (string)
  • organization: Organization containing this inventory. (id)
  • kind: Kind of inventory being represented. (choice)
    • "": Hosts have a direct link to this inventory.
    • smart: Hosts for inventory generated using the host_filter property.
  • host_filter: Filter that will be applied to the hosts of this inventory. (string)
  • variables: Inventory variables in JSON or YAML format. (json)
  • has_active_failures: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)
  • total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
  • hosts_with_active_failures: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)
  • total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
  • has_inventory_sources: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)
  • total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
  • inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
  • pending_deletion: Flag indicating the inventory is being deleted. (boolean)

Sorting

To specify that inventories 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 Oracle Linux Automation Manaer) Search across related fields:

?related__search=findme

Request

Supported Media Types
Query Parameters
Back to Top

Response

200 Response

Back to Top