Wallarm API概要¶

Wallarm APIはWallarmシステムのコンポーネント間での連携を提供します。Wallarm APIメソッドを使用して、以下のインスタンスを作成、取得、または更新できます:

vulnerabilities
attacks
incidents
users
clients
filter nodes
etc.

APIメソッドの説明は、Wallarm Console → top right → ? → Wallarm API Consoleから、または直接以下のリンクから確認できます:

https://apiconsole.us1.wallarm.com/ for the US cloud
https://apiconsole.eu1.wallarm.com/ for the EU cloud

APIエンドポイント¶

APIリクエストは次のURLに送信されます:

https://us1.api.wallarm.com/ for the US cloud
https://api.wallarm.com/ for the EU cloud

APIリクエストの認証¶

Wallarm APIリクエストを行うには、認証済みユーザーである必要があります。APIリクエストの認証方法は、リクエストを送信するクライアントによって異なります:

API Reference UI
Your own API client

Wallarm API Console¶

リクエスト認証にはトークンが使用されます。トークンはWallarmアカウントへの認証に成功後に生成されます。

次のリンクを使用してWallarm Consoleにサインインしてください:
- https://us1.my.wallarm.com/ for the US cloud
- https://my.wallarm.com/ for the EU cloud
次のリンクを使用してWallarm API Consoleページを更新してください:
- https://apiconsole.us1.wallarm.com/ for the US cloud
- https://apiconsole.eu1.wallarm.com/ for the EU cloud
必要なAPIメソッドに移動し、Try it outセクションでパラメータ値を入力してExecuteしてください。

Your own API client¶

ご自身のAPIクライアントからWallarm APIにリクエストを認証するには:

US CloudまたはEU CloudのWallarmアカウントにサインインし、Settings → API tokensに移動してください。
Create tokenしてWallarm APIへアクセスしてください。
トークンを開いて、Tokenセクションから値をコピーしてください。
必要なAPIリクエストを送信する際、X-WallarmApi-TokenヘッダーにTokenの値を渡してください。

API tokensの詳細 →

WallarmのAPI開発およびドキュメントへのアプローチ¶

Wallarm API Referenceは、すべての表示データがAPIから動的に取得されるシングルページアプリケーション(SPA)です。この設計により、Wallarmは新たなデータと機能が最初に公開APIで利用可能になり、その後API Referenceに記載されるAPI-firstアプローチを推奨します。通常、新機能は公開APIとAPI Referenceの両方で並行してリリースされますが、場合によってはAPI Referenceの変更に先行して新たなAPI変更がリリースされ、一部の機能は公開API経由でのみ利用可能になることもあります。

Wallarm API Referenceは、Swaggerファイルから生成され、Swagger UIツールを使用しています。API Referenceは、利用可能なAPIエンドポイント、メソッド、及びデータ構造を理解する簡単な方法を提供し、すべての利用可能なエンドポイントを試すシンプルな方法も提供します。