Конечные точки REST API для ограничений скорости

О ограничениях скорости

Вы можете проверка текущее состояние ограничения скорости в любое время. Дополнительные сведения о правилах ограничения скорости см. в разделе "Ограничения скорости для REST API".

REST API для поиска элементов имеет настраиваемое ограничение скорости, отличное от ограничения скорости, определяющего другие конечные точки REST API. Дополнительные сведения см. в разделе Конечные точки REST API для поиска. Для API GraphQL также действует настраиваемое ограничение скорости, которое рассчитывается отдельно от ограничения скорости для REST API. Дополнительные сведения см. в разделе Ограничения скорости и ограничения узлов для API GraphQL. По этим причинам ответ API классифицирует ограничение скорости. В разделе resourcesвы увидите объекты, относящиеся к разным категориям:

Объект core предоставляет состояние ограничения скорости для всех ресурсов в REST API, не связанных с поиском.
Объект search предоставляет состояние ограничения скорости для REST API для поиска (за исключением поиска кода). Дополнительные сведения см. в разделе Конечные точки REST API для поиска.
Объект code_search предоставляет состояние ограничения скорости для REST API для поиска кода. Дополнительные сведения см. в разделе Конечные точки REST API для поиска.
Объект graphql предоставляет состояние ограничения скорости для API GraphQL.
Объект integration_manifest предоставляет состояние ограничения скорости POST /app-manifests/{code}/conversions для операции. Дополнительные сведения см. в разделе Регистрация приложения GitHub из манифеста.

fpt или ghec или ghes %}* Объект dependency_snapshots предоставляет состояние ограничения скорости для отправки моментальных снимков в граф зависимостей. Дополнительные сведения см. в разделе Конечные точки REST API для граф зависимостей.

Объект code_scanning_upload предоставляет состояние ограничения скорости для отправки результатов SARIF в сканирование кода. Дополнительные сведения см. в разделе Отправка файла SARIF в GitHub.
Объект actions_runner_registration предоставляет состояние ограничения скорости для регистрации локальных модулей выполнения в GitHub Actions. Дополнительные сведения см. в разделе Конечные точки REST API для локальных runners.

Дополнительные сведения о заголовках и значениях в ответе ограничения скорости см. в разделе "Ограничения скорости для REST API".

Get rate limit status for the authenticated user

Note: Accessing this endpoint does not count against your REST API rate limit.

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:

The core object provides your rate limit status for all non-search-related resources in the REST API.
The search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "Search."
The code_search object provides your rate limit status for the REST API for searching code. For more information, see "Search code."
The graphql object provides your rate limit status for the GraphQL API. For more information, see "Resource limitations."
The integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see "Creating a GitHub App from a manifest."
The dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "Dependency graph."
The code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "Uploading a SARIF file to GitHub."
The actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "Self-hosted runners."
The source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "API Versions."

Note: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

Коды состояния http-ответа для "Get rate limit status for the authenticated user"

Код состояния	Описание
`200`	OK
`304`	Not modified
`404`	Resource not found

Примеры кода для "Get rate limit status for the authenticated user"

Пример запроса

get/rate_limit

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/rate_limit

Response

Status: 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
  }
}