Points de terminaison d’API REST pour les limites 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 « Limites de débit pour 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 « Points de terminaison d’API REST pour la recherche ». 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 « Limites de débit et limites de Node pour l’API GraphQL ». 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 « Points de terminaison d’API REST pour la recherche ».
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 « Points de terminaison d’API REST pour la recherche ».
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 dependency_snapshots fournit le statut de votre limitation de débit pour envoyer des instantanés au graphe des éléments dépendants. Pour plus d’informations, consultez « Points de terminaison d’API REST pour le graphe des dépendances ».
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 ».
L’objet actions_runner_registration fournit l’état de votre limite de débit pour l’inscription d’exécuteurs auto-hébergés dans GitHub Actions. Pour plus d’informations, consultez « Points de terminaison d’API REST pour les exécuteurs auto-hébergés ».

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

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 closing down. 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.

Jetons d’accès affinés pour « Get rate limit status for the authenticated user »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis ne nécessite aucune autorisation.

Ce point de terminaison peut être utilisé sans authentification ou si seules les ressources publiques sont demandées.

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 »

Exemple de requête

get/rate_limit

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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
  }
}