debian-mirror-gitlab/doc/api/environments.md

308 lines
10 KiB
Markdown
Raw Normal View History

2020-07-28 23:09:34 +05:30
---
stage: Release
2021-02-22 17:27:13 +05:30
group: Release
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-07-28 23:09:34 +05:30
type: concepts, howto
---
2017-09-10 17:25:29 +05:30
# Environments API
2016-09-13 17:45:13 +05:30
## List environments
Get all environments for a given project.
2020-04-08 14:13:33 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
GET /projects/:id/environments
```
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2019-09-30 21:07:59 +05:30
| `name` | string | no | Return the environment with this name. Mutually exclusive with `search` |
| `search` | string | no | Return list of environments matching the search criteria. Mutually exclusive with `name` |
2020-07-28 23:09:34 +05:30
| `states` | string | no | List all environments that match a specific state. Accepted values: `available` or `stopped`. If no state value given, returns all environments. |
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments?name=review%2Ffix-foo"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
[
{
"id": 1,
2017-08-17 22:00:37 +05:30
"name": "review/fix-foo",
"slug": "review-fix-foo-dfjre3",
2020-10-24 23:57:45 +05:30
"external_url": "https://review-fix-foo-dfjre3.gitlab.example.com",
2019-12-21 20:55:43 +05:30
"state": "available"
2016-09-13 17:45:13 +05:30
}
]
```
2019-07-31 22:56:46 +05:30
## Get a specific environment
2020-04-08 14:13:33 +05:30
```plaintext
2019-07-31 22:56:46 +05:30
GET /projects/:id/environments/:environment_id
```
| Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------|
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2019-07-31 22:56:46 +05:30
| `environment_id` | integer | yes | The ID of the environment |
2020-03-13 15:44:24 +05:30
```shell
2019-07-31 22:56:46 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"
```
Example of response
```json
{
"id": 1,
"name": "review/fix-foo",
"slug": "review-fix-foo-dfjre3",
2020-10-24 23:57:45 +05:30
"external_url": "https://review-fix-foo-dfjre3.gitlab.example.com",
2019-12-21 20:55:43 +05:30
"state": "available",
2019-07-31 22:56:46 +05:30
"last_deployment": {
"id": 100,
"iid": 34,
"ref": "fdroid",
"sha": "416d8ea11849050d3d1f5104cf8cf51053e790ab",
"created_at": "2019-03-25T18:55:13.252Z",
2019-12-21 20:55:43 +05:30
"status": "success",
2019-07-31 22:56:46 +05:30
"user": {
"id": 1,
"name": "Administrator",
"state": "active",
"username": "root",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
"web_url": "http://localhost:3000/root"
2020-10-24 23:57:45 +05:30
},
2019-07-31 22:56:46 +05:30
"deployable": {
"id": 710,
"status": "success",
"stage": "deploy",
"name": "staging",
"ref": "fdroid",
"tag": false,
"coverage": null,
"created_at": "2019-03-25T18:55:13.215Z",
"started_at": "2019-03-25T12:54:50.082Z",
"finished_at": "2019-03-25T18:55:13.216Z",
"duration": 21623.13423,
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
"web_url": "http://gitlab.dev/root",
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
"public_email": "",
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": null
2020-10-24 23:57:45 +05:30
},
2019-07-31 22:56:46 +05:30
"commit": {
"id": "416d8ea11849050d3d1f5104cf8cf51053e790ab",
"short_id": "416d8ea1",
"created_at": "2016-01-02T15:39:18.000Z",
"parent_ids": [
"e9a4449c95c64358840902508fc827f1a2eab7df"
],
"title": "Removed fabric to fix #40",
"message": "Removed fabric to fix #40\n",
"author_name": "Administrator",
"author_email": "admin@example.com",
"authored_date": "2016-01-02T15:39:18.000Z",
"committer_name": "Administrator",
"committer_email": "admin@example.com",
"committed_date": "2016-01-02T15:39:18.000Z"
},
"pipeline": {
"id": 34,
"sha": "416d8ea11849050d3d1f5104cf8cf51053e790ab",
"ref": "fdroid",
"status": "success",
"web_url": "http://localhost:3000/Commit451/lab-coat/pipelines/34"
},
"web_url": "http://localhost:3000/Commit451/lab-coat/-/jobs/710",
"artifacts": [
{
"file_type": "trace",
"size": 1305,
"filename": "job.log",
"file_format": null
}
],
"runner": null,
"artifacts_expire_at": null
}
}
}
```
2016-09-13 17:45:13 +05:30
## Create a new environment
2020-06-23 00:09:42 +05:30
Creates a new environment with the given name and `external_url`.
2016-09-13 17:45:13 +05:30
2017-08-17 22:00:37 +05:30
It returns `201` if the environment was successfully created, `400` for wrong parameters.
2016-09-13 17:45:13 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
POST /projects/:id/environments
2016-09-13 17:45:13 +05:30
```
| Attribute | Type | Required | Description |
| ------------- | ------- | -------- | ---------------------------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2016-09-13 17:45:13 +05:30
| `name` | string | yes | The name of the environment |
| `external_url` | string | no | Place to link to for this environment |
2020-03-13 15:44:24 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --data "name=deploy&external_url=https://deploy.gitlab.example.com" \
--header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
{
"id": 1,
"name": "deploy",
2017-08-17 22:00:37 +05:30
"slug": "deploy",
2020-10-24 23:57:45 +05:30
"external_url": "https://deploy.gitlab.example.com",
2019-12-21 20:55:43 +05:30
"state": "available"
2016-09-13 17:45:13 +05:30
}
```
## Edit an existing environment
2020-06-23 00:09:42 +05:30
Updates an existing environment's name and/or `external_url`.
2016-09-13 17:45:13 +05:30
2017-08-17 22:00:37 +05:30
It returns `200` if the environment was successfully updated. In case of an error, a status code `400` is returned.
2016-09-13 17:45:13 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
PUT /projects/:id/environments/:environments_id
```
| Attribute | Type | Required | Description |
| --------------- | ------- | --------------------------------- | ------------------------------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2019-12-21 20:55:43 +05:30
| `environment_id` | integer | yes | The ID of the environment |
2016-09-13 17:45:13 +05:30
| `name` | string | no | The new name of the environment |
2020-06-23 00:09:42 +05:30
| `external_url` | string | no | The new `external_url` |
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --request PUT --data "name=staging&external_url=https://staging.gitlab.example.com" \
--header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
{
"id": 1,
"name": "staging",
2017-08-17 22:00:37 +05:30
"slug": "staging",
2020-10-24 23:57:45 +05:30
"external_url": "https://staging.gitlab.example.com",
2019-12-21 20:55:43 +05:30
"state": "available"
2016-09-13 17:45:13 +05:30
}
```
## Delete an environment
2018-03-17 18:26:18 +05:30
It returns `204` if the environment was successfully deleted, and `404` if the environment does not exist.
2016-09-13 17:45:13 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
DELETE /projects/:id/environments/:environment_id
```
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2016-09-13 17:45:13 +05:30
| `environment_id` | integer | yes | The ID of the environment |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"
2017-08-17 22:00:37 +05:30
```
2021-10-27 15:23:28 +05:30
## Delete multiple stopped review apps
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/296625) in GitLab 14.2.
It schedules for deletion multiple environments that have already been
[stopped](../ci/environments/index.md#stop-an-environment) and
are [in the review app folder](../ci/review_apps/index.md).
The actual deletion is performed after 1 week from the time of execution.
```plaintext
DELETE /projects/:id/environments/review_apps
```
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user. |
| `before` | datetime | no | The date before which environments can be deleted. Defaults to 30 days ago. Expected in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). |
| `limit` | integer | no | Maximum number of environments to delete. Defaults to 100. |
| `dry_run` | boolean | no | Defaults to `true` for safety reasons. It performs a dry run where no actual deletion will be performed. Set to `false` to actually delete the environment. |
```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/review_apps"
```
Example response:
```json
{
"scheduled_entries": [
{
"id": 387,
"name": "review/023f1bce01229c686a73",
"slug": "review-023f1bce01-3uxznk",
"external_url": null
},
{
"id": 388,
"name": "review/85d4c26a388348d3c4c0",
"slug": "review-85d4c26a38-5giw1c",
"external_url": null
}
],
"unprocessable_entries": []
}
```
2017-08-17 22:00:37 +05:30
## Stop an environment
It returns `200` if the environment was successfully stopped, and `404` if the environment does not exist.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/environments/:environment_id/stop
```
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2017-08-17 22:00:37 +05:30
| `environment_id` | integer | yes | The ID of the environment |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1/stop"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
{
"id": 1,
"name": "deploy",
2017-08-17 22:00:37 +05:30
"slug": "deploy",
2020-10-24 23:57:45 +05:30
"external_url": "https://deploy.gitlab.example.com",
2019-12-21 20:55:43 +05:30
"state": "stopped"
2016-09-13 17:45:13 +05:30
}
```