REST API概述

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

你可以使用API执行以下操作:

  • API键：与帐户中的密钥进行交互。
  • 查询API：通过API接口执行LEQL查询，以与UI中的相同方式。
  • 保存查询：在您的帐户中与已保存的查询进行交互。
  • 标签:与您帐户中的标签进行交互。
  • 标签:与您帐户中的标签和提醒进行交互。
  • 日志：与帐户中的日志交互。
  • 日志集：与帐户中的日志交互。
  • 下载日志:根据给定的日志id和查询参数，通过HTTPS下载日志事件并将其流到您的机器上。
  • 用法:访问您的insightOps帐户的数据使用信息。

要求

在使用API之前，您必须:

  1. 获得一个API密匙．
  2. 检查支持的地区．

获取API密钥

您的API基础路径和API密钥根据您的客户类型而不同。

迁移的客户

从Logentries迁移的客户有2个可访问API访问选项。您选择的选项确定API BasePath和访问级别。

使用insight tops钥匙。

  • API基础路径——https://.rest.logs.insight.rapid7.com/
  • API密匙- 要获取API键，请按照步骤进行操作生成一个insighttops API密钥．
  • 访问权限- 读/写，只读

使用平台密钥。

  • API基础路径——https://.api.insight.rapid7.com/log_search
  • API密匙—获取API密钥，请参见管理平台API密钥。
  • 访问权限- 组织或用户密钥。用户键授予读/写或只读

Non-migrated客户

没有从logentry迁移的客户使用insights密钥。

  • API基础路径——https://.rest.logs.insight.rapid7.com
  • API密匙- 要获取API键，请按照步骤进行操作生成一个insighttops API密钥．
  • 访问权限- 读/写，只读

新客户

新客户使用Platform密钥。

  • API基础路径——https://.rest.logs.insight.rapid7.com
  • API密匙—获取API密钥，请参见管理平台API密钥。
  • 访问权限- 组织或用户密钥。用户键授予读/写或只读

审查受支持区域

Rapid7支持API的以下区域：

  • 我们：美国 - 1
  • US2：美国 - 2
  • US3：美国 - 3
  • 欧盟:欧洲
  • ca:加拿大
  • 非盟:澳大利亚
  • 美联社： 日本

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

速率限制

您可以指示API的速率限制，该速率限制可以在指定的时间内设置频率对API的频率。请求在API端点上的每个API键后在15分钟内进行速率限制。

API响应头返回关于速率限制信息的以下信息:

  • 剩余费率限制:这一期间剩余的请求总数。
  • X-Rate-Limit-Limit:在此期间允许的请求总数。
  • X速率限制 - 重置：剩余请求次数的秒数将被重置为限制。

如果超过了速率限制，API将返回一个HTTP 429错误代码(Too Many Requests)，其中设置了Retry-After头，指示在再次尝试之前必须等待多长时间(以秒为单位)。

生成一个insighttops API密钥

要获取Insightops API密钥：

  1. 登录InsightOps。
  2. 选择设置从左菜单中的页面。
  3. 选择API密钥选项卡。
  4. 选择您需要的键，然后单击复制按钮。
    • 只读键:查询日志事件或检索资源列表。
    • 读写键:增加资源或配置Insight Agent跟踪日志。必威体育app登录

API键设置