Получить переменные репозитория

GET /repos/{owner}/{repo}/actions/variables

Описание

Этот метод позволяет получить список переменных репозитория.

Токен

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

Заголовки

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

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

ПараметрОбязательныйОписание
ownerДаВладелец репозитория (логин или название организации)
repoДаНазвание репозитория

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

ПараметрОбязательныйОписание
per_pageНетКоличество результатов на странице (максимум 30)
pageНетНомер страницы результатов

Тело запроса

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

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

curl -X GET "https://api.gitverse.ru/repos/myorg/myrepo/actions/variables" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=1" \
  -G \
  --data-urlencode "page=1" \
  --data-urlencode "per_page=30"

Ответ (200 OK)

Ответ содержит список переменных репозитория.

{
  "variables": [
    {
      "name": "VAR_NAME",
      "value": "VAR_VALUE",
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z"
    }
  ],
  "total_count": 1
}

Формат ответа: application/vnd.gitverse.object+json;version=1

Коды ответов

КодСтатусОписание
200OkЗапрос выполнен успешно, информация о переменной получена
400Bad RequestНекорректный запрос
401UnauthorizedНеобходима авторизация
403ForbiddenНедостаточно прав на выполнение
404Not FoundПеременная не найдена
429Too Many RequestsПревышен лимит запросов
500Internal Server ErrorВнутренняя ошибка сервера

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

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

{
  "error": {
    "code": "BAD_REQUEST",
    "documentation_url": "https://gitverse.ru/docs/developers/public-api/",
    "message": "The request format is invalid",
    "status": 400
  }
}

Примечания

  • убедитесь, что токен API указан корректно и обладает необходимыми правами для доступа к репозиторию;
  • возвращаемый список переменных может быть ограничен параметрами per_page и page.