GitHub Enterprise Rate Limit API

openapi: 3.2.0
info:
  title: Github Enterprise Rate Limit API
  version: 1.1.4
  contact:
    name: Support
    url: https://support.github.com/contact?tags=dotcom-rest-api
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://docs.github.com/articles/github-terms-of-service
  x-github-plan: ghec
  description: 'Operations tagged rate-limit across 2 of this provider''s published API definitions: github-enterprise-ghec-openapi.json, github-enterprise-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.github.com
tags:
- name: rate-limit
  description: Check your current rate limit status.
paths:
  /rate_limit:
    get:
      summary: Get rate limit status for the authenticated user
      description: '> [!NOTE]

        > Accessing this endpoint does not count against your REST API rate limit.


        Rate limit status reflects the applicable limits for the requester and resource category, not the hostname used for the request. Requests authenticated as a user share the user''s rate limit across credentials. Requests without authentication use the requesting IP address. API requests routed through either an API hostname or a web hostname can count against the same applicable 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 `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "Dependency graph."

        * 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.'
      tags:
      - rate-limit
      operationId: rate-limit/get
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-cloud@latest/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user
      parameters: []
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rate-limit-overview'
              examples:
                default:
                  $ref: '#/components/examples/rate-limit-overview'
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/x-rate-limit-limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/x-rate-limit-remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/x-rate-limit-reset'
        '304':
          $ref: '#/components/responses/not_modified'
        '404':
          $ref: '#/components/responses/not_found'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: rate-limit
        subcategory: rate-limit
    servers:
    - url: https://api.github.com
components:
  schemas:
    rate-limit:
      title: Rate Limit
      type: object
      properties:
        limit:
          type: integer
        remaining:
          type: integer
        reset:
          type: integer
        used:
          type: integer
      required:
      - limit
      - remaining
      - reset
      - used
    basic-error:
      title: Basic Error
      description: Basic Error
      type: object
      properties:
        message:
          type: string
        documentation_url:
          type: string
        url:
          type: string
        status:
          type: string
    rate-limit-overview:
      title: Rate Limit Overview
      description: 'Rate limit status for the applicable requester and resource category. Requests

        authenticated as a user share the user''s rate limit across credentials. Requests

        without authentication use the requesting IP address. API requests routed through

        either an API hostname or a web hostname can count against the same applicable limit.'
      type: object
      properties:
        resources:
          type: object
          properties:
            core:
              $ref: '#/components/schemas/rate-limit'
            graphql:
              $ref: '#/components/schemas/rate-limit'
            search:
              $ref: '#/components/schemas/rate-limit'
            code_search:
              $ref: '#/components/schemas/rate-limit'
            source_import:
              $ref: '#/components/schemas/rate-limit'
            integration_manifest:
              $ref: '#/components/schemas/rate-limit'
            actions_runner_registration:
              $ref: '#/components/schemas/rate-limit'
            scim:
              $ref: '#/components/schemas/rate-limit'
            dependency_snapshots:
              $ref: '#/components/schemas/rate-limit'
            dependency_sbom:
              $ref: '#/components/schemas/rate-limit'
            code_scanning_autofix:
              $ref: '#/components/schemas/rate-limit'
            copilot_usage_records:
              $ref: '#/components/schemas/rate-limit'
          required:
          - core
          - search
        rate:
          $ref: '#/components/schemas/rate-limit'
      required:
      - rate
      - resources
  headers:
    x-rate-limit-limit:
      example: 5000
      schema:
        type: integer
    x-rate-limit-remaining:
      example: 4999
      schema:
        type: integer
    x-rate-limit-reset:
      example: 1590701888
      schema:
        type: integer
        format: timestamp
  responses:
    not_found:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
    not_modified:
      description: Not modified
  examples:
    rate-limit-overview:
      value:
        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
          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
          code_scanning_autofix:
            limit: 10
            used: 0
            remaining: 10
            reset: 1691591091
        rate:
          limit: 5000
          used: 1
          remaining: 4999
          reset: 1372700873
externalDocs:
  description: GitHub Enterprise Cloud REST API
  url: https://docs.github.com/enterprise-cloud@latest/rest/
x-refined-from:
- github-enterprise-ghec-openapi.json
- github-enterprise-openapi.yml