v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
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"
    
post/gitpod.v1.EnvironmentService/StopEnvironment

Request body

environmentIdstring uuid

environment_id specifies which environment should be stopped.

+required

Response

Success

GitpodV1StopEnvironmentResponse required