LogoGitpod Documentation

Environments

environments

Methods

Create Environment -> { environment }
post/gitpod.v1.EnvironmentService/CreateEnvironment

CreateEnvironment creates a new environment and starts it.

Create Environment From Project -> { environment }
post/gitpod.v1.EnvironmentService/CreateEnvironmentFromProject

CreateAbdStartEnvironmentFromProject creates a new environment from a project and starts it.

Create Environment Logs Token -> { accessToken }
post/gitpod.v1.EnvironmentService/CreateEnvironmentLogsToken

CreateEnvironmentLogsToken creates a token that can be used to access the logs of an environment.

Delete Environment -> unknown
post/gitpod.v1.EnvironmentService/DeleteEnvironment

DeleteEnvironment deletes an environment. When the environment is running, it will be stopped as well. Deleted environments cannot be started again.

Security
Bearer Auth

Example: Authorization: Bearer My Bearer Token

Request example
200Example
List Environments -> EnvironmentsPage<{ id, metadata, spec, 1 more... }>
post/gitpod.v1.EnvironmentService/ListEnvironments

ListEnvironments returns a list of environments that match the query.

Mark Environment Active -> unknown
post/gitpod.v1.EnvironmentService/MarkEnvironmentActive

MarkEnvironmentActive allows tools to signal activity for an environment.

Get Environment -> { environment }
post/gitpod.v1.EnvironmentService/GetEnvironment

GetEnvironment returns a single environment.

+return NOT_FOUND User does not have access to an environment with the given ID +return NOT_FOUND Environment does not exist

Start Environment -> unknown
post/gitpod.v1.EnvironmentService/StartEnvironment

StartEnvironment starts an environment. This function is idempotent, i.e. if the environment is already running no error is returned.

Stop Environment -> unknown
post/gitpod.v1.EnvironmentService/StopEnvironment

StopEnvironment stops a running environment.

Update Environment -> unknown
post/gitpod.v1.EnvironmentService/UpdateEnvironment

UpdateEnvironment updates the environment partially.

Environments

Automations

environments.automations

Methods

Upsert Automations File -> { updatedServiceIds, updatedTaskIds }
post/gitpod.v1.EnvironmentAutomationService/UpsertAutomationsFile

UpsertAutomationsFile upserts the automations file for the given environment.

EnvironmentsAutomations

Services

environments.automations.services

Methods

Create Service -> { service }
post/gitpod.v1.EnvironmentAutomationService/CreateService

CreateService

Delete Service -> unknown
post/gitpod.v1.EnvironmentAutomationService/DeleteService

DeleteService deletes a service. This call does not block until the service is deleted. If the service is not stopped it will be stopped before deletion.

List Services -> ServicesPage<{ id, environmentId, metadata, 2 more... }>
post/gitpod.v1.EnvironmentAutomationService/ListServices

ListServices

Get Service -> { service }
post/gitpod.v1.EnvironmentAutomationService/GetService

GetService

Start Service -> unknown
post/gitpod.v1.EnvironmentAutomationService/StartService

StartService starts a service. This call does not block until the service is started. This call will not error if the service is already running or has been started.

Stop Service -> unknown
post/gitpod.v1.EnvironmentAutomationService/StopService

StopService stops a 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.

Update Service -> unknown
post/gitpod.v1.EnvironmentAutomationService/UpdateService

UpdateService

EnvironmentsAutomations

Tasks

environments.automations.tasks

Methods

Create Task -> { task }
post/gitpod.v1.EnvironmentAutomationService/CreateTask

CreateTask

Delete Task -> unknown
post/gitpod.v1.EnvironmentAutomationService/DeleteTask

DeleteTask

List Tasks -> TasksPage<{ id, dependsOn, environmentId, 2 more... }>
post/gitpod.v1.EnvironmentAutomationService/ListTasks

ListTasks

Get Task -> { task }
post/gitpod.v1.EnvironmentAutomationService/GetTask

GetTask

Start Task -> { taskExecution }
post/gitpod.v1.EnvironmentAutomationService/StartTask

StartTask starts a task, i.e. creates a task execution. This call does not block until the task is started; the task will be started asynchronously.

Update Task -> unknown
post/gitpod.v1.EnvironmentAutomationService/UpdateTask

UpdateTask

EnvironmentsAutomationsTasks

Executions

environments.automations.tasks.executions

Methods

List Task Executions -> TaskExecutionsPage<{ id, metadata, spec, 1 more... }>
post/gitpod.v1.EnvironmentAutomationService/ListTaskExecutions

ListTaskExecutions

Get Task Execution -> { taskExecution }
post/gitpod.v1.EnvironmentAutomationService/GetTaskExecution

GetTaskExecution

Stop Task Execution -> unknown
post/gitpod.v1.EnvironmentAutomationService/StopTaskExecution

StopTaskExecution

Environments

Classes

environments.classes

Methods

List Environment Classes -> EnvironmentClassesPage<{ id, configuration, description, 3 more... }>
post/gitpod.v1.EnvironmentService/ListEnvironmentClasses

ListEnvironmentClasses returns the list of environment classes with runner details a user is able to use based on the query buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE