Skip to main content
Unary · Environments Creates an environment from an existing project configuration and starts it. This method uses project settings as defaults but allows overriding specific configurations. Project settings take precedence over default configurations, while custom specifications in the request override project settings.

Examples

  • Create with project defaults: Creates an environment using all default settings from the project configuration.
  • Create with custom compute resources: Creates an environment from project with custom machine class and timeout settings.

Endpoint

Send a Bearer token as described in Authentication. If your organization uses a custom management-plane domain, replace https://app.ona.com with that domain.

Request example

Request

gitpod.v1.CreateEnvironmentFromProjectRequest

Response

gitpod.v1.CreateEnvironmentFromProjectResponse
gitpod.v1.Environment
EnvironmentMetadata is data associated with an environment that’s required for other parts of the system to functiongitpod.v1.EnvironmentMetadata
EnvironmentSpec specifies the configuration of an environment for an environment startgitpod.v1.EnvironmentSpec
gitpod.v1.EnvironmentSpec.AutomationsFile
gitpod.v1.EnvironmentSpec.Content
gitpod.v1.EnvironmentSpec.DevContainer
gitpod.v1.EnvironmentSpec.EnvironmentPort
gitpod.v1.EnvironmentSpec.Machine
gitpod.v1.EnvironmentSpec.SSHPublicKey
gitpod.v1.EnvironmentSpec.Secret
Timeout configures the environment timeoutgitpod.v1.EnvironmentSpec.Timeout
EnvironmentStatus describes an environment statusgitpod.v1.EnvironmentStatus
KernelControlsConfig configures kernel-level controls for the environmentgitpod.v1.KernelControlsConfig
Admission level describes who can access an environment instance and its ports.
BPFDebugLevel controls the verbosity of BPF trace_pipe output (bpf_printk). Applies to all BPF-based agents (veto exec, future agents).
EnvironmentRole represents the role of an environment
LifecycleStage controls which devcontainer lifecycle commands are executed. See https://containers.dev/implementors/json_reference/#lifecycle-scripts
Protocol describes the communication protocol between Gateway and user environment services.
Scope indicates the origin of the secret for filtering purposes.