GitHub API Changes | GitHub Developer Guide
This content may be out of date. For the newest content, see the API posts on the GitHub Blog . All of GitHub's Docs are now in one place ! You can see Apps , REST API , and GraphQL API on GitHub Docs. Actions API GA March 23, 2020 mscoutermarsh The Actions API is now generally available and out of Beta! For more information about this API, see the " Actions API ." Thank you to everyone who tried out this API and provided feedback during the beta period.
GitHub Actions is available with GitHub Free, GitHub Pro, GitHub Free for organizations, GitHub Team, GitHub Enterprise Cloud, and GitHub One. GitHub Actions is not available for private repositories owned by accounts using legacy per-repository plans. For more information, see GitHub's products in the GitHub Help documentation. Temporary GraphQL Explorer downtime March 20, 2020 ahoglund We are temporarily removing access to GraphQL Explorer so we can improve how it works in different browsers.
The downtime is scheduled for: March 20, 2020 From 15:00 UTC to 17:00 UTC We apologize for any inconvenience during this time. Filtering jobs for a workflow run March 6, 2020 gimenete We are introducing a breaking change to the List jobs for a workflow run endpoint . The new default behavior will list jobs from the most recent execution of the workflow run. You can specify all with the filter parameter when you want to see all jobs for a particular workflow run, including from old executions of the workflow run.
Please update your code accordingly, and let us know if you have any questions. Replacing the "Delete reactions" endpoint February 26, 2020 dbussink We are announcing a new set of "Deleting reactions" endpoints in the Reactions API to replace the existing "Delete reactions" endpoint DELETE /reactions/:reaction_id . The new endpoints will allow us to scale and support the Reactions API long-term. Deprecation timeline The existing "Delete reaction" endpoint deleting a reaction will be disabled a year from now at the earliest on February 1st 2021.
Replacement endpoints These are the new replacement Reaction API endpoints for deleting reactions: Delete a commit comment reaction DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id Delete an issue reaction DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id Delete a reaction to a commit comment DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id Delete a pull request comment reaction DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id Delete team discussion reaction DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id Delete team discussion comment reaction DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id Deprecating OAuth Application API February 14, 2020 jovel jpemberthy ptoomey3 As mentioned in this previous blog post , GitHub no longer supports the OAuth application endpoints and have replaced them with a version that moves the access token to the request body for improved security.
This deprecation has not been applied to GitHub Enterprise offerings yet. Please check the latest Enterprise release notes to learn when this deprecation is initiated and which version of GitHub Enterprise Server will have the OAuth Application API removed. As an alternative to authorizing your app, you can use the web application flow or the device flow. The device flow doesn't require using the client_secret and can be used by headless apps.
For more information, see " Authorizing OAuth Apps ." Deprecation timeline Brownouts During a brownout, calls to the old version of OAuth application endpoints will temporarily fail. The goal is to trigger alerts (assuming there are any) on our customers' services to help find unmigrated endpoint calls. The brownouts are scheduled for: March 17, 2021 From 07:00 UTC to 10:00 UTC From 16:00 UTC to 19:00 UTC April 14, 2021 From 07:00 UTC to 10:00 UTC From 16:00 UTC to 19:00 UTC Removal date All calls to the old version of the OAuth application endpoints will return a status code of 404 starting on: May 5, 2021 at 16:00 UTC Changes to make Using calls to OAuth Application API If you're using the version of the OAuth Application API that includes :access_token in the path like: curl -u my_client_id:my_client_secret -X POST "https://api.github.com/applications/123/tokens/my_access_token" Instead, you'll need to call the new version that moves :access_token in the request body: curl -u my_client_id:my_client_secret -X PATCH "https://api.github.com/applications/123/token -d {" access_token ": " my_access_token "}" See the list of OAuth application endpoints below that you'll need to replace with the new endpoints.
Endpoints affected The following list of OAuth Application endpoints are deprecated and should be replaced with the new corresponding endpoints. Deprecated Endpoint Deprecated Path New Endpoint New Path Check an authorization GET /applications/:client_id/tokens/:access_token Check a token POST /applications/:client_id/token Reset an authorization POST /applications/:client_id/tokens/:access_token Reset a token PATCH /applications/:client_id/token Revoke app authorization DELETE /applications/:client_id/tokens/:access_token Delete app token DELETE /applications/:client_id/token Revoke app grant DELETE /applications/:client_id/grants/:access_token Delete app authorization DELETE /applications/:client_id/grant If you have any questions or feedback, please let us know !
Deprecating OAuth Authorization API February 14, 2020 jovel jpemberthy ptoomey3 As mentioned in this previous blog post , GitHub has deprecated the OAuth authorization endpoints and recommends that integrators switch to the web application flow to generate access tokens. Since the OAuth Authorization API requires password authentication, this API will not work once password authentication has been deprecated . This deprecation has not been applied to GitHub Enterprise offerings, yet.
Though, we still recommend GHES customers to make the changes in their applications, if possible. Please check the latest Enterprise release notes to learn when deprecation is initiated and on which GHES version OAuth Authorization API will be removed. Deprecation timeline Removal date All calls to the OAuth authorization endpoints will return a status code of 404 starting on: November 13, 2020 at 16:00 UTC Brownouts During a brownout, calls to the old version of the OAuth Authorization API will temporarily fail.
The goal is to trigger alerts (assuming there are any) on our customers' services to help find unmigrated endpoint calls. The brownouts are scheduled for: September 30, 2020 From 07:00 UTC to 10:00 UTC From 16:00 UTC to 19:00 UTC October 28, 2020 From 07:00 UTC to 10:00 UTC From 16:00 UTC to 19:00 UTC Changes to make Calls to OAuth Authorizations API If you're making OAuth Authorization API calls to manage your OAuth app's authorizations or to create personal access or OAuth tokens like: curl -u my_username:my_password -X POST "https://api.github.com/authorizations" -d '{"scopes":["public_repo"], "note":"my token", "client_id":"my_client_id", "client_secret":"my_client_secret"}' Then you must switch to the web application flow to generate access tokens.
Endpoints affected The following list of OAuth authorization endpoints are deprecated: GET /authorizations GET /authorizations/:authorization_id POST /authorizations PUT /authorizations/clients/:client_id PUT /authorizations/clients/:client_id/:fingerprint PATCH /authorizations/:authorization_id DELETE /authorizations/:authorization_id GET /applications/grants GET /applications/grants/:grant_id DELETE /applications/grants/:grant_id If you have any questions or feedback, please let us know !
Deprecating password authentication February 14, 2020 jovel jpemberthy ptoomey3 As mentioned in this previous blog post , GitHub no longer supports basic authen
The rest of this page is on the live site.