Получить ветку

GET /repos/{owner}/{repo}/branches/{branch}

Описание

Возвращает информацию об указанной ветке репозитория: имя ветки, последний коммит и признак защиты.

Схема ответа совпадает с объектом ветки из массива, возвращаемого методом GET /repos/{owner}/{repo}/branches.

Токен

Требуется токен с правами на Чтение для Репозитория.

Заголовки

Параметр	Обязательный	Описание
`accept`	Нет	Тип содержимого ответа. Рекомендуется установить значение `application/vnd.gitverse.object+json;version=latest`

Параметры пути

Параметр	Тип	Обязательный	Описание
`owner`	`string`	Да	Владелец репозитория (пользователь или организация)
`repo`	`string`	Да	Название репозитория без расширения `.git`
`branch`	`string`	Да	Имя ветки, например `main` или `feature/x`

Параметры запроса

Данный метод не принимает параметров в строке запроса.

Тело запроса

Данный метод не требует тела запроса.

Пример запроса

curl -X GET "https://api.gitverse.ru/repos/gitverse/example-repo/branches/main" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=latest"

Для ветки, имя которой содержит /, закодируйте этот символ как %2F:

curl -X GET "https://api.gitverse.ru/repos/gitverse/example-repo/branches/feature%2Fx" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=latest"

Ответ (`200 OK`)

{
  "name": "main",
  "commit": {
    "sha": "a1b2c3d4e5f6789012345678901234567890abcd",
    "created": "2025-10-20T14:30:00Z",
    "url": "https://api.gitverse.ru/repos/gitverse/example-repo/git/commits/a1b2c3d4e5f6789012345678901234567890abcd",
    "html_url": "https://gitverse.ru/gitverse/example-repo/commit/a1b2c3d4e5f6789012345678901234567890abcd"
  },
  "protected": false
}

Формат ответа

application/vnd.gitverse.object+json;version=latest

Поля ответа

Поле	Тип	Описание
`name`	string	Имя ветки
`commit`	object	Информация о последнем коммите в ветке
`protected`	boolean	Является ли ветка защищенной

Объект `commit`

Поле	Тип	Описание
`sha`	string	SHA-хеш коммита
`created`	string	Дата создания коммита в формате RFC3339 / ISO 8601
`url`	string	URL коммита в Public API
`html_url`	string	URL коммита в веб-интерфейсе GitVerse

Коды ответа

Код	Статус	Описание
`200`	OK	Информация о ветке успешно получена
`401`	Unauthorized	Токен отсутствует или недействителен
`403`	Forbidden	Доступ к репозиторию запрещен
`404`	Not Found	Репозиторий или ветка не найдены
`429`	Too Many Requests	Превышен лимит запросов
`500`	Internal Server Error	Внутренняя ошибка сервера

Пример тела ошибки

При ответе 401 тело ответа имеет следующий вид:

{
  "error": {
    "code": "UNAUTHORIZED",
    "documentation_url": "https://gitverse.ru/docs/developers/public-api/",
    "message": "Authorization is required",
    "status": 401
  }
}

Примечания

Параметр branch должен содержать точное имя ветки и не поддерживает шаблоны.
Метод не изменяет репозиторий или ветку.

Проводник