Okapi Okapi

GitHub REST API Calls without the X-GitHub-Api-Version header are redirected to a newer version version retirement

Redirectsin 490 daysSubscribe to GitHub REST APIShare

On March 10, 2028, GitHub REST API version 2022-11-28 reaches its end of support. Requests with no x-github-api-version header previously defaulted to this version. Starting on that date, requests that omit the header are redirected to the next oldest supported version rather than the retiring one.


Calls it hits

  • no x-github-api-version header

What to use instead of these calls

Send X-GitHub-Api-Version: 2026-03-10 and make the updates required by its breaking changes list. Past that date, calls omitting the header are answered from the next oldest supported version.

In GitHub REST API's words

Requests without the X-GitHub-Api-Version header will default to use the 2022-11-28 version. Requests that do not specify an API version default to the next oldest supported version, not the closing down version. API version: 2022-11-28; End of support date: March 10, 2028.

GitHub REST API, Lifecycle page

Facts

API
GitHub REST API api.github.com
Kind
Version retirement
Takes effect
March 10, 2028
Calls after that day
Answered by a newer version
Source
Lifecycle page
Last updated
Verified
, against GitHub REST API's own pages

Questions

When does this change take effect?

From March 10, 2028, GitHub REST API answers calls to no x-github-api-version header from a newer version.

What happens to calls after March 10, 2028?

GitHub REST API answers them from a newer version. The response can differ from what your code expects.

How do I find the calls this hits in my code?

Okapi reads your repository, finds the calls this change hits and opens a pull request with the fix. It never commits to your branches: every change comes as a pull request you review.


More from GitHub REST API 10

  1. PATCH /orgs/{id}Parameter removal Stopped working
  2. PATCH /orgs/{id}Parameter removal Stopped working
  3. PATCH /orgs/{id}Parameter removal Stopped working
  4. PATCH /orgs/{id}Parameter removal Stopped working
  5. PATCH /orgs/{id}Parameter removal Stopped working
  6. PATCH /orgs/{id}Parameter removal Stopped working
  7. GET /assignments/*Endpoint removal Stopped working
  8. GET /classrooms*Endpoint removal Stopped working
  9. GET /repos/{id}/{id}/dependency-graph/sbomEndpoint removal Stops workingin 7 days
  10. header x-github-api-version: 2022-11-28Version retirement Stops workingin 490 days

Is your code calling this?

Okapi finds the calls this change hits in your repo and opens the pull request with the fix before March 10, 2028.

Add to GitHub

Get notifications

Subscribe to GitHub REST API

Hear about each breaking change GitHub REST API announces, in your feed reader, calendar or Slack.

1What to follow

Provider
  • GitHub REST API

2Where to get it

/breaking-changes/feed.xml

Paste it into Feedly, Inoreader, NetNewsWire or any reader. New changes show up as they're announced.