StartEnvironment

client.environments.start(, ?): EnvironmentStartResponse

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

body: EnvironmentStartParams { environmentId }

environmentId?: string

environment_id specifies which environment should be started.

formatuuid

ReturnsExpand Collapse

EnvironmentStartResponse = unknown

StartEnvironment

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.environments.start({
  environmentId: '07e03a28-65a5-4d98-b532-8ea67b188048',
});

console.log(response);

{}

Returns Examples

{}