Skip to main content
Unary · Environments Creates a development environment from a context URL (e.g. Git repository) and starts it. The class field must be a valid environment class ID. You can find a list of available environment classes with the ListEnvironmentClasses method.

Examples

  • Create from context URL: Creates an environment from a Git repository URL with default settings.
  • Create from Git repository: Creates an environment from a Git repository with specific branch targeting.
  • Create with custom timeout and ports: Creates an environment with custom inactivity timeout and exposed port configuration.

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.CreateEnvironmentRequest Required fields:
  • metadata.organization_id
  • metadata.configuration_id

Response

gitpod.v1.CreateEnvironmentResponse
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.