REST API的概述

我们的REST API允许您通过HTTP请求使用Insigrops。目前，REST API允许您执行UI可用的大多数动作，并且具有通过UI不可用的一些额外功能。您可以使用此API来自动执行常见任务（例如，通过shell脚本），并且通常以编程方式与Insigrops进行交互。

您可以使用API​​执行以下操作：

  • API密钥:与您的帐户中的密钥进行交互。
  • 查询API.:通过API接口以与UI相同的方式执行LEQL查询。
  • 保存的查询:与您帐户中保存的查询进行交互。
  • 标签：与您帐户中的标签交互。
  • 标签：与您帐户中标签和警报的标签交互。
  • 日志:与您帐户中的日志进行交互。
  • 日志设置:与您帐户中的日志进行交互。
  • 下载日志：将记录事件下载并将日志事件用于HTTPS上的给定日志ID和查询参数。
  • 使用：访问有关Insightops帐户的数据使用情况的信息。

需求

在使用API​​之前，您必须：

  1. 获得A.API键。
  2. 点评审查支持地区。

获取API密钥

您的API BasePath和API键根据您的客户类型而异。

迁移客户

从logentry迁移过来的客户有2个获取API访问的选项。您选择的选项决定了API基础路径和访问级别。

使用Insightops键。

  • API的基本路径- https：//.rest.logs.Insight.Rapid7.com/
  • API键—获取API密钥，请参考生成Insightops API密钥。
  • 访问级别—读写，只读

使用平台键。

  • API的基本路径- https：//.api.insight.rapid7.com/log_Search
  • API键- 要获取API键，请按照管理平台API键的步骤操作。
  • 访问级别—组织或用户密钥。用户密钥授予“读/写”或“只读”权限

非迁移的客户

没有从Logentries迁移的客户使用Insigrops键。

  • API的基本路径- https：//.rest.logs.Insight.Rapid7.com
  • API键—获取API密钥，请参考生成Insightops API密钥。
  • 访问级别—读写，只读

新客户

新客户使用平台键。

  • API的基本路径- https：//.rest.logs.Insight.Rapid7.com
  • API键- 要获取API键，请按照管理平台API键的步骤操作。
  • 访问级别—组织或用户密钥。用户密钥授予“读/写”或“只读”权限

查看支持的地区

Rapid7支持以下API区域:

  • 我们:美国- 1
  • 2美国- 2
  • 卖价美国- 3
  • 欧洲联盟： 欧洲
  • 加利福尼亚州： 加拿大
  • Au.： 澳大利亚
  • AP:日本

在您的API基础路径中，根据所在位置更新您的区域。例如，如果您在日本，您的基础路径将是https://ap.rest.logs.Insight.Rapid7.com。

速度限制

您可以指定API的速率限制，该限制设置在指定时间内向API发出请求的频率。对于API端点上的每个API密钥，请求在15分钟的时间内受到速率限制。

API响应标题返回以下信息有关速率限制信息：

  • X-Rate-Limit-剩余：此期间剩余的请求总数。
  • X率限制限制：此期间内允许的请求总数。
  • X-Rate-Limit-Reset:在剩余的请求数将被重置到限制之前的秒数。

如果超过速率限制，API将返回HTTP 429错误代码（太多请求）使用重试标头集表示，指示在再次尝试之前必须等待多长时间（以秒为单位）。

生成Insightops API密钥

获取InsightOps API密钥:

  1. 登录Insightops。
  2. 选择设置页从左边的菜单。
  3. 选择API键标签。
  4. 选择你需要的键，然后点击复制按钮。
    • 只读键：查询日志事件或检索资源列表。
    • 读/写键：添加资源或配置Insigh Agent以遵循日志。必威体育app登录

API密钥设置