API のバージョン管理について
GitHub REST API はバージョン管理されています。 API バージョンの名前は、その API バージョンがリリースされた日付に基づいています。 たとえば、API バージョン 2026-03-10 は Tue, 10 Mar 2026 にリリースされました。
破壊的変更とは、統合を破損する可能性のある変更のことです。 破壊的変更をリリースする前に、事前通知を行います。 破壊的変更には次のようなものが含まれます。
- 操作全体の削除
- パラメーターの削除または名前変更
- 応答フィールドの削除または名前変更
- 新しい必須パラメーターの追加
- 以前に省略可能だったパラメーターを必須にする
- パラメーターまたは応答フィールドの型の変更
- 列挙型の値の削除
- 既存のパラメーターへの新しい検証規則の追加
- 認証または認可の要件の変更
追加的な (破壊的でない) 変更は、サポートされているすべての API バージョンで使用できます。 追加的な変更とは、統合を破損しない変更のことです。 追加的な変更には次のようなものが含まれます。
- 操作の追加
- 省略可能なパラメーターの追加
- 省略可能な要求ヘッダーの追加
- 応答フィールドの追加
- 応答ヘッダーの追加
- 列挙型の値の追加
新しい REST API バージョンがリリースされた場合、以前の API バージョンは、新しい API バージョンのリリースから少なくとも 24 か月間はサポートされます。
バージョン管理と REST API のバージョン管理 GitHub Enterprise Server について
GitHub Enterprise Server バージョンは REST API バージョンから切り離されています。
GitHub Enterprise Serverバージョンはアップグレードできますが、API バージョンが GitHub Enterprise Server バージョンに含まれている限り、同じ REST API バージョンを維持できます。 同様に、選択した新しい REST API バージョンが GitHub Enterprise Server バージョンで使用できる限り、GitHub Enterprise Server バージョンを更新せずに REST API のバージョンをアップグレードできます。
GitHub Enterprise Serverリリース ノートでは、REST API バージョンがサポートされなくなった場合に示されます。 詳しくは、「[AUTOTITLE](/admin/release-notes)」をご覧ください。
API バージョンの指定
API バージョンを指定するには、X-GitHub-Api-Version ヘッダーを使用する必要があります。 次に例を示します。
curl --header "X-GitHub-Api-Version:2022-11-28" https://api.github.com/zen
`X-GitHub-Api-Version` ヘッダーのない要求では、既定で `2022-11-28` バージョンが使用されます。
サポートされなくなった API のバージョンを指定すると、400 エラーが表示されます。
新しい API バージョンへのアップグレード
新しい REST API バージョンにアップグレードする前に、新しい API バージョンの破壊的変更に関する変更ログを読んで、どのような破壊的変更が含まれているかを理解し、その特定の API バージョンにアップグレードする方法の詳細を確認する必要があります。 詳しくは、「重大な変更」をご覧ください。
`X-GitHub-Api-Version` ヘッダーで新しい API バージョンを指定するように統合を更新する場合は、統合が新しい API バージョンで動作するために必要な変更を加える必要もあります。
統合が更新されたら、統合をテストして、新しい API バージョンで動作することを確認します。
サポートされる API バージョン
現在、次の REST API バージョンがサポートされています。
2022-11-28
API 要求を行い、サポートされているすべての API バージョンを取得することもできます。 詳しくは、「メタデータ用 REST API エンドポイント」をご覧ください。