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

# UpdateService

`POST /gitpod.v1.EnvironmentAutomationService/UpdateService`

## Request body

- GitpodV1UpdateServiceRequest
  - `id` string, uuid
  - `metadata` GitpodV1UpdateServiceRequestServiceMetadata
    - `description` string, nullable
    - `name` string, nullable
    - `triggeredBy` GitpodV1UpdateServiceRequestAutomationTriggerUpdate — unresolved $ref
  - `spec` GitpodV1UpdateServiceRequestServiceSpec
    - `commands` GitpodV1UpdateServiceRequestServiceSpecCommands
      - `ready` string, nullable
      - `start` string, nullable
      - `stop` string, nullable
    - `runsOn` GitpodV1RunsOn
      - `docker` GitpodV1RunsOnDocker, required
        - `environment` string[]
        - `image` string
  - `status` GitpodV1UpdateServiceRequestServiceStatus
    - `failureMessage` string, nullable
    - `logUrl` string, nullable
    - `phase` 'SERVICE_PHASE_UNSPECIFIED' | 'SERVICE_PHASE_STARTING' | 'SERVICE_PHASE_RUNNING' | 'SERVICE_PHASE_STOPPING' | 'SERVICE_PHASE_STOPPED' | 'SERVICE_PHASE_FAILED' | 'SERVICE_PHASE_DELETED'
    - `session` string, nullable

## Response `200`

Success

- GitpodV1UpdateServiceResponse

## Other responses

- `default` — Error

---

[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/27f7bd641de1/schema)