跳至主要内容
REST API 现在已版本化。 有关更多信息,请参阅“关于 API 版本控制”。

REST API 速率限制端点

使用 REST API 检查您当前的速率限制状态。

关于速率限制

您可以随时检查您当前的速率限制状态。有关速率限制规则的更多信息,请参阅“REST API 的速率限制”。

用于搜索项目的 REST API 具有自定义速率限制,它与管理其他 REST API 端点的速率限制分开。有关更多信息,请参阅“REST API 搜索端点”。GraphQL API 也具有自定义速率限制,它与 REST API 中的速率限制分开并以不同的方式计算。有关更多信息,请参阅“GraphQL API 的速率限制和节点限制”。由于这些原因,API 响应会对您的速率限制进行分类。在 resources 下,您将看到与不同类别相关的对象。

  • core 对象提供您在 REST API 中所有非搜索相关资源的速率限制状态。

  • search 对象提供您在 REST API 中搜索(不包括代码搜索)的速率限制状态。有关更多信息,请参阅“REST API 搜索端点”。

  • code_search 对象提供您在 REST API 中搜索代码的速率限制状态。有关更多信息,请参阅“REST API 搜索端点”。

  • graphql 对象提供您在 GraphQL API 中的速率限制状态。

  • integration_manifest 对象提供您在 POST /app-manifests/{code}/conversions 操作中的速率限制状态。有关更多信息,请参阅“从清单注册 GitHub 应用程序”。

  • dependency_snapshots 对象提供您向依赖关系图提交快照的速率限制状态。有关更多信息,请参阅“REST API 依赖关系图端点”。

  • code_scanning_upload 对象提供您将 SARIF 结果上传到代码扫描的速率限制状态。有关更多信息,请参阅“将 SARIF 文件上传到 GitHub”。

  • actions_runner_registration 对象提供您在 GitHub Actions 中注册自托管运行器的速率限制状态。有关更多信息,请参阅“REST API 自托管运行器端点”。

有关速率限制响应中的标头和值的更多信息,请参阅“REST API 的速率限制”。

获取已认证用户的速率限制状态

注意

访问此端点不会计入您的 REST API 速率限制。

某些类别的端点具有自定义速率限制,这些限制与管理其他 REST API 端点的速率限制分开。因此,API 响应会对您的速率限制进行分类。在 resources 下,您将看到与不同类别相关的对象。

  • core 对象提供您在 REST API 中所有非搜索相关资源的速率限制状态。
  • search 对象提供您在 REST API 中搜索(不包括代码搜索)的速率限制状态。有关更多信息,请参阅“搜索”。
  • code_search 对象提供您在 REST API 中搜索代码的速率限制状态。有关更多信息,请参阅“搜索代码”。
  • graphql 对象提供您在 GraphQL API 中的速率限制状态。有关更多信息,请参阅“资源限制”。
  • integration_manifest 对象提供您在 POST /app-manifests/{code}/conversions 操作中的速率限制状态。有关更多信息,请参阅“从清单创建 GitHub 应用程序”。
  • dependency_snapshots 对象提供您向依赖关系图提交快照的速率限制状态。有关更多信息,请参阅“依赖关系图”。
  • code_scanning_upload 对象提供您将 SARIF 结果上传到代码扫描的速率限制状态。有关更多信息,请参阅“将 SARIF 文件上传到 GitHub”。
  • actions_runner_registration 对象提供您在 GitHub Actions 中注册自托管运行器的速率限制状态。有关更多信息,请参阅“自托管运行器”。
  • source_import 对象不再用于任何 API 端点,并且将在下一个 API 版本中删除。有关 API 版本的更多信息,请参阅“API 版本”。

注意

rate 对象即将关闭。如果您正在编写新的 API 客户端代码或更新现有代码,则应使用 core 对象而不是 rate 对象。core 对象包含与 rate 对象中相同的信息。

“获取已认证用户的速率限制状态”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌不需要任何权限。

如果仅请求公共资源,则可以在没有身份验证的情况下使用此端点。

“获取已认证用户的速率限制状态”的 HTTP 响应状态代码

状态代码描述
200

OK

304

未修改

404

资源未找到

“获取已认证用户的速率限制状态”的代码示例

请求示例

get/rate_limit
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/rate_limit

响应

状态:200
{ "resources": { "core": { "limit": 5000, "used": 1, "remaining": 4999, "reset": 1691591363 }, "search": { "limit": 30, "used": 12, "remaining": 18, "reset": 1691591091 }, "graphql": { "limit": 5000, "used": 7, "remaining": 4993, "reset": 1691593228 }, "integration_manifest": { "limit": 5000, "used": 1, "remaining": 4999, "reset": 1691594631 }, "source_import": { "limit": 100, "used": 1, "remaining": 99, "reset": 1691591091 }, "code_scanning_upload": { "limit": 500, "used": 1, "remaining": 499, "reset": 1691594631 }, "actions_runner_registration": { "limit": 10000, "used": 0, "remaining": 10000, "reset": 1691594631 }, "scim": { "limit": 15000, "used": 0, "remaining": 15000, "reset": 1691594631 }, "dependency_snapshots": { "limit": 100, "used": 0, "remaining": 100, "reset": 1691591091 }, "code_search": { "limit": 10, "used": 0, "remaining": 10, "reset": 1691591091 } }, "rate": { "limit": 5000, "used": 1, "remaining": 4999, "reset": 1372700873 } }