AppScan Enterprise REST API
About this task
REST API 可以透過使用 Swagger 架構建立的互動式頁面取得。使用連結 https://<domain>:9443/ase/api/pages/apidocs.html 存取互動頁面,以檢視和運行 API(s),更好地了解其功能。
Note:
從 AppScan Enterprise 9.0.3.10 版開始,可以在掃描管理 API 底下取得的 API,現在也可以透過 Swagger 取得。
以下列出可以在 AppScan Enterprise 取得的 API:
| API | 說明 |
|---|---|
| 登入 | 登入應用程式傳遞使用者名稱和密碼。 |
| keylogin | 使用產生的 apikey 登入應用程式。 |
| logout | 從應用程式登出。 |
| 應用程式 | 用來執行「應用程式」特定作業的 API,例如建立、編輯、刪除、匯出等等。 |
| appimport | 用來從檔案匯入應用程式詳細資料、提取匯入的狀態和摘要日誌的 API。 |
| appattributedefinitions | 取得應用程式設定檔範本詳細資料。 |
| 存取 | 應用程式存取控制 – 用來建立、編輯、列出或刪除應用程式之使用者存取權的 API。 |
| issuetypes | 用來建立、編輯、列出及刪除問題類型的 API。 |
| 問題 | 用來產生各種報告、更新問題、取得問題詳細資料、取得報告工作之狀態等等的 API。 |
| issueimport | 用來從檔案匯入問題、提取匯入之狀態和摘要日誌的 API。 |
| 掃描器 | 用來列出掃描器並且取得給定掃描器之圖示的 API。 |
| issueattributedefinitions | 用來取得問題設定檔範本詳細資料的 API。 |
| 儀表板 (dashboard) | 用來取得儀表版原始資料的 API。 |
| 摘要 | 用來取得給定特定查詢之應用程式/問題摘要和計數的 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 用於獲取給定指標類型的趨勢數據並重新計算趨勢。 |
| <uicontrol>agentServer</uicontrol> | API 用於獲取所有代理伺服器的列表。 |
| <uicontrol>metrics</uicontrol> | API 用於獲取 AppScan Enterprise 元數據和數據庫大小增長信息。 |
| <uicontrol>activitylog</uicontrol> | API 用於獲取指定時間範圍內的活動列表。 |
| <uicontrol>vulnerablecomponent</uicontrol> | API 用於管理和檢索有關易受攻擊的組件版本的信息。 |
| 授權 | API 用於獲取許可權利清單及其到期日期。 |
| <uicontrol>historicdata</uicontrol> | API 用於獲取應用程序的歷史數據,包括元數據和導入的問題。 |
| <uicontrol>currentuser</uicontrol> | API 用於獲取當前登錄用戶的基本信息。 |
| 報告 | API 用於獲取各種報告的問題詳細信息。 |
| 版本 | API 用於獲取產品版本和 DAST 客戶端詳細信息。 |