Rate Limit

Download Spec

Check your current rate limit status

Get rate limit status for the authenticated user

get /rate_limit

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

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.

Response

Examples Schema

Response

{
  "resources": {
    "core": {
      "limit": 5000,
      "remaining": 4999,
      "reset": 1372700873,
      "used": 1
    },
    "search": {
      "limit": 30,
      "remaining": 18,
      "reset": 1372697452,
      "used": 12
    },
    "graphql": {
      "limit": 5000,
      "remaining": 4993,
      "reset": 1372700389,
      "used": 7
    },
    "integration_manifest": {
      "limit": 5000,
      "remaining": 4999,
      "reset": 1551806725,
      "used": 1
    },
    "code_scanning_upload": {
      "limit": 500,
      "remaining": 499,
      "reset": 1551806725,
      "used": 1
    }
  },
  "rate": {
    "limit": 5000,
    "remaining": 4999,
    "reset": 1372700873,
    "used": 1
  }
}

Not modified

Empty response

Resource not found

{
  "message": "string",
  "documentation_url": "string",
  "url": "string",
  "status": "string"
}

resources

object (resources)

required

core

object (core)

required

limit

int

required

remaining

int

required

reset

int

required

used

int

required

graphql

object (graphql)

limit

int

required

remaining

int

required

reset

int

required

used

int

required

search

object (search)

required

limit

int

required

remaining

int

required

reset

int

required

used

int

required

source_import

object (source_import)

limit

int

required

remaining

int

required

reset

int

required

used

int

required

integration_manifest

object (integration_manifest)

limit

int

required

remaining

int

required

reset

int

required

used

int

required

code_scanning_upload

object (code_scanning_upload)

limit

int

required

remaining

int

required

reset

int

required

used

int

required

actions_runner_registration

object (actions_runner_registration)

limit

int

required

remaining

int

required

reset

int

required

used

int

required

scim

object (scim)

limit

int

required

remaining

int

required

reset

int

required

used

int

required

rate

object (rate)

required

limit

int

required

remaining

int

required

reset

int

required

used

int

required

X-RateLimit-Limit

int

X-RateLimit-Remaining

int

X-RateLimit-Reset

int

timestamp

No schema

message

string

documentation_url

string

url

string

status

string

Was this page helpful?