Получить переменные организации

GET /orgs/{org}/actions/variables

Описание

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

Токен

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

Заголовки

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

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

Параметр	Обязательный	Описание
org	Да	Название организации

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

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

Тело запроса

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

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

curl -X GET "https://api.gitverse.ru/orgs/myorg/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

Коды ответов

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