StartService

client.environments.automations.services.start(, ?): ServiceStartResponse

POST/gitpod.v1.EnvironmentAutomationService/StartService

Starts an automation service. This call does not block until the service is started. This call will not error if the service is already running or has been started.

Use this method to:

Start stopped services
Resume service operations
Trigger service initialization

Examples

Start service:

Starts a previously stopped service.
```
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

ParametersExpand Collapse

body: ServiceStartParams { id }

id?: string

formatuuid

ReturnsExpand Collapse

ServiceStartResponse = unknown

StartService

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

console.log(response);

{}

Returns Examples

{}