1
0
mirror of synced 2025-12-19 18:10:59 -05:00
Files
docs/content/rest/about-the-rest-api/breaking-changes.md
2025-01-22 11:12:58 +00:00

1.3 KiB

title, shortTitle, intro, versions, redirect_from
title shortTitle intro versions redirect_from
Breaking changes Breaking changes Learn about breaking changes that were introduced in each REST API version.
fpt ghes ghec
* * *
/rest/overview/breaking-changes

About breaking changes in the REST API

{% data reusables.rest-api.about-api-versions %}

For more information about API versions, see AUTOTITLE.

Upgrading to a new API version

Before upgrading to a new REST API version, you should read the section on this page that corresponds to the new API version to understand what breaking changes are included and to learn more about how to upgrade to that API version.

When you update your integration to specify the new API version in the X-GitHub-Api-Version header, you'll also need to make any changes required for your integration to work with the new API version.

Once your integration is updated, test your integration to verify that it works with the new API version.

Breaking changes for {{ initialRestVersioningReleaseDate }}

Version {{ initialRestVersioningReleaseDate }} is the first version of the {% data variables.product.github %} REST API after date-based versioning was introduced. This version does not include any breaking changes.