AppScan Enterprise REST API
About this task
REST API は、Swagger フレームワークを使用して作成された対話式ページを通じて使用可能です。APIの機能をよりよく理解するために、https://<domain>:9443/ase/api/pages/apidocs.html のリンクを使用してインタラクティブページにアクセスし、APIを表示および実行します。
Note:
AppScan Enterprise バージョン 9.0.3.10 リリース以降、スキャン管理 API の下で使用可能なすべての API が、Swagger 経由でも使用可能になりました。
以下に、AppScan Enterprise で使用可能な API を示します。
| API | 説明 |
|---|---|
| ログイン | ユーザー名およびパスワードを渡してアプリケーションにログインします。 |
| keylogin | 生成された API 鍵を使用してアプリケーションにログインします。 |
| logout | アプリケーションからログアウトします。 |
| アプリケーション | 作成、編集、削除、エクスポートなど、そのアプリケーション特有の操作を実行する API です。 |
| appimport | ファイルからアプリケーションの詳細をインポートし、インポートのステータスと概要ログを取り出す API です。 |
| appattributedefinitions | アプリケーション・プロファイル・テンプレートの詳細を取得します。 |
| アクセス | アプリケーション・アクセス制御 – アプリケーションへのユーザー・アクセスを作成、編集、リストおよび削除する API です。 |
| issuetypes | 問題のタイプを作成、編集、リストおよび削除する API です。 |
| 問題 | 各種レポートの生成、問題の更新、問題の詳細の取得、レポート・ジョブのステータスの取得などを行う API です。 |
| issueimport | ファイルからの問題のインポート、ステータスおよび概要ログ・インポートの取り出しを行う API です。 |
| scanners | スキャナーのリストおよび指定したスキャナーのアイコンの取得を行う API です。 |
| issueattributedefinitions | プロファイル・テンプレートの詳細を取得する API です。 |
| ダッシュボード (dashboard) | ダッシュボードの生データを取得する API です。 |
| summaries | 指定した特定の照会のアプリケーション/問題の概要および件数を取得する API です。 |
| テンプレート | テンプレートのリストの取得、テンプレートのアップロードとダウンロード、テンプレート詳細の取り出しを行う API です。 |
| scansmanagement | スキャンのアクティビティーのリストと変更を行う API です。 |
| folderitems | フォルダー項目のリスト、編集、削除、レポートのリスト、スキャン・ログの取得、統計などを行う API です。 |
| ジョブ | dast.config ジョブの作成、編集、ダウンロード、アクションの実行、スキャン構成の更新などを行う API です。 |
| フォルダー | リスト・フォルダー項目の作成、編集、削除、フォルダーのロールの変更を行う API です。 |
| tespolicies | 使用可能なすべてのテスト・ポリシーのリストおよびユーザーにアクセス権限があるポリシーのリストを行う API です。 |
| 報告書 | XML 形式でレポート・データ、問題の詳細の取得を行う API です。 |
| アカウント | API 鍵の取得、生成および削除を行う API です。 |
| currentuser_v2 | 現在のユーザー情報の取得を行う API です。 |
| usertypes | ユーザー・タイプおよびユーザー・タイプに関連した許可のリスト、作成、編集、削除を行う API です。 |
| usersecuritypermission | ユーザー・セキュリティー許可の作成、リストおよび削除を行う API です。 |
| consoleusers | ユーザーを作成、編集、リストおよび削除する API です。 |
| servergroups | サーバー・グループを作成、編集、リストおよび削除する API です。 |
| standards | 使用可能な準拠標準のリストおよび指定した準拠標準のセクションのリストを行う API です。 |
| trends | 指定したメトリック・タイプの傾向データの取得および傾向の再計算を行う API です。 |
| agentServer | すべてのエージェントサーバーのリストを取得するためのAPI。 |
| metrics | AppScan Enterpriseのメタデータとデータベースサイズの成長情報を取得するためのAPI。 |
| activitylog | 指定された期間のアクティビティのリストを取得するためのAPI。 |
| vulnerablecomponent | 脆弱なコンポーネントバージョンに関する情報を管理および取得するためのAPI。 |
| ライセンス | ライセンス権利とその有効期限のリストを取得するためのAPI。 |
| historicdata | メタデータやインポートされた問題を含むアプリケーションの履歴データを取得するためのAPI。 |
| currentuser | 現在ログインしているユーザーの基本情報を取得するためのAPI。 |
| 報告書 | さまざまなレポートの問題の詳細を取得するためのAPI。 |
| バージョン | 製品バージョンとDASTクライアントの詳細を取得するためのAPI。 |