REST API endpoints for rate limits

Enterprise Cloud

Enterprise Server 3.14

Enterprise Server 3.15

Enterprise Server 3.16

Enterprise Server 3.17

Enterprise Server 3.18

Enterprise Server 3.19

Free, Pro, & Team

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Enter a search term to find it in the GitHub Docs.

Who can use this feature?

Actions

Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

There was an error loading Copilot.

You can still use this field to search our docs.

There was an error loading search results.

REST API endpoints for rate limits - GitHub Enterprise Server 3.19 Docs

Use the REST API to check your current rate limit status.

Quickstart

About the REST API

Comparing GitHub's APIs

API Versions

Breaking changes

OpenAPI description

Getting started

Rate limits

Pagination

Libraries

Best practices

Troubleshooting

Timezones

CORS and JSONP

Issue event types

GitHub event types

Using the REST API

Authenticating

Keeping API credentials secure

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Endpoints for fine-grained PATs

Permissions for GitHub Apps

Permissions for fine-grained PATs

Authentication

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Building a CI server

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Variables

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

Organization

Announcement banners

GitHub Apps

Installations

OAuth authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check runs

Check suites

Checks

Alert dismissal requests

Code scanning

Configurations

Code security settings

Codes of conduct

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Revocation

Credentials

Alerts

Repository access

Dependabot

Dependency review

Dependency submission

Software bill of materials (SBOM)

Dependency graph

Deploy keys

Deployment branch policies

Deployments

Environments

Protection rules

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Bypass requests

Security features for code

Custom properties

Global webhooks

LDAP

Licensing

Manage GHES

Organization pre-receive hooks

GitHub App installations

Organizations

Pre-receive environments

Pre-receive hooks

Repository pre-receive hooks

Rules

SCIM

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Assignees

Issues

Issue dependencies

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

OAuth app authorizations

Custom roles

Members

Organization roles

Outside collaborators

Personal access tokens

Rule suites

Security managers

Packages

Pages

Organization configurations

Private registries

Project fields

Project items

Projects

Columns

Projects (classic)

Pull requests

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release assets

Autolinks

Forks

Git LFS

Repositories

Search

Push protection bypass

Push protection

Secret scanning

Global security advisories

Security advisories

Teams

Discussion comments

Discussions

External groups

Emails

Followers

GPG keys

Git SSH keys

Social accounts

SSH signing keys

Rate Limit

Rate Limit Overview

<div class="ghd-alert ghd-alert-accent" data-container="alert"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p>
<p>
Accessing this endpoint does not count against your REST API rate limit.</p>
</div>
<p>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 <code>resources</code>, you'll see objects relating to different categories:</p>
<ul>
<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>
<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "<a href="https://docs.github.com/enterprise-server@3.19/rest/search/search">Search</a>."</li>
<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see "<a href="https://docs.github.com/enterprise-server@3.19/rest/search/search#search-code">Search code</a>."</li>
<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see "<a href="https://docs.github.com/enterprise-server@3.19/graphql/overview/resource-limitations#rate-limit">Resource limitations</a>."</li>
<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see "<a href="https://docs.github.com/enterprise-server@3.19/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration">Creating a GitHub App from a manifest</a>."</li>
<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "<a href="https://docs.github.com/enterprise-server@3.19/rest/dependency-graph">Dependency graph</a>."</li>
<li>The <code>dependency_sbom</code> object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "<a href="https://docs.github.com/enterprise-server@3.19/rest/dependency-graph">Dependency graph</a>."</li>
<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "<a href="https://docs.github.com/enterprise-server@3.19/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github">Uploading a SARIF file to GitHub</a>."</li>
<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "<a href="https://docs.github.com/enterprise-server@3.19/rest/actions/self-hosted-runners">Self-hosted runners</a>."</li>
<li>The <code>source_import</code> 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 "<a href="https://docs.github.com/enterprise-server@3.19/rest/about-the-rest-api/api-versions">API Versions</a>."</li>
</ul>
<div class="ghd-alert ghd-alert-accent" data-container="alert"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note</p>
<p>
The <code>rate</code> object is closing down. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>
</div>

Get rate limit status for the authenticated user