Получить список раннеров для организации

GET /orgs/{org}/actions/runners

Описание

Этот метод позволяет получить список локальных раннеров, сконфигурированных для указанной организации. Поддерживает пагинацию. Раннеры могут просматривать только те пользователи, у которых есть как минимум доступ на чтение указанной организации.

Токен

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

Заголовки

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

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

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

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

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

Тело запроса

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

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

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

Ответ содержит список раннеров организации.

{
  "runners": [
    {
      "id": 123,
      "name": "runner-01",
      "status": "online",
      "busy": false,
      "labels": [
        {
          "id": 1,
          "name": "linux",
          "type": "agent"
        }
      ]
    }
  ],
  "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 указан корректно и обладает необходимыми правами для доступа к организации;
• возвращаемый список раннеров может быть ограничен параметрами page и per_page.