StopEnvironment

environments.stop() -> object

POST/gitpod.v1.EnvironmentService/StopEnvironment

Stops a running environment.

Use this method to pause work while preserving the environment’s state. The environment can be resumed later using StartEnvironment.

Examples

Stop an environment:

Gracefully stops a running environment while preserving its state.
```
environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
```

ParametersExpand Collapse

environment_id: Optional[str]

environment_id specifies which environment should be stopped.

+required

formatuuid

ReturnsExpand Collapse

object

StopEnvironment

import os
from gitpod import Gitpod

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

{}

Returns Examples

{}