Puntos de conexión de la API de REST para los límites de velocidad
Usa la API de REST para comprobar el estado actual del límite de frecuencia.
Acerca de los límites de frecuencia
Puedes comprobar el estado actual del límite de frecuencia en cualquier momento. Para más información sobre las reglas de límite de frecuencia, consulta "Límites de volumen de la API de REST".
La API de REST para buscar elementos tiene un límite de frecuencia personalizado que es independiente del límite de frecuencia que rige los demás puntos de conexión de la API de REST. Para obtener más información, vea «Puntos de conexión de la API de REST para búsquedas». GraphQL API también tiene un límite de frecuencia personalizado que es independiente y se calcula de forma diferente a los límites de frecuencia de la API REST. Para obtener más información, vea «Límites de volumen y límites de nodo para GraphQL API». Es por esto que la respuesta de la API categoriza tu límite de frecuencia. En resources
, verás objetos relacionados con diferentes categorías:
-
El objeto
core
proporciona el estado de límite de frecuencia para todos los recursos que no están relacionados con la búsqueda en la API REST. -
El objeto
search
proporciona el estado de límite de frecuencia para la API REST de búsqueda (sin incluir las búsquedas de código). Para obtener más información, vea «Puntos de conexión de la API de REST para búsquedas». -
El objeto
code_search
proporciona el estado de límite de frecuencia para la API REST de búsqueda de código. Para obtener más información, vea «Puntos de conexión de la API de REST para búsquedas». -
El objeto
graphql
proporciona el estado de límite de frecuencia para GraphQL API. -
El objeto
integration_manifest
proporciona el estado de límite de frecuencia para la operaciónPOST /app-manifests/{code}/conversions
. Para obtener más información, vea «Registro de una aplicación de GitHub desde un manifiesto». -
El objeto
dependency_snapshots
proporciona el estado de su límite de frecuencia para enviar instantáneas al gráfico de dependencias. Para obtener más información, vea «Puntos de conexión de la API de REST para el gráfico de dependencias». -
El objeto
code_scanning_upload
proporciona el estado de límite de frecuencia para cargar los resultados de SARIF en el examen de código. Para obtener más información, vea «Subir un archivo SARIF a GitHub». -
El objeto
actions_runner_registration
proporciona el estado de límite de frecuencia para registrar ejecutores autohospedados en GitHub Actions. Para obtener más información, vea «Puntos de conexión de API de REST para ejecutores autohospedados».
Para más información sobre los encabezados y los valores de la respuesta de límite de frecuencia, consulta "Límites de volumen de la API de 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 thePOST /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.
Tokens de acceso específicos para "Get rate limit status for the authenticated user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado no requiere ningún permiso.
Este punto de conexión se puede usar sin autenticación si solo se solicitan recursos públicos.
Códigos de estado de respuesta HTTP para "Get rate limit status for the authenticated user"
status code | Descripción |
---|---|
200 | OK |
304 | Not modified |
404 | Resource not found |
Ejemplos de código para "Get rate limit status for the authenticated user"
Ejemplo de solicitud
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
}
}