Limite du taux

Utilisez l’API REST pour vérifier l’état actuel de votre limite de débit.

À propos des limites de débit

Vous pouvez vérifier l’état actuel de votre limite de débit à tout moment. Pour plus d’informations sur les règles de limite de débit, consultez « Ressources disponibles dans l’API REST ».

L’API REST pour la recherche d’éléments a une limite de débit personnalisée qui est distincte de la limite de débit qui régit les autres points de terminaison d’API REST. Pour plus d’informations, consultez « Rechercher ». L’API GraphQL a également une limite de débit personnalisée distincte et calculée différemment des limites de débit dans l’API REST. Pour plus d’informations, consultez « Limitations des ressources ». Pour ces raisons, la réponse de l’API catégorise votre limite de débit. Sous resources, vous voyez des objets relatifs à différentes catégories :

L’objet core fournit l’état de votre limite de débit pour toutes les ressources non liées à la recherche dans l’API REST.
L’objet search fournit l’état de votre limite de débit pour l’API REST pour la recherche (recherches de code exclues). Pour plus d’informations, consultez « Rechercher ».
L’objet code_search fournit l’état de votre limite de débit pour l’API REST pour la recherche de code. Pour plus d’informations, consultez « Rechercher ».
L’objet graphql fournit l’état de votre limite de débit pour l’API GraphQL.
L’objet integration_manifest fournit l’état de votre limite de débit pour l’opération POST /app-manifests/{code}/conversions. Pour plus d’informations, consultez « Inscription d’une application GitHub à partir d’un manifeste ».

L’objet code_scanning_upload fournit votre état de limite de débit pour le chargement des résultats SARIF dans l’analyse du code. Pour plus d’informations, consultez « Chargement d’un fichier SARIF sur GitHub ».

Pour plus d’informations sur les en-têtes et les valeurs dans la réponse de limite de débit, consultez « Ressources disponibles dans l’API REST ».

Get rate limit status for the authenticated user

Compatible avec 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.

Codes d’état de la réponse HTTP pour « Get rate limit status for the authenticated user »

Code d’état	Description
`200`	OK
`304`	Not modified
`404`	Resource not found

Exemples de code pour « 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
  }
}