Сведения о управлении версиями API
REST API GitHub — версия REST API. Имя версии API основано на дате выпуска версии API. Например, версия 2026-03-10 API была выпущена на Tue, 10 Mar 2026.
Критические изменения — это изменения, которые могут потенциально нарушить интеграцию. Мы предупредим заранее перед публикацией нерешительных изменений. Критические изменения включают:
- Удаление всей операции
- Удаление или переименование параметра
- Удаление или переименование поля ответа
- Добавление нового обязательного параметра
- Создание ранее необязательного параметра
- Изменение типа поля параметра или ответа
- Удаление значений перечисления
- Добавление нового правила проверки в существующий параметр
- Изменение требований к проверке подлинности или авторизации
Любые некритивные изменения будут доступны во всех поддерживаемых версиях API. Аддитивные изменения — это изменения, которые не должны прерывать интеграцию. К аддитивным изменениям относятся:
- Добавление операции
- Добавление необязательного параметра
- Добавление необязательного заголовка запроса
- Добавление поля ответа
- Добавление заголовка ответа
- Добавление значений перечисления
При выпуске новой версии REST API предыдущая версия API будет поддерживаться не менее 24 месяцев после выпуска новой версии API.
О GitHub Enterprise Server версионировании и версионировании REST API
GitHub Enterprise Server версии отделены от версий REST API. Вы можете обновить свою GitHub Enterprise Server версию, но оставить ту же версию REST API, если она включена в GitHub Enterprise Server версию. Аналогично, вы можете обновить версию REST API без обновления GitHub Enterprise Server , если новая выбранная вами версия REST API доступна для вашей GitHub Enterprise Server версии.
В GitHub Enterprise Server заметках к релизу будет указано, когда версия REST API больше не поддерживается. Дополнительные сведения см. в разделе Заметки о выпуске.
Указание версии API
Вам следует использовать заголовок X-GitHub-Api-Version для указания версии API. Например:
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. Дополнительные сведения см. в разделе Критические изменения.
Когда вы обновляете интеграцию, чтобы указать новую версию API в заголовке X-GitHub-Api-Version, вам также нужно внести необходимые изменения для работы с новой версией API.
После обновления интеграции проверьте интеграцию, чтобы убедиться, что она работает с новой версией API.
Поддерживаемые версии API
В настоящее время поддерживаются следующие версии REST API:
2022-11-28
Вы также можете запросить API, чтобы получить все поддерживаемые версии API. Дополнительные сведения см. в разделе Конечные точки REST API для метаданных.