GitHub REST API Client v0.3.3

View Source GitHub.RateLimit (GitHub REST API Client v0.3.3)

Provides API endpoint related to rate limit

Link to this section Summary

Types

t()

Functions

get(opts \\ [])

Get rate limit status for the authenticated user

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GitHub.RateLimit{
  __info__: map(),
  limit: integer(),
  remaining: integer(),
  reset: integer(),
  used: integer()
}

Link to this section Functions

Link to this function

get(opts \\ [])

View Source 
@spec get(keyword()) ::
  {:ok, GitHub.RateLimit.Overview.t()} | {:error, GitHub.Error.t()}

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 deprecated. 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.

resources

 Resources