Documentation

4. Configuration API Endpoint

Site configuration settings and general information.

GET /api/v1/config/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, DELETE, HEAD, OPTIONS
X-API-Time: 0.223s


{
    "eula": "TOWER SOFTWARE END USER LICENSE AGREEMENT Unless otherwise agreed to, and executed in a definitive agreement, between Ansible, Inc.
    (201cAnsible201d) and the individual or entity (201cCustomer201d) signing or electronically accepting these terms of use for the Tower Software
    (201cEULA201d), all Tower Software, including any and all versions released or made available by Ansible, shall be subject to the Ansible Software
    Subscription and Services Agreement found at http://www.ansible.com/subscription-agreement (201cAgreement201d). Ansible is not responsible for
    any additional obligations, conditions or warranties agreed to between Customer and an authorized distributor, or reseller, of the Tower Software.
    BY DOWNLOADING AND USING THE TOWER SOFTWARE, OR BY CLICKING ON THE 201cYES201d BUTTON OR OTHER BUTTON OR MECHANISM DESIGNED TO ACKNOWLEDGE CONSENT
    TO THE TERMS OF AN ELECTRONIC COPY OF THIS EULA, THE CUSTOMER HEREBY ACKNOWLEDGES THAT CUSTOMER HAS READ, UNDERSTOOD, AND AGREES TO BE BOUND BY THE
    TERMS OF THIS EULA AND AGREEMENT, INCLUDING ALL TERMS INCORPORATED HEREIN BY REFERENCE, AND THAT THIS EULA AND AGREEMENT IS EQUIVALENT TO ANY
    WRITTEN NEGOTIATED AGREEMENT BETWEEN CUSTOMER AND ANSIBLE. THIS EULA AND AGREEMENT IS ENFORCEABLE AGAINST ANY PERSON OR ENTITY THAT USES OR AVAILS
    ITSELF OF THE TOWER SOFTWARE OR ANY PERSON OR ENTITY THAT USES THE OR AVAILS ITSELF OF THE TOWER SOFTWARE ON ANOTHER PERSON2019S OR ENTITY2019S BEHALF.",
    "license_info": {},
    "analytics_status": "detailed",
    "version": "3.0.0-0.git201510071505",
    "project_base_dir": "/var/lib/awx/projects",
    "time_zone": "America/New_York",
    "ansible_version": "1.9.2",
    "project_local_paths": []
}

Make a GET request to this resource to retrieve the configuration containing the following fields (some fields may not be visible to all users):

  • project_base_dir: Path on the server where projects and playbooks are stored.
  • project_local_paths: List of directories beneath project_base_dir to use when creating/editing a project.
  • time_zone: The configured time zone for the server.
  • license_info: Information about the current license.
  • version: Version of Ansible Tower package installed.
  • eula: The current End-User License Agreement

(New in Ansible Tower 2.0.0) Make a POST request to this resource as a super user to install or update the existing license. The license data itself can be POSTed as a normal json data structure.

(New in Ansible Tower 2.1.1) The POST must include a eula_accepted boolean element indicating acceptance of the End-User License Agreement.

4.1. Reviewing the Options Endpoint

The Options Endpoint table offers a view of the Options for this endpoint. When viewing the endpoint in the browsable API, clicking the “Options” button gives you the raw JSON for the following:

name Configuration
description Site configuration settings and general information.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.2