REST-API-Endpunkte für die Ratenbegrenzung

Informationen zu Quotengrenzen

Du kannst deinen aktuellen Status der Quotengrenze jederzeit überprüfen. Weitere Informationen zu Quotengrenzregeln findest du unter Ratenbegrenzungen für die REST-API.

Die REST-API für die Suche nach Elementen verfügt über eine benutzerdefinierte Quotengrenze, die von der Quotengrenze für die anderen REST-API-Endpunkte getrennt ist. Weitere Informationen findest du unter REST-API-Endpunkte für die Suche. Die GraphQL-API verfügt auch über eine benutzerdefinierte Quotengrenze, die von der Rest-API getrennt und anders berechnet wird als die REST-API. Weitere Informationen findest du unter Ratenbegrenzungen und Knotengrenzwerte für die GraphQL-API. Aus diesen Gründen kategorisiert die Antwort der API deine Quotengrenzen. Unter resources werden Objekte verschiedener Kategorien angezeigt:

Das core-Objekt stellt deinen Status für die Quotengrenze für alle nicht auf die Suche bezogenen Ressourcen in der REST-API bereit.
Das search-Objekt stellt deinen Status der Quotengrenze für die REST-API für die Suche (mit Ausnahme der Codesuche) bereit. Weitere Informationen findest du unter REST-API-Endpunkte für die Suche.
Das code_search-Objekt stellt deinen Status der Quotengrenze für die REST-API für die Codesuche bereit. Weitere Informationen findest du unter REST-API-Endpunkte für die Suche.
Das graphql-Objekt stellt deinen Status der Quotengrenze für die GraphQL-API bereit.
Das integration_manifest-Objekt stellt deinen Status der Quotengrenze für den Vorgang POST /app-manifests/{code}/conversions bereit. Weitere Informationen findest du unter Registrieren einer GitHub-App über ein Manifest.
Das dependency_snapshots-Objekt übergibt den Status Ihrer Ratenbegrenzung zum Übermitteln von Momentaufnahmen an das Abhängigkeitsdiagramm. Weitere Informationen findest du unter REST-API-Endpunkte für das Abhängigkeitsdiagramm.
Das code_scanning_upload-Objekt stellt deinen Status der Quotengrenze zum Hochladen von SARIF-Ergebnissen in die Codeüberprüfung bereit. Weitere Informationen findest du unter Hochladen einer SARIF-Datei in GitHub.
Das actions_runner_registration-Objekt stellt den Status der Ratenbegrenzung für das Registrieren selbstgehosteter Runner in GitHub Actions bereit. Weitere Informationen findest du unter REST-API-Endpunkte für selbst gehostete Runner.

Weitere Informationen zu den Headern und Werten in der Antwort auf die Quotengrenze findest du unter Ratenbegrenzungen für die 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 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.

Differenzierte Zugriffstoken für "Get rate limit status for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung werden, wenn nur öffentliche Ressourcen angefordert werden.

HTTP-Antwortstatuscodes für „Get rate limit status for the authenticated user“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`404`	Resource not found

Codebeispiele für „Get rate limit status for the authenticated user“

Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.

Anforderungsbeispiel

get/rate_limit

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