DeleteEnvironment

environments.delete() -> object

POST/gitpod.v1.EnvironmentService/DeleteEnvironment

Permanently deletes an environment.

Running environments are automatically stopped before deletion. If force is true, the environment is deleted immediately without graceful shutdown.

Examples

Delete with graceful shutdown:

Deletes an environment after gracefully stopping it.
```
environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
force: false
```
Force delete:

Immediately deletes an environment without waiting for graceful shutdown.
```
environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
force: true
```

ParametersExpand Collapse

environment_id: Optional[str]

environment_id specifies the environment that is going to delete.

+required

formatuuid

force: Optional[bool]

force indicates whether the environment should be deleted forcefully When force deleting an Environment, the Environment is removed immediately and environment lifecycle is not respected. Force deleting can result in data loss on the environment.

ReturnsExpand Collapse

object

DeleteEnvironment

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
environment = client.environments.delete(
    environment_id="07e03a28-65a5-4d98-b532-8ea67b188048",
    force=False,
)
print(environment)

{}

Returns Examples

{}