Environments API

• List environments
• Edit an existing environment
• Stop an environment

Environments API

获取给定项目的所有环境.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments?name=review%2Ffix-foo"

响应示例：

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

Get a specific environment

GET /projects/:id/environments/:environment_id

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"

回应范例

如果成功创建了环境，则返回否则返回400 .

curl --data "name=deploy&external_url=https://deploy.example.gitlab.com" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments"

响应示例：

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

Edit an existing environment

更新现有环境的名称和/或external_url .

PUT /projects/:id/environments/:environments_id

响应示例：

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

如果成功删除了环境，则返回204如果环境不存在，则返回404 .

DELETE /projects/:id/environments/:environment_id

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"

Stop an environment

如果成功停止了环境，则返回200如果环境不存在，则返回404 .

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

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