AppScan Enterprise REST API
執行這項作業的原因和時機
REST API 可透過使用 Swagger 框架建立的互動式頁面存取。使用連結 https://<domain>:9443/ase/api/pages/apidocs.html 存取互動式頁面,以檢視並執行 API 來更了解其功能。
註:
從 AppScan Enterprise 版本 9.0.3.10 發布開始,Scan Managements API 下可用的所有 API
也都可以透過 Swagger 存取。
以下列出了 AppScan Enterprise 中可用的 API:
| API | 描述 |
|---|---|
| login | 傳遞使用者名稱和密碼登入應用程式。 |
| keylogin | 使用產生的 API 金鑰 (apikey) 登入應用程式。 |
| logout | 從應用程式登出。 |
| applications | 用於執行「應用程式」特定操作的 API,如建立、編輯、刪除、匯出等。 |
| appimport | 用於從檔案匯入應用程式詳細資訊、取得狀態和匯入摘要日誌的 API。 |
| appattributedefinitions | 取得應用程式設定檔範本詳細資訊。 |
| access | 應用程式存取控制 – 用於建立、編輯、列出和刪除使用者對應用程式之存取權限的 API。 |
| issuetypes | 用於建立、編輯、列出和刪除問題類型的 API。 |
| issues | 用於產生各種報告、更新問題、取得問題詳細資訊、取得報告工作狀態等的 API。 |
| issueimport | 用於從檔案匯入問題、取得狀態和匯入摘要日誌的 API。 |
| scanners | 用於列出掃描程式並取得給定掃描程式圖示的 API。 |
| issueattributedefinitions | 用於取得問題設定檔範本詳細資訊的 API。 |
| dashboard | 用於取得儀表板原始資料的 API。 |
| summaries | 用於取得給定特定查詢的應用程式/問題摘要和計數的 API。 |
| templates | 用於取得範本清單、上傳和下載範本、取得範本詳細資訊的 API。 |
| scansmanagement | 用於列出和修改掃描活動的 API。 |
| folderitems | 用於列出、建立、編輯、刪除資料夾項目,列出報告,擷取掃描日誌、統計資訊等的 API。 |
| jobs | 用於建立、編輯、下載 dast.config 工作、執行操作、更新掃描配置、配置損壞的存取控制測試等的 API。 |
| folders | 用於建立、編輯、刪除、列出資料夾項目,修改資料夾角色等的 API。 |
| tespolicies | 用於列出所有可用測試原則並列出使用者有權存取的原則的 API。 |
| reports | 用於取得 XML 格式之報告資料、問題詳細資訊等的 API。 |
| account | 用於取得、產生和刪除 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。 |
| license | 用於取得授權權利清單及其到期日期的 API。 |
| historicdata | 用於取得應用程式歷史資料(包含中繼資料和匯入的問題)的 API。 |
| currentuser | 用於取得有關目前登入使用者之基本資訊的 API。 |
| reports | 用於取得各種報告之問題詳細資訊的 API。 |
| version | 用於取得產品版本和 DAST 用戶端詳細資訊的 API。 |