List Credentials for an Inventory Update
/api/v2/inventory_updates/{id}/credentials/
Make a GET request to this resource to retrieve a list of credentials associated with the selected inventory update.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The count field indicates the total number of credentials
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 credential records.
Results
Each credential data structure includes the following fields:
id: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (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 credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)managed: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)
Sorting
To specify that credentials 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-
cloud:
string
Title:
CloudRead Only:true -
created:
string
Title:
CreatedRead Only:true -
credential_type(required):
integer
Title:
Credential TypeSpecify the type of credential you want to create. Refer to the documentation for details on each type. -
description:
string
Title:
Description -
id:
integer
Title:
IDRead Only:true -
inputs:
object Inputs
Title:
InputsEnter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. -
kind:
string
Title:
KindRead Only:true -
kubernetes:
string
Title:
KubernetesRead Only:true -
managed:
string
Title:
ManagedRead Only:true -
modified:
string
Title:
ModifiedRead Only:true -
name(required):
string
Title:
NameMinimum Length:1Maximum Length:512 -
organization:
integer
Title:
Organization - related: string
-
summary_fields:
string
Title:
Summary fieldsRead Only:true -
type:
string
Title:
TypeRead Only:true -
url:
string
Title:
UrlRead Only:true
objectInputs