From time to time, repository names change. If you make a GitHub API request using a repository's old name in the URL, the API has historically responded with
404 Not Found. To help API clients gracefully handle renamed repositories, the API will soon begin redirecting to the repository's new location.
You can preview these redirects now. In the coming weeks, we'll announce the timeline for enabling these redirects for everyone.
How can I try out the redirects?
Starting today, developers can preview the redirect functionality for relocated repositories. To access this redirect functionality during the preview period, you’ll need to provide the following custom media type in the
During the preview period, we may change aspects of the redirect behavior based on developer feedback. If we do, we will announce the changes here on the developer blog, but we will not provide any advance notice.
When will the redirects occur?
To understand when these redirects would take place, you'll want to understand how to identify a repository's location. Repositories are located using the combination of the owner's name and the repository's name. For example, the @twbs organization owns the popular bootstrap repository. We identify this repository as twbs/bootstrap.
The repository's location changes in the following scenarios:
- When the owner changes the repository name.
- When the owner renames their user account or organization account.
- When the owner transfers the repository to a new owner.
Continuing our twbs/bootstrap example, this repository used to be owned by the @twitter organization, and it was therefore located at twitter/bootstrap. With repository redirects, you'll be able to make an API request using the repository's old location and receive either a
307 HTTP redirect, depending on the type of request being made. You can then follow the redirect to the new location.
Send us your feedback
We hope you'll take these redirects for a spin and let us know what you think. Happy redirecting!