---
title: "StopService"
method: POST
path: "/gitpod.v1.EnvironmentAutomationService/StopService"
tags: ["gitpod.v1.EnvironmentAutomationService"]
---

# StopService

`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.

   ```yaml
   id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
   ```

## Request body

- GitpodV1StopServiceRequest
  - `id` string, uuid

## Response `200`

Success

- GitpodV1StopServiceResponse

## Other responses

- `default` — Error

## Changes

- **2025-02-18** `cd6a05ae99d2` — 1 warning
  - removed the optional property `detail` from the response with the `default` status

[Change history](https://skmtc.dev/gitpod-io/apis/gitpod-v1/changes/gitpod.v1.EnvironmentAutomationService/StopService/post.md)

---

[API](https://skmtc.dev/gitpod-io/apis/gitpod-v1.md) · [All operations](https://skmtc.dev/gitpod-io/apis/gitpod-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gitpod-io/gitpod-v1/revisions/44d50c2ac284/schema)
