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

Используйте REST API для проверка текущего состояния ограничения скорости.

Сведения об ограничениях скорости

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

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

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

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

Get rate limit status for the authenticated user

Работа с GitHub Apps

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

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,
      "remaining": 4999,
      "reset": 1372700873,
      "used": 1
    },
    "search": {
      "limit": 30,
      "remaining": 18,
      "reset": 1372697452,
      "used": 12
    },
    "graphql": {
      "limit": 5000,
      "remaining": 4993,
      "reset": 1372700389,
      "used": 7
    },
    "integration_manifest": {
      "limit": 5000,
      "remaining": 4999,
      "reset": 1551806725,
      "used": 1
    },
    "code_scanning_upload": {
      "limit": 500,
      "remaining": 499,
      "reset": 1551806725,
      "used": 1
    }
  },
  "rate": {
    "limit": 5000,
    "remaining": 4999,
    "reset": 1372700873,
    "used": 1
  }
}