Sign in
gitpod.v1.ProjectService

CreateProject

Creates a new project with specified configuration.

Use this method to:

  • Set up development projects
  • Configure project environments
  • Define project settings
  • Initialize project content

Examples

  • Create basic project:

    Creates a project with minimal configuration.

    name: "Web Application"
initializer:
  specs:
    - git:
        remoteUri: "https://github.com/org/repo"

  • Create project with devcontainer:

    Creates a project with custom development container.

    name: "Backend Service"
initializer:
  specs:
    - git:
        remoteUri: "https://github.com/org/backend"
devcontainerFilePath: ".devcontainer/devcontainer.json"
automationsFilePath: ".gitpod/automations.yaml"
post/gitpod.v1.ProjectService/CreateProject

Request body

automationsFilePathstring

automations_file_path is the path to the automations file relative to the repo root path must not be absolute (start with a /):

this.matches('^$|^[^/].*')
devcontainerFilePathstring

devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /):

this.matches('^$|^[^/].*')
initializerGitpodV1EnvironmentInitializer required— unresolved $ref
namestring
technicalDescriptionstring

technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses 8KB max

Response

Success

projectGitpodV1Project — unresolved $ref

Changes