REST API
スクリプトからフォームを起動し、AnsibleForms を管理します
開発者と自動化エンジニア向けです。スクリプトからフォームを起動し、AnsibleForms を管理します。
Web インターフェースが行うことはすべて REST API を経由するため、スクリプトやほかのツールでも同じことができます。
概要
API は AnsibleForms サーバーの /api/v2 で提供されています。
- 完全なリファレンス : これらのページでは、スクリプトでよく使うものを説明しています。すべてのエンドポイントは、 サーバーに組み込まれた Swagger ページ
https://<your server>/api/v2/docsで説明されており、試すこともできます。 - 権限 : 呼び出しは、ブラウザーと同じく、そのトークンの持ち主であるユーザーとして、そのユーザーのロールで実行されます。
- 起動時の検証 : API から起動したジョブも、ブラウザーからの起動と同じようにチェックできます （ 起動時の検証 を参照）。
- レート制限 : 制限されるのは、ログイン、ログアウト、トークンの更新、シングルサインオンのエンドポイント、パスワードの変更 （
PUT /api/v2/profile）、API トークンのエンドポイント（POSTとDELETE /api/v2/profile/tokens）だけです（ 認証 を参照）。それ以外の呼び出しにはレート制限がありません（ チャットアシスタント には独自の 制限があります）。そのため、たとえばジョブを追跡するときなどは、スクリプト側で呼び出しの間隔を調整してください。
このセクションの内容
トピックごとに個別のページがあります。