StopService

environments.automations.services.stop() -> object

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

id: Optional[str]

formatuuid

ReturnsExpand Collapse

object

StopService

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.environments.automations.services.stop(
    id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(response)

{}

Returns Examples

{}