environments
List all environments
Lists all environments for a specified project.
get/api/v4/projects/{id}/environments
Request
- Base URLhttps://gitlab.com
- Authnone declared
Path parameters
idstring required
The ID or URL-encoded path of the project owned by the authenticated user
Query parameters
pageinteger
Current page number
per_pageinteger
Number of items per page
namestring
Return the environment with this name. Mutually exclusive with search
searchstring
Return list of environments matching the search criteria. Mutually exclusive with name. Must be at least 3 characters.
states'stopped' | 'stopping' | 'available'
List all environments that match a specific state. Accepted values: available, stopping, or stopped. If no state value given, returns all environments
Response
List all environments
Example response
[
{
"id": 1,
"name": "deploy",
"slug": "deploy",
"external_url": "https://deploy.gitlab.example.com",
"created_at": "2019-05-25T18:55:13.252Z",
"updated_at": "2019-05-25T18:55:13.252Z",
"tier": "development",
"project": {
"id": 1,
"description": "desc",
"name": "project1",
"name_with_namespace": "John Doe / project1",
"path": "project1",
"path_with_namespace": "namespace1/project1",
"created_at": "2020-05-07T04:27:17.016Z",
"default_branch": "main",
"tag_list": [
"tag"
],
"topics": [
"topic"
],
"ssh_url_to_repo": "git@gitlab.example.com:gitlab/gitlab.git",
"http_url_to_repo": "https://gitlab.example.com/gitlab/gitlab.git",
"web_url": "https://gitlab.example.com/gitlab/gitlab",
"readme_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/README.md",
"forks_count": 1,
"license_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE",
"license": {
"key": "gpl-3.0",
"name": "GNU General Public License v3.0",
"nickname": "GNU GPLv3",
"html_url": "http://choosealicense.com/licenses/gpl-3.0"
},
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
"star_count": 1,
"last_activity_at": "2013-09-30T13:46:02Z",
"visibility": "public",
"namespace": {
"id": 2,
"name": "project",
"path": "my_project",
"kind": "project",
"full_path": "group/my_project",
"parent_id": 1,
"avatar_url": "https://example.com/avatar/12345",
"web_url": "https://example.com/group/my_project"
},
"custom_attributes": {
"key": "foo",
"value": "bar"
},
"repository_storage": "default"
},
"last_deployment": {
"id": 41,
"iid": 1,
"ref": "main",
"sha": "99d03678b90d914dbb1b109132516d71a4a03ea8",
"created_at": "2016-08-11T11:32:35.444Z",
"updated_at": "2016-08-11T11:32:35.444Z",
"user": {
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"state": "active",
"avatar_url": "https://gravatar.com/avatar/1",
"avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
"custom_attributes": [
{
"key": "foo",
"value": "bar"
}
],
"web_url": "https://gitlab.example.com/root"
},
"environment": {
"id": 1,
"name": "deploy",
"slug": "deploy",
"external_url": "https://deploy.gitlab.example.com",
"created_at": "2019-05-25T18:55:13.252Z",
"updated_at": "2019-05-25T18:55:13.252Z"
},
"deployable": {
"id": 1,
"status": "waiting_for_resource",
"stage": "deploy",
"name": "deploy_to_production",
"ref": "main",
"coverage": 98.29,
"created_at": "2015-12-24T15:51:21.880Z",
"started_at": "2015-12-24T17:54:30.733Z",
"finished_at": "2015-12-24T17:54:31.198Z",
"erased_at": "2015-12-24T18:00:29.728Z",
"duration": 0.465,
"queued_duration": 0.123,
"user": {
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"state": "active",
"avatar_url": "https://gravatar.com/avatar/1",
"avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
"custom_attributes": [
{
"key": "foo",
"value": "bar"
}
],
"web_url": "https://gitlab.example.com/root"
},
"commit": {
"id": "2695effb5807a22ff3d138d593fd856244e155e7",
"short_id": "2695effb",
"created_at": "2017-07-26T11:08:53.000+02:00",
"parent_ids": [
"2a4b78934375d7f53875269ffd4f45fd83a84ebe"
],
"title": "Initial commit",
"message": "Initial commit",
"author_name": "John Smith",
"author_email": "john@example.com",
"authored_date": "2012-05-28T04:42:42-07:00",
"committer_name": "Jack Smith",
"committer_email": "jack@example.com",
"committed_date": "2012-05-28T04:42:42-07:00",
"trailers": {
"Merged-By": "Jane Doe janedoe@gitlab.com"
},
"extended_trailers": {
"Signed-off-by": [
"John Doe <johndoe@gitlab.com>",
"Jane Doe <janedoe@gitlab.com>"
]
},
"web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746"
},
"pipeline": {
"id": 1,
"iid": 2,
"project_id": 3,
"sha": "0ec9e58fdfca6cdd6652c083c9edb53abc0bad52",
"ref": "feature-branch",
"status": "success",
"source": "push",
"created_at": "2022-10-21T16:49:48.000+02:00",
"updated_at": "2022-10-21T16:49:48.000+02:00",
"web_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61"
},
"failure_reason": "script_failure",
"web_url": "https://example.com/foo/bar/-/jobs/1",
"artifacts_file": {
"filename": "artifacts.zip",
"size": 1000
},
"artifacts": [
{
"file_type": "archive",
"size": 1000,
"filename": "artifacts.zip",
"file_format": "zip"
}
],
"runner": {
"id": 8,
"description": "test-1-20150125",
"ip_address": "127.0.0.1",
"active": true,
"is_shared": true,
"runner_type": "instance_type",
"name": "test",
"online": true,
"created_by": {
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"state": "active",
"avatar_url": "https://gravatar.com/avatar/1",
"avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
"custom_attributes": [
{
"key": "foo",
"value": "bar"
}
],
"web_url": "https://gitlab.example.com/root"
},
"created_at": "2025-05-03T00:00:00.000Z",
"status": "online",
"job_execution_status": "idle"
},
"runner_manager": {
"id": 8,
"system_id": "runner-1",
"version": "16.11.0",
"revision": "91a27b2a",
"platform": "linux",
"architecture": "amd64",
"created_at": "2023-10-24T01:27:06.549Z",
"contacted_at": "2023-10-24T01:27:06.549Z",
"ip_address": "127.0.0.1",
"status": "online",
"job_execution_status": "idle"
},
"artifacts_expire_at": "2016-01-19T09:05:50.355Z",
"tag_list": [
"ubuntu18",
"docker runner"
]
},
"status": "created"
},
"state": "available",
"auto_stop_at": "2019-05-25T18:55:13.252Z",
"cluster_agent": {
"id": 1,
"config_project": {
"id": 1,
"description": "desc",
"name": "project1",
"name_with_namespace": "John Doe / project1",
"path": "project1",
"path_with_namespace": "namespace1/project1",
"created_at": "2020-05-07T04:27:17.016Z"
},
"created_by_user_id": 1
},
"description": "description",
"auto_stop_setting": "always"
}
]Changes
No recorded changes to this operation across all 5 revisions of this API.