Отменить запуск воркфлоу
POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel
Описание
Этот метод позволяет отменить выполнение запущенного воркфлоу по ID запуска. Отменить можно только запуск, который еще не завершил выполнение. Отменять запуски могут только те пользователи, у которых есть как минимум доступ на запись указанного репозитория.
Токен
Требуется токен с правами на Запись для Репозитория.
Заголовки
| Параметр | Обязательный | Описание |
|---|---|---|
Authorization | Да | Заголовок авторизации. Формат: Bearer <token> |
Accept | Нет | Тип содержимого ответа. Рекомендуется установить значение application/vnd.gitverse.object+json;version=latest |
Параметры пути
| Параметр | Обязательный | Описание |
|---|---|---|
owner | Да | Владелец репозитория (логин или название организации) |
repo | Да | Название репозитория |
run_id | Да | Идентификатор запуска |
Тело запроса
Данный метод не требует тела запроса.
Пример запроса
curl -X POST "https://api.gitverse.ru/repos/myuser/myrepo/actions/runs/123456/cancel" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/vnd.gitverse.object+json;version=1"Ответ (201 Created)
Метод не возвращает содержимого в ответе. Успешная отмена запуска будет обозначаться статусом 201 Created.
Коды ответов
| Код | Статус | Описание |
|---|---|---|
201 | Created | Запуск успешно отменен |
400 | Bad Request | Некорректные параметры запроса |
401 | Unauthorized | Необходима авторизация |
403 | Forbidden | Недостаточно прав на выполнение |
404 | Not Found | Репозиторий или запуск не найдены |
409 | Conflict | Запуск уже завершил выполнение, отменить его нельзя |
429 | Too Many Requests | Превышен лимит запросов |
500 | Internal Server Error | Внутренняя ошибка сервера |
Примечания
- убедитесь, что токен API указан корректно и обладает необходимыми правами для доступа к репозиторию;
- отменить можно только активный запуск, если запуск уже завершил выполнение, метод вернет
409 Conflict.