1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/panda26-gitlab

Клонировать/Скачать
environments.md 5.5 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 26.05.2025 02:09 64486eb

API для окружений

Получить список окружений

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

GET /projects/:id/environments
Атрибут Тип Обязательный Описание
id integer/string да ID или URL-кодированное имя проекта, принадлежащее аутентифицированному пользователю
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/environments

Пример ответа:

[
  {
    "id": 1,
    "name": "review/fix-foo",
    "slug": "review-fix-foo-dfjre3",
    "external_url": "https://review-fix-foo-dfjre3.example.gitlab.com"
  }
]

Создать новое окружение

Создает новое окружение с заданным именем и внешним URL.

Возвращает 201, если окружение успешно создано, 400 для неправильных параметров.

POST /projects/:id/environment
Атрибут Тип Обязательный Описание
id integer/string да ID или URL-кодированное имя проекта, принадлежащее аутентифицированному пользователю
name string да Имя окружения
external_url string нет URL для ссылки на это окружение
curl --data "name=deploy&external_url=https://deploy.example.gitlab.com" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/environments"

Пример ответа:

{
  "id": 1,
  "name": "deploy",
  "slug": "deploy",
  "external_url": "https://deploy.example.gitlab.com"
}

Редактировать существующее окружениеОбновляет имя и/или внешний URL существующего окружения.

Возвращает 200, если окружение успешно обновлено. В случае ошибки возвращается статус 400.

PUT /projects/:id/environments/:environments_id
Атрибут Тип Обязательно Описание
id integer/string да ID или URL-кодируемый путь проекта, принадлежащий аутентифицированному пользователю
environment_id integer да ID окружения
name string нет Новое имя окружения
external_url string нет Новый внешний URL
curl --request PUT --data "name=staging&external_url=https://staging.example.gitlab.com" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/environments/1"

Пример ответа:

{
  "id": 1,
  "name": "staging",
  "slug": "staging",
  "external_url": "https://staging.example.gitlab.com"
}

Удаление окружения

Возвращает 200, если окружение было успешно удалено, и 404, если окружение не существует.

DELETE /projects/:id/environments/:environment_id
Атрибут Тип Обязательный Описание
id integer/string да ID или URL-кодированное имя проекта, принадлежащее аутентифицированному пользователю
environment_id integer да ID окружения
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/environments/1"
```## Остановка окружения

Возвращает `200`, если окружение было успешно остановлено, и `404`, если окружение не существует.

POST /projects/:id/environments/:environment_id/stop


| Атрибут | Тип    | Обязательный | Описание           |
| -------- | ------- | ------------ | ------------------ |
| `id` | integer/string | да | ID или [URL-кодированное имя проекта](README.md#namespaced-path-encoding), принадлежащее аутентифицированному пользователю |
| `environment_id` | integer | да | ID окружения |

```bash
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/environments/1/stop"

Пример ответа:

{
  "id": 1,
  "name": "deploy",
  "slug": "deploy",
  "external_url": "https://deploy.example.gitlab.com"
}

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/panda26-gitlab.git
git@api.gitlife.ru:oschina-mirror/panda26-gitlab.git
oschina-mirror
panda26-gitlab
panda26-gitlab
master