diff options
Diffstat (limited to 'docs/docsite/rst/rest_api/conventions.rst')
| -rw-r--r-- | docs/docsite/rst/rest_api/conventions.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/docsite/rst/rest_api/conventions.rst b/docs/docsite/rst/rest_api/conventions.rst new file mode 100644 index 0000000000..bb3c7da43a --- /dev/null +++ b/docs/docsite/rst/rest_api/conventions.rst @@ -0,0 +1,22 @@ +****************** +Conventions +****************** + +.. index:: + single: conventions + pair: API; root directory + pair: content type; JSON + + +AWX uses a standard REST API, rooted at ``/api/`` on the server. The API is versioned for compatibility reasons, and currently ``api/v2/`` is the latest available version. You can see information about what API versions are available by querying ``/api/``. + +You may have to specify the content/type on **POST** or **PUT** requests accordingly. + +- **PUT**: Update a specific resource (by an identifier) or a collection of resources. PUT can also be used to create a specific resource if the resource identifier is known before-hand. +- **POST**: Create a new resource. Also acts as a catch-all verb for operations that do not fit into the other categories. + +All URIs not ending with ``"/"`` receive a 301 redirect. + +.. note:: + + Formatting of ``extra_vars`` attached to Job Template records is preserved. YAML is returned as YAML with formatting and comments preserved, and JSON is returned as JSON.
\ No newline at end of file |