Sign in
gitpod.v1.EnvironmentService

CreateEnvironmentFromProject

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.

    projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"

  • Create with custom compute resources:

    Creates an environment from project with custom machine class and timeout settings.

    projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
spec:
  machine:
    class: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  timeout:
    disconnected: "14400s"  # 4 hours in seconds
post/gitpod.v1.EnvironmentService/CreateEnvironmentFromProject

Request body

annotationsobject

annotations are key/value pairs attached to the environment metadata.

namestring nullable

name is a user-defined identifier for the environment. If not specified, the system will generate a name.

projectIdstring uuid
sessionIdstring uuid

session_id is the ID of the session this environment belongs to. If empty, a new session is created implicitly.

specGitpodV1EnvironmentSpec — unresolved $ref

Response

Success

Changes