How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gitpod gitpod.v1.EnvironmentAutomationService API

The gitpod.v1.EnvironmentAutomationService API from Gitpod — 18 operation(s) for gitpod.v1.environmentautomationservice.

Gitpod gitpod.v1.EnvironmentAutomationService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 18 paths, and defines 83 schemas. It is described by OpenAPI 3.0.0, at version v1.0.0.

Requests are made against a single base URL, https://api.gitpod.io.

18 operations 18 paths 83 schemas 18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.0.0
Base URL
https://api.gitpod.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gitpod gitpod.v1.EnvironmentAutomationService API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 18

Across 18 paths, the API surfaces 18 operations — 18 POST. Each is listed below with its method, path, parameters, and response codes.

gitpod.v1.EnvironmentAutomationService 18
POST
/gitpod.v1.EnvironmentAutomationService/CreateService
CreateService
gitpod.v1.EnvironmentAutomationService.CreateService body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/CreateTask
CreateTask
gitpod.v1.EnvironmentAutomationService.CreateTask body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/DeleteService
DeleteService
gitpod.v1.EnvironmentAutomationService.DeleteService body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/DeleteTask
DeleteTask
gitpod.v1.EnvironmentAutomationService.DeleteTask body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/GetService
GetService
gitpod.v1.EnvironmentAutomationService.GetService body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/GetTask
GetTask
gitpod.v1.EnvironmentAutomationService.GetTask body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/GetTaskExecution
GetTaskExecution
gitpod.v1.EnvironmentAutomationService.GetTaskExecution body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/ListServices
ListServices
gitpod.v1.EnvironmentAutomationService.ListServices 2 params body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/ListTaskExecutions
ListTaskExecutions
gitpod.v1.EnvironmentAutomationService.ListTaskExecutions 2 params body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/ListTasks
ListTasks
gitpod.v1.EnvironmentAutomationService.ListTasks 2 params body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/StartService
StartService
gitpod.v1.EnvironmentAutomationService.StartService body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/StartTask
StartTask
gitpod.v1.EnvironmentAutomationService.StartTask body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/StopService
StopService
gitpod.v1.EnvironmentAutomationService.StopService body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/StopTaskExecution
StopTaskExecution
gitpod.v1.EnvironmentAutomationService.StopTaskExecution body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/UpdateService
UpdateService
gitpod.v1.EnvironmentAutomationService.UpdateService body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/UpdateTask
UpdateTask
gitpod.v1.EnvironmentAutomationService.UpdateTask body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/UpdateTaskExecutionStatus
UpdateTaskExecutionStatus
gitpod.v1.EnvironmentAutomationService.UpdateTaskExecutionStatus body → 200default
POST
/gitpod.v1.EnvironmentAutomationService/UpsertAutomationsFile
UpsertAutomationsFile
gitpod.v1.EnvironmentAutomationService.UpsertAutomationsFile body → 200default

Schemas 83

The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.TaskExecutionMetadata (7 properties), gitpod.v1.ServiceMetadata (7 properties), gitpod.v1.AutomationTrigger (6 properties), gitpod.v1.TaskMetadata (6 properties). Each schema is shown below with its type and property counts.

