GitHub API: Moving On
API v3 has been in place for nearly a year. We’ve seen a large increase in the amount of API consumers and have ambitious future plans for it. However, at…
API v3 has been in place for nearly a year. We’ve seen a large increase in
the amount of API consumers and have ambitious future plans for it. However,
at some point we have to let the old code go. A single codebase will allow
us to provide a more reliable and secure API.
We will terminate API v1 and API v2 in 1 month on June 1st, 2012. (Note: The date was pushed back a month from the original date).
For those that depend on the API, we’re setting up a @githubapi Twitter account
for announcements. You can also follow changes to the API documentation
on its Git repository.
The motto for API v3 has been: “it’s not shipped if it’s not documented”.
Notable Changes for API v3
- Versioning is done through a custom GitHub mime type.
We’re currently planning for the first API v3 mime type version change due to
some incompatible tweaks to the output JSON. - Basic auth with tokens is not supported. You can create OAuth tokens for
internal scripts through the Authorizations API.
The benefit here is you can set OAuth scopes per token, and even attach notes
to tell you what function they’re serving.
Feedback
Let us know through support@github.com or our
Contact form if API v3 is missing features that
you depend on for API v2. If you have a friend or Nagios alert that’s using API
v2, be sure to let them know too.
Written by
Related posts
![](https://github.blog/wp-content/uploads/2023/10/Collaboration-DarkMode-2.png?resize=400%2C212)
2024 is the biggest global election year in history. What’s at stake for developers?
GitHub is considering what is at stake for our users and platform, how we can take responsible action to support free and fair elections, and how developers contribute to resilient democratic processes.
![](https://github.blog/wp-content/uploads/2023/10/AI-DarkMode-2.png?resize=400%2C212)
GitHub named a Leader in the Gartner first-ever Magic Quadrant for AI Code Assistants
This year, as part of its annual Magic Quadrant series, Gartner published a first-of-its-kind report analyzing the state of play in the AI Code Assistants market–and named GitHub a Leader.
![AI in software development 2024 survey results with colorful graphics and percentages.](https://github.blog/wp-content/uploads/2024/08/ai-survey-header.png?resize=400%2C212)
Survey: The AI wave continues to grow on software development teams
We surveyed 2,000 people on software development teams at enterprises in the U.S., Brazil, India, and Germany about the use, experience, and expectations around generative AI tools in software development.