mirror of
https://github.com/ansible/awx.git
synced 2026-03-22 11:25:08 -02:30
Updated API docs to reflect new features in 2.0.
This commit is contained in:
@@ -54,7 +54,7 @@ within all designated text fields of a model.
|
|||||||
|
|
||||||
?search=findme
|
?search=findme
|
||||||
|
|
||||||
_New since AWX 1.4_
|
_Added in AWX 1.4_
|
||||||
|
|
||||||
## Filtering
|
## Filtering
|
||||||
|
|
||||||
@@ -75,7 +75,7 @@ To exclude results matching certain criteria, prefix the field parameter with
|
|||||||
|
|
||||||
?not__field=value
|
?not__field=value
|
||||||
|
|
||||||
(_New since AWX 1.4_) By default, all query string filters are AND'ed together, so
|
(_Added in AWX 1.4_) By default, all query string filters are AND'ed together, so
|
||||||
only the results matching *all* filters will be returned. To combine results
|
only the results matching *all* filters will be returned. To combine results
|
||||||
matching *any* one of multiple criteria, prefix each query string parameter
|
matching *any* one of multiple criteria, prefix each query string parameter
|
||||||
with `or__`:
|
with `or__`:
|
||||||
@@ -83,7 +83,7 @@ with `or__`:
|
|||||||
?or__field=value&or__field=othervalue
|
?or__field=value&or__field=othervalue
|
||||||
?or__not__field=value&or__field=othervalue
|
?or__not__field=value&or__field=othervalue
|
||||||
|
|
||||||
(_New in Ansible Tower 1.4.5_) The default AND filtering applies all filters
|
(_Added in Ansible Tower 1.4.5_) The default AND filtering applies all filters
|
||||||
simultaneously to each related object being filtered across database
|
simultaneously to each related object being filtered across database
|
||||||
relationships. The chain filter instead applies filters separately for each
|
relationships. The chain filter instead applies filters separately for each
|
||||||
related object. To use, prefix the query string parameter with `chain__`:
|
related object. To use, prefix the query string parameter with `chain__`:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
{% if new_in_13 %}> _Added in AWX 1.3_{% endif %}
|
{% if new_in_13 %}> _Added in AWX 1.3_{% endif %}
|
||||||
{% if new_in_14 %}> _Added in AWX 1.4_{% endif %}
|
{% if new_in_14 %}> _Added in AWX 1.4_{% endif %}
|
||||||
{% if new_in_145 %}> _Added in Ansible Tower 1.4.5_{% endif %}
|
{% if new_in_145 %}> _Added in Ansible Tower 1.4.5_{% endif %}
|
||||||
{% if new_in_148 %}> _New in Ansible Tower 1.4.8_{% endif %}
|
{% if new_in_148 %}> _Added in Ansible Tower 1.4.8_{% endif %}
|
||||||
{% if new_in_200 %}> _New in Ansible Tower 2.0.0_{% endif %}
|
{% if new_in_200 %}> _New in Ansible Tower 2.0.0_{% endif %}
|
||||||
|
|||||||
@@ -9,8 +9,8 @@ the following fields (some fields may not be visible to all users):
|
|||||||
use when creating/editing a project.
|
use when creating/editing a project.
|
||||||
* `time_zone`: The configured time zone for the server.
|
* `time_zone`: The configured time zone for the server.
|
||||||
* `license_info`: Information about the current license.
|
* `license_info`: Information about the current license.
|
||||||
* `version`: Version of Ansible Tower (AWX) package installed.
|
* `version`: Version of Ansible Tower package installed.
|
||||||
|
|
||||||
Make a POST request to this resource as a super user to install or update the
|
(_New in Ansible Tower 2.0.0_) Make a POST request to this resource as a super
|
||||||
existing license. The license data itself can be POSTed as a normal json data
|
user to install or update the existing license. The license data itself can
|
||||||
structure.
|
be POSTed as a normal json data structure.
|
||||||
|
|||||||
@@ -38,3 +38,5 @@ Data about failed and successfull hosts by inventory will be given as:
|
|||||||
"id": 2,
|
"id": 2,
|
||||||
"name": "Test Inventory"
|
"name": "Test Inventory"
|
||||||
},
|
},
|
||||||
|
|
||||||
|
{% include "api/_new_in_awx.md" %}
|
||||||
|
|||||||
@@ -33,3 +33,5 @@ Data will be returned in the following format:
|
|||||||
|
|
||||||
Each element contains an epoch timestamp represented in seconds and a numerical value indicating
|
Each element contains an epoch timestamp represented in seconds and a numerical value indicating
|
||||||
the number of events during that time period
|
the number of events during that time period
|
||||||
|
|
||||||
|
{% include "api/_new_in_awx.md" %}
|
||||||
|
|||||||
@@ -1 +1,3 @@
|
|||||||
Make a GET request to this resource to retrieve aggregate statistics for Tower
|
Make a GET request to this resource to retrieve aggregate statistics for Tower.
|
||||||
|
|
||||||
|
{% include "api/_new_in_awx.md" %}
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ object containing groups, including the hosts, children and variables for each
|
|||||||
group. The response data is equivalent to that returned by passing the
|
group. The response data is equivalent to that returned by passing the
|
||||||
`--list` argument to an inventory script.
|
`--list` argument to an inventory script.
|
||||||
|
|
||||||
_(New since AWX 1.3)_ Specify a query string of `?hostvars=1` to retrieve the JSON
|
_(Added in AWX 1.3)_ Specify a query string of `?hostvars=1` to retrieve the JSON
|
||||||
object above including all host variables. The `['_meta']['hostvars']` object
|
object above including all host variables. The `['_meta']['hostvars']` object
|
||||||
in the response contains an entry for each host with its variables. This
|
in the response contains an entry for each host with its variables. This
|
||||||
response format can be used with Ansible 1.3 and later to avoid making a
|
response format can be used with Ansible 1.3 and later to avoid making a
|
||||||
@@ -18,7 +18,7 @@ separate API request for each host. Refer to
|
|||||||
[Tuning the External Inventory Script](http://docs.ansible.com/developing_inventory.html#tuning-the-external-inventory-script)
|
[Tuning the External Inventory Script](http://docs.ansible.com/developing_inventory.html#tuning-the-external-inventory-script)
|
||||||
for more information on this feature.
|
for more information on this feature.
|
||||||
|
|
||||||
_(New since AWX 1.4)_ By default, the inventory script will only return hosts that
|
_(Added in AWX 1.4)_ By default, the inventory script will only return hosts that
|
||||||
are enabled in the inventory. This feature allows disabled hosts to be skipped
|
are enabled in the inventory. This feature allows disabled hosts to be skipped
|
||||||
when running jobs without removing them from the inventory. Specify a query
|
when running jobs without removing them from the inventory. Specify a query
|
||||||
string of `?all=1` to return all hosts, including disabled ones.
|
string of `?all=1` to return all hosts, including disabled ones.
|
||||||
|
|||||||
@@ -23,3 +23,5 @@ Will show only failed plays. Alternatively `false` may be used.
|
|||||||
?play_icontains=test
|
?play_icontains=test
|
||||||
|
|
||||||
Will filter plays matching the substring `test`
|
Will filter plays matching the substring `test`
|
||||||
|
|
||||||
|
{% include "api/_new_in_awx.md" %}
|
||||||
|
|||||||
@@ -25,3 +25,5 @@ Will show only failed plays. Alternatively `false` may be used.
|
|||||||
?task_icontains=test
|
?task_icontains=test
|
||||||
|
|
||||||
Will filter tasks matching the substring `test`
|
Will filter tasks matching the substring `test`
|
||||||
|
|
||||||
|
{% include "api/_new_in_awx.md" %}
|
||||||
|
|||||||
@@ -11,6 +11,11 @@ Use the `format` query string parameter to specify the output format.
|
|||||||
* HTML: `?format=html`
|
* HTML: `?format=html`
|
||||||
* Plain Text: `?format=txt`
|
* Plain Text: `?format=txt`
|
||||||
* Plain Text with ANSI color codes: `?format=ansi`
|
* Plain Text with ANSI color codes: `?format=ansi`
|
||||||
|
* JSON structure: `?format=json`
|
||||||
|
|
||||||
|
(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON
|
||||||
|
formats, the `start_line` and `end_line` query string parameters can be used
|
||||||
|
to specify a range of line numbers to retrieve.
|
||||||
|
|
||||||
When using the HTML or API formats, use the `scheme` query string parameter to
|
When using the HTML or API formats, use the `scheme` query string parameter to
|
||||||
change the output colors. The value must be one of the following (default is
|
change the output colors. The value must be one of the following (default is
|
||||||
|
|||||||
@@ -402,6 +402,7 @@ class ScheduleUnifiedJobsList(SubListAPIView):
|
|||||||
parent_model = Schedule
|
parent_model = Schedule
|
||||||
relationship = 'unifiedjob_set'
|
relationship = 'unifiedjob_set'
|
||||||
view_name = 'Schedule Jobs List'
|
view_name = 'Schedule Jobs List'
|
||||||
|
new_in_148 = True
|
||||||
|
|
||||||
class AuthTokenView(APIView):
|
class AuthTokenView(APIView):
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user