设置和部署InsightAppSec API
使用API
一旦有了API密钥，就可以开始使用API从InsightAppSec发送、发布、获取和删除数据。
首先，决定要使用哪个工具来与API交互，比如Postman。你可在此了解邮差:https://www.getpostman.com/
开始使用InsightAppSec API现在。
使用API进行基本操作
以下部分包含使用API可以执行的基本InsightAppSec操作的示例。Rapid7 Insight API端点的URL遵循以下结构:{{基url}} / {{api}} / {{version}} /{{端点}}
的基url这取决于你的地区。你可以参考支持地区文章，获取基于您的位置的特定基URL。对于我们的示例，我们将假设您的帐户位于美国地区，并且您使用的是API的版本1。端点的URL将是:https://us.api.insight.rapid7.com/ias/v1/{{端点}}．
Rapid7 dota2必威联赛Insight平台api使用X-Api-Key用于身份验证和授权的报头。在使用Postman执行任何API调用之前，确保添加了一个头文件X-Api-Key以价值为贵洞察力API密匙．Postman默认将报头值视为字符串，因此不需要在API键周围添加引号。
这些示例包含执行API操作所需的所有信息，如URL、操作和POST主体。占位符文本将被花括号包围(例如:{{此处提供域名}})以便您可以定制您的API请求。在“邮差”中适当的部分插入信息，然后单击发送．
每个示例中的“预期响应”部分将解释操作成功时应该期望的响应状态和响应内容。有些进程是相互连接的，因此其中一个进程的响应将成为另一个进程的请求参数。
添加一个目标
先决条件
- 您想要扫描的web应用程序的域名URL或IP地址。
操作
帖子URLhttps://us.api.insight.rapid7.com/ias/v1/targets头
1
X-Api-Key: {{Insight API Key}}
2
内容类型:application / json
身体
1
｛
2
"domain": "{{您的域名URL或IP地址}}"，
3.
“启用”:真的
4
｝
预期响应状态201年创建头地址:https://us.api.insight.rapid7.com:443/ias/v1/targets/{{Target ID}}
创建一个应用程序
操作帖子URLhttps://us.api.insight.rapid7.com/ias/v1/apps/头
1
X-Api-Key: {{Insight API Key}}
2
内容类型:application / json
身体
1
｛
2
“名称”:“API-test-app”,
3.
"description": "Creating a app to test the API"
4
｝
这篇文章介绍了如何将Bamboo CI/CD软件与InsightAppSec集成。状态201年创建头地址:https://us.api.insight.rapid7.com:443/ias/v1/apps/{{App ID}}
创建扫描配置
先决条件
- 应用程序ID创建一个应用程序
- 您希望用于扫描配置的攻击模板的唯一ID。可以通过运行命令获取所有攻击模板的id
得到https://us.api.insight.rapid7.com/ias/v1/attack-templates/．
操作帖子URLhttps://us.api.insight.rapid7.com/ias/v1/scan-configs/头
1
X-Api-Key: {{Insight API Key}}
2
内容类型:application / json
身体
1
｛
2
“名称”:“api-test-scan-config”,
3.
"description": "Webscantest scan using the API"，
4
"应用程序":{
5
"id": "{{App id}}"
6
}，
7
" attack_template ": {
8
"id": "{{攻击模板id}}"
9
｝
10
｝
预期响应状态201年创建头位置:https://us.api.insight.rapid7.com:443/ias/v1/scan-configs/{{Scan Config ID}}
向扫描配置添加域
先决条件
操作把URLhttps://us.api.insight.rapid7.com/ias/v1/scan-configs/{{扫描配置ID}} /选项头
1
X-Api-Key: {{Insight API Key}}
2
内容类型:application / json
身体
1
｛
2
" crawl_config ": {
3.
“seed_url_list”:(
4
｛
5
"value": "{{您的域名URL或IP地址}}"
6
｝
7
]，
8
“max_crawl_results”:101年,
9
“scope_constraint_list”:(
10
｛
11
"URL": "{{您的域名URL或IP地址}}/*"，
12
“法”:“所有”,
13
“排斥”:“包括”,
14
“match_criteria”:“通配符”,
15
“http_parameter_list”:[]
16
｝
17
］
18
}，
19
" attacker_config ": {
20.
“scope_constraint_list”:(
21
｛
22
"URL": "{{您的域名URL或IP地址}}/*"，
23
“法”:“所有”,
24
“排斥”:“包括”,
25
“match_criteria”:“通配符”,
26
“http_parameter_list”:[]
27
｝
28
］
29
｝
30.
｝
预期响应状态200好了