设置和部署InsightAppSec API

API设置和部署工作流

使用API​​.

一旦有了API密钥,就可以开始使用API从InsightAppSec发送、发布、获取和删除数据。

首先,决定您想要使用哪个工具来与API交互,比如Postman。欲知更多有关邮差的资料,请浏览:https://www.getpostman.com/

开始使用Insightappsec API.现在。

通过API执行基本操作

以下部分包含您可以使用API​​执行的基本InsightappSec操作示例。Rapid7 Insight API端点的URL遵循结构:{{base url}} / {{api}} / {{version}} / {{endpoint}}

这基础网址取决于您帐户的区域。你可以参考支持地区文章根据您的位置获取特定的基本URL。对于我们的示例,我们将假设您的帐户位于美国地区,并且您正在使用API的版本1。然后端点的URL将是:https://us.api.insight.rapid7.com/ias/v1/ {{endpoint}}。

Rapid7 dota2必威联赛Insight平台API使用X-API-key用于身份验证和授权的标题。在使用邮递员执行任何API调用之前,请确保添加标题X-API-key以价值为贵洞察力API密匙。邮递员默认将标题值视为字符串,因此您无需在API键周围添加引号。

这些示例包含执行API操作所需的所有信息,例如URL、操作和POST主体。占位符文本将被花括号包围(例如:{{提供域名这里}}),所以你可以定制你的API请求。将信息插入“邮差”中适当的部分,然后单击发送。

每个示例中的“预期响应”部分将解释您应该期望成功操作的响应状态和响应内容。一些进程是互连的,因此一个将成为另一个的请求参数。

添加一个目标

先决条件

  • 您要扫描的Web应用程序的域URL或IP地址。

操作

邮政URL.https://us.api.insight.rapid7.com/ias/v1/targets.头

         
1
X-API-key:{{Insight API键}}
2
内容类型:application / json

身体

         
1
{
2
“域”:“{{您的域URL或IP地址}}”,
3.
“启用”:真的
4.
}

预期的反应地位201年创建标题地点:https://us.api.Insight.Rapid7.com:443/ias/v1/targets/ {farget id}}

创建一个应用程序

操作邮政URL.https://us.api.insight.rapid7.com/ias/v1/apps/头

         
1
X-API-key:{{Insight API键}}
2
内容类型:application / json

身体

         
1
{
2
“名称”:“API-Test-app”,
3.
"description": "创建一个应用程序来测试API"
4.
}

摘录:“本文介绍了如何将竹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/。

操作邮政URL.https://us.api.insight.rapid7.com/ias/v1/scan-configs/头

         
1
X-API-key:{{Insight API键}}
2
内容类型:application / json

身体

         
1
{
2
“名称”:“API-Test-Scan-Config”,
3.
“描述”:“使用API​​的WebScantest扫描”,
4.
“应用程序” : {
5.
“ID”:“{{app id}}”
6.
},
7.
“攻击_template”:{
8.
"id": "{{攻击模板id}}"
9.
}
10.
}

预期的反应地位201年创建标题位置:https://us.api.insight.rapid7.com:443/ias/v1/scan-configs/ {scan config id}}

将域添加到扫描配置

先决条件

操作放URL.https://us.api.insight.rapid7.com/ias/v1/scan-configs/ {scan config id}} /选项头

         
1
X-API-key:{{Insight API键}}
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.
“攻击者_config”:{
20.
“scope_constraint_list”:[
21.
{
22.
“URL”:“{{您的域URL或IP地址}} / *”,
23.
“方法”:“全部”,
24.
“排斥”:“包括”,
25.
“match_criTeria”:“通配符”,
26.
“http_parameter_list”:[]
27.
}
28.
]
29.
}
30.
}

预期的反应地位200 OK.