REST API的概述

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

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

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

需求

在使用API之前，您必须:

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

获取API密钥

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

迁移的客户

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

使用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
  • 2美国- 2
  • 卖价美国- 3
  • 欧盟:欧洲
  • ca:加拿大
  • 非盟:澳大利亚
  • 美联社:日本

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

速度限制

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

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

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

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

生成一个insighttops API密钥

获取InsightOps API密钥:

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

API键设置