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

# GetService

`POST /gitpod.v1.EnvironmentAutomationService/GetService`

Gets details about a specific automation service.

 Use this method to:
 - Check service status
 - View service configuration
 - Monitor service health
 - Retrieve service metadata

 ### Examples

 - Get service details:

   Retrieves information about a specific service.

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

## Request body

- GitpodV1GetServiceRequest
  - `id` string, uuid

## Response `200`

Success

- GitpodV1GetServiceResponse
  - `service` GitpodV1Service, required
    - `environmentId` string, uuid
    - `id` string, uuid, required
    - `metadata` GitpodV1ServiceMetadata — unresolved $ref
    - `spec` GitpodV1ServiceSpec — unresolved $ref
    - `status` GitpodV1ServiceStatus
      - `failureMessage` string — failure_message summarises why the service failed to operate. If this is non-empty the service has failed to operate and will likely transition to a failed state.
      - `logUrl` string — log_url contains the URL at which the service logs can be accessed.
      - `output` object — output contains the output of the service. setting an output field to empty string will unset it.
      - `phase` 'SERVICE_PHASE_UNSPECIFIED' | 'SERVICE_PHASE_STARTING' | 'SERVICE_PHASE_RUNNING' | 'SERVICE_PHASE_STOPPING' | 'SERVICE_PHASE_STOPPED' | 'SERVICE_PHASE_FAILED' | 'SERVICE_PHASE_DELETED'
      - `session` string — session is the current session of the service.
      - `statusVersion` string — version of the status update. Service instances themselves are unversioned, but their status has different versions. The value of this field has no semantic meaning (e.g. don't interpret it as as a timestamp), but it can be used to impose a partial order. If a.status_version < b.status_version then a was the status before b.

## Other responses

- `default` — Error

## Changes

- **2026-07-30** `44d50c2ac284` — 1 breaking, 1 warning, 2 info
  - added `subschema #1, subschema #2` to the `service/spec/runsOn` response property `oneOf` list for the response status `200`
  - removed the optional property `service/spec/runsOn/terminal` from the response with the `200` status
  - added the optional property `service/spec/readinessTimeout` to the response with the `200` status
  - removed `subschema #1, subschema #2, subschema #3` from the `service/spec/runsOn` response property `oneOf` list for the response status `200`
- **2026-04-02** `dabc0ff98cd7` — 1 breaking, 3 info
  - added `subschema #1, subschema #2, subschema #3` to the `service/spec/runsOn` response property `oneOf` list for the response status `200`
  - added the optional property `service/spec/runsOn/terminal` to the response with the `200` status
  - removed the `PRINCIPAL_AGENT_EXECUTION` enum value from the `service/metadata/creator/principal` response property for the response status `200`
  - removed `subschema #1, subschema #2` from the `service/spec/runsOn` response property `oneOf` list for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/gitpod-io/apis/gitpod-v1/changes/gitpod.v1.EnvironmentAutomationService/GetService/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)