StopService

client.environments.automations.services.stop(, ?): ServiceStopResponse

POST/gitpod.v1.EnvironmentAutomationService/StopService

Stops an automation service. This call does not block until the service is stopped. This call will not error if the service is already stopped or has been stopped.

Use this method to:

Pause service operations
Gracefully stop services
Prepare for updates

Examples

Stop service:

Gracefully stops a running service.
```
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

ParametersExpand Collapse

body: ServiceStopParams { id }

id?: string

formatuuid

ReturnsExpand Collapse

ServiceStopResponse = unknown

StopService

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.automations.services.stop({
  id: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

console.log(response);

{}

Returns Examples

{}