Публичный APICI/CD3. GET /repos/{owner}/{repo}/actions/runs — получить список запусков действий

3. GET /repos/{owner}/{repo}/actions/runs — получить список запусков действий

Описание

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

Параметры URL:

ПараметрОбязательныйОписание
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

Коды ответов

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

Примечания:

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

Вы нашли что искали?