GIgitlab
environments

Schedule multiple stopped review apps for deletion

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

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

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

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

Query parameters

beforestring date-time

The date before which environments can be deleted. Defaults to 30 days ago. Expected in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)

limitinteger

Maximum number of environments to delete. Defaults to 100

dry_runboolean

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

Response

Schedule multiple stopped review apps for deletion

idinteger required
namestring required
slugstring required
external_urlstring required
created_atstring date-time required
updated_atstring date-time required

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

Changes

No recorded changes to this operation across all 5 revisions of this API.