AppScan Enterprise REST API
About this task
REST API 可通过使用 Swagger 框架创建的交互式页面获得。通过使用链接 https://:9443/ase/api/pages/apidocs.html 访问交互式页面,以查看和运行 API,从而更好地理解其功能。
Note:
从 AppScan Enterprise V9.0.3.10 版本开始,所有扫描管理 API下的 API 也都可以通过 Swagger 获取。
Note:
当您使用 REST API 获取问题详细信息时(例如,检索单个问题或所有应用程序问题的列表),响应有效负载现在包含扫描级别属性。这些属性提供与问题关联的扫描类型、测试优化级别和测试策略配置。有关端点和有效负载结构的完整列表,请参阅 Swagger 界面。
以下列出了 AppScan Enterprise 提供的 API:
| API | 描述 |
|---|---|
| login | 通过用户名和密码登录到应用程序。 |
| keylogin | 使用生成的 API 密钥登录到应用程序。 |
| logout | 从应用程序注销。 |
| applications | 执行“应用程序”特定操作(如创建、编辑、删除和导出等)的 API。 |
| appimport | 从文件导入应用程序详细信息、获取状态和导入日志摘要的 API。 |
| appattributedefinitions | 应用程序概要信息模板详细信息。 |
| access | 应用程序访问控制 - 创建、编辑、列出和删除用户访问应用程序情况的 API。 |
| issuetypes | 创建、编辑、列出和删除问题类型的 API。 |
| issues | 生成各种报告、更新问题、获取问题详细信息、获取报告作业状态等的 API。 |
| issueimport | 从文件导入问题、获取状态和汇总导入日志的 API。 |
| scanners | 列出扫描程序并获取给定扫描程序的图标的 API。 |
| issueattributedefinitions | 获取问题概要信息模板详细信息的 API。 |
| 仪表板 | 获取仪表板原始数据的 API。 |
| summaries | 获取既有特定查询的应用程序/问题的汇总和计数的 API。 |
| templates | 获取模板列表、上载和下载模板、获取模板详细信息的 API。 |
| scansmanagement | 列出和修改扫描活动的 API。 |
| folderitems | 列出、创建、编辑、删除文件夹项、列出报告、检索扫描日志、统计信息等的 API。 |
| 作业 | 创建、编辑、下载 dast.config 作业、执行操作、更新扫描配置、配置访问控制测试等的 API。Note: 要使用 POST /jobs API 创建作业, dast.config zip 文件必须包含 .scant 模板文件。 |
| 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。 |
| 活动日志 | 用于获取指定时间范围内活动列表的 API。 |
| 易受攻击的组件 | 用于管理和检索有关易受攻击的组件版本信息的 API。 |
| license | 用于获取许可证授权列表及其到期日期的 API。 |
| 历史数据 | 用于获取应用程序历史数据的 API,包括元数据和导入的问题。 |
| 当前用户 | 用于获取当前登录用户基本信息的 API。 |
| reports | 用于获取各种报告的问题详细信息的 API。 |
| version | 用于获取产品版本和 DAST 客户端详细信息的 API。 |