Schedule multiple stopped review apps for deletion

DELETE

/api/v4/projects/{id}/environments/review_apps

• GitLab REST API

Schedules multiple stopped review apps for deletion. The deletion is performed after 1 week. By default, only environments 30 days or older are deleted.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project owned by the authenticated user

Query Parameters

before

string format: date-time

nullable

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

default: 100 nullable >= 1 <= 1000

Maximum number of environments to delete. Defaults to 100

dry_run

boolean

default: true nullable

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

Responses

204

No Content

Media type application/json

object

id

integer format: int64

name

string

slug

string

external_url

string

created_at

string format: date-time

updated_at

string format: date-time

Example

{
  "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"
}

400

Bad request

401

Unauthorized

404

Not found

409

Conflict