StopEnvironment

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

Body ParametersJSONExpand Collapse

environmentId: optional string

environment_id specifies which environment should be stopped.

+required

formatuuid

StopEnvironment

curl https://app.gitpod.io/api/gitpod.v1.EnvironmentService/StopEnvironment \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

{}

Returns Examples

{}