Documentation

設定の API エンドポイント

サイト設定および一般情報。

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": []
}

このリソースに GET リクエストを実行して、以下のフィールドを含む設定を取得します (ユーザーによってはすべてのフィールドが表示されない場合もあります)。

  • project_base_dir: プロジェクトと playbook が保存されているサーバー上のパス
  • project_local_paths: プロジェクトの作成および編集時に使用する、project_base_dir 下にあるディレクトリー一覧
  • time_zone: サーバーに設定されたタイムゾーン
  • license_info: ライセンス情報
  • version: インストールされている Ansible Tower パッケージのバージョン
  • eula: 使用許諾契約書

(Ansible Tower 2.0.0 から) スーパーユーザーとしてリソースに POST リクエストを実行すると、既存のライセンスをインストールもしくは更新することができます。ライセンスデータ自体は、通常の json データ構造で POST されます。

(Ansible Tower 2.1.1 から) POST には eula_accepted のブール値要素を含めて使用許諾契約書への合意を示す必要があります。

オプションエンドポイントの確認

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

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