Получить список запусков действий

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

Описание

Этот метод позволяет получить список запусков действий в репозитории.

Токен

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

Заголовки

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

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

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

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

Параметр	Обязательный	Описание
per_page	Нет	Количество результатов на странице (максимум 30)
page	Нет	Номер страницы результатов
status	Нет	Фильтр по статусу запуска (queued, in_progress, completed)
actor	Нет	Фильтр по пользователю, запустившему действие
branch	Нет	Фильтр по ветке
event	Нет	Фильтр по типу события, вызвавшего запуск

Тело запроса

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

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

curl -X GET "https://api.gitverse.ru/repos/myorg/myrepo/actions/runs?actor=user&branch=main&event=push&status=completed&page=1&per_page=30" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=latest"

Ответ (200 OK)

Ответ содержит список запусков действий.

{
  "total_count": 1,
  "workflow_runs": [
    {
      "id": 123456,
      "name": "Build",
      "actor": {
        "login": "user",
        "id": 12345,
        "avatar_url": "https://avatars.githubusercontent.com/u/12345?v=4",
        "url": "https://api.gitverse.ru/users/user",
        "followers_url": "https://api.gitverse.ru/users/user/followers",
        "following_url": "https://api.gitverse.ru/users/user/following",
        "organizations_url": "https://api.gitverse.ru/users/user/orgs",
        "repos_url": "https://api.gitverse.ru/users/user/repos",
        "html_url": "https://gitverse.ru/user",
        "site_admin": false,
        "type": "User"
      },
      "approved_by": 0,
      "commit_sha": "abc123def456",
      "event": "push",
      "index": 1,
      "is_fork_pull_request": false,
      "need_approval": false,
      "ref": "refs/heads/main",
      "started": "2023-01-01T00:00:00Z",
      "status": "completed",
      "stopped": "2023-01-01T00:00:00Z",
      "title": "Build workflow"
    }
  ]
}

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

Коды ответов

Код	Статус	Описание
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;
• параметры фильтрации позволяют уточнить результаты запроса.