List Custom Inventory Scripts

get

/api/v2/inventory_scripts/

Make a GET request to this resource to retrieve the list of custom inventory scripts.

The resulting data structure contains:

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

The count field indicates the total number of custom inventory scripts 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 custom inventory script records.

Results

Each custom inventory script data structure includes the following fields:

  • id: Database ID for this custom inventory script. (integer)
  • type: Data type for this custom inventory script. (choice)
  • url: URL for this custom inventory script. (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 custom inventory script was created. (datetime)
  • modified: Timestamp when this custom inventory script was last modified. (datetime)
  • name: Name of this custom inventory script. (string)
  • description: Optional description of this custom inventory script. (string)
  • script: (string)
  • organization: Organization owning this inventory script (id)

Sorting

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

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

403 Response

Body
Example Response (application/json)
{
    "detail":"Filtering on script is not allowed."
}
Back to Top