StartEnvironment

environments.start() -> object

POST/gitpod.v1.EnvironmentService/StartEnvironment

Starts a stopped environment.

Use this method to resume work on a previously stopped environment. The environment retains its configuration and workspace content from when it was stopped.

Examples

Start an environment:

Resumes a previously stopped environment with its existing configuration.
```
environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
```

ParametersExpand Collapse

environment_id: Optional[str]

environment_id specifies which environment should be started.

formatuuid

ReturnsExpand Collapse

object

StartEnvironment

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.start(
    environment_id="07e03a28-65a5-4d98-b532-8ea67b188048",
)
print(response)

{}

Returns Examples

{}