gitpod.v1.ListTaskExecutionsResponse
object
2 properties
gitpod.v1.ServiceStatus
object
6 properties
gitpod.v1.RunsOn
object
3 properties
gitpod.v1.TaskExecutionSpec.Task
object
2 properties
gitpod.v1.UpdateServiceRequest
object
4 properties
gitpod.v1.DeleteTaskRequest
object
1 property
gitpod.v1.Subject
object
2 properties
gitpod.v1.AutomationsFile
object
WARN: Do not remove any field here, as it will break reading automation yaml files. We error if there are any unknown fields in the yaml (to ensure the yaml is…
2 properties
gitpod.v1.EnvironmentVariableItem
object
EnvironmentVariableItem represents an environment variable that can be set either from a literal value or from a secret reference.
3 properties
gitpod.v1.DeleteTaskResponse
object
gitpod.v1.ServicePhase
string
gitpod.v1.ListTasksRequest.Filter
object
3 properties
gitpod.v1.UpdateServiceRequest.ServiceSpec
object
3 properties
gitpod.v1.RunsOn.Machine
object
Machine runs the service/task directly on the VM/machine level.
gitpod.v1.Principal
string
gitpod.v1.TaskExecutionStatus.Step
object
4 properties
gitpod.v1.TaskSpec
object
3 properties
gitpod.v1.CreateServiceResponse
object
1 property 1 required
gitpod.v1.Service
object
5 properties 2 required
gitpod.v1.UpdateServiceRequest.AutomationTriggerUpdate
object
1 property
gitpod.v1.ListTasksResponse
object
2 properties
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.UpdateTaskRequest.TaskMetadata
object
3 properties
gitpod.v1.ListTaskExecutionsRequest
object
2 properties
gitpod.v1.StopServiceRequest
object
1 property
gitpod.v1.UpdateServiceResponse
object
gitpod.v1.AutomationsFile.Service
object
6 properties
gitpod.v1.ServiceRole
string
gitpod.v1.TaskExecutionMetadata
object
7 properties
gitpod.v1.EnvironmentVariableSource
object
EnvironmentVariableSource specifies a source for an environment variable value.
1 property
gitpod.v1.CreateTaskResponse
object
1 property 1 required
gitpod.v1.TaskExecutionSpec.Group
object
1 property
gitpod.v1.TaskMetadata
object
6 properties
gitpod.v1.UpsertAutomationsFileResponse
object
2 properties
gitpod.v1.TaskExecutionSpec.Step
object
5 properties
gitpod.v1.ListServicesRequest.Filter
object
4 properties
gitpod.v1.UpsertAutomationsFileRequest
object
2 properties
gitpod.v1.DeleteServiceRequest
object
2 properties
gitpod.v1.ListTaskExecutionsRequest.Filter
object
4 properties
gitpod.v1.AutomationTrigger
object
An AutomationTrigger represents a trigger for an automation action. The manual field shows a start button in the UI for manually triggering the automation. The…
6 properties
gitpod.v1.Task
object
5 properties 2 required
gitpod.v1.TaskExecutionPhase
string
gitpod.v1.UpdateTaskExecutionStatusResponse
object
gitpod.v1.UpdateTaskResponse
object
gitpod.v1.ListServicesRequest
object
2 properties
gitpod.v1.StartTaskResponse
object
1 property 1 required
gitpod.v1.GetServiceResponse
object
1 property 1 required
gitpod.v1.TaskExecution
object
4 properties 1 required
gitpod.v1.ServiceMetadata
object
7 properties
gitpod.v1.StopTaskExecutionResponse
object
gitpod.v1.StartServiceRequest
object
1 property
gitpod.v1.ListTasksRequest
object
2 properties
gitpod.v1.RunsOn.Terminal
object
Terminal runs the service inside a managed PTY terminal in the devcontainer. Users can attach to the terminal interactively via the terminal API.
gitpod.v1.CreateServiceRequest
object
3 properties
gitpod.v1.AutomationsFile.Task
object
6 properties
gitpod.v1.UpdateTaskRequest.AutomationTriggerUpdate
object
1 property
gitpod.v1.ServiceSpec.Commands
object
3 properties
gitpod.v1.UpdateTaskExecutionStatusRequest
object
4 properties
gitpod.v1.TaskExecutionStatus
object
5 properties
gitpod.v1.GetServiceRequest
object
1 property
gitpod.v1.GetTaskRequest
object
1 property
gitpod.v1.UpdateServiceRequest.ServiceSpec.Commands
object
3 properties
gitpod.v1.StartServiceResponse
object
gitpod.v1.StopTaskExecutionRequest
object
1 property
gitpod.v1.SecretRef
object
SecretRef references a secret by its ID.
1 property
gitpod.v1.CreateTaskRequest
object
4 properties
gitpod.v1.UpdateTaskRequest
object
4 properties
gitpod.v1.StartTaskRequest
object
1 property
gitpod.v1.GetTaskResponse
object
1 property 1 required
gitpod.v1.ListServicesResponse
object
2 properties
gitpod.v1.TaskExecutionSpec
object
2 properties
gitpod.v1.DeleteServiceResponse
object
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.RunsOn.Docker
object
2 properties
gitpod.v1.UpdateServiceRequest.ServiceMetadata
object
4 properties
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.UpdateTaskRequest.TaskSpec
object
3 properties
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
gitpod.v1.ServiceSpec
object
6 properties
gitpod.v1.UpdateServiceRequest.ServiceStatus
object
5 properties
gitpod.v1.GetTaskExecutionResponse
object
1 property 1 required
gitpod.v1.StopServiceResponse
object
gitpod.v1.GetTaskExecutionRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitpod-gitpod-v1-environmentautomationservice-api-openapi.yml Raw ↑

Other APIs Gitpod publishes across the network.

Gitpod Organizations API
Gitpod Projects API
Gitpod Accounts and Billing API
Gitpod gitpod.v1.AccountService API
Gitpod gitpod.v1.AgentSecurityService API
Gitpod gitpod.v1.AgentService API
Gitpod gitpod.v1.BillingService API
Gitpod gitpod.v1.EditorService API
Gitpod gitpod.v1.EnvironmentService API
Gitpod gitpod.v1.ErrorsService API
Gitpod gitpod.v1.EventService API
Gitpod gitpod.v1.GatewayService API
Where this information came from

This is an independent, third-party profile of Gitpod gitpod.v1.EnvironmentAutomationService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.