Sign in
gitpod.v1.ProjectService

UpdateProject

Updates a project's configuration.

Use this method to:

  • Modify project settings
  • Update environment class
  • Change project name
  • Configure initializers
  • Configure prebuild settings

Examples

  • Update project name:

    Changes the project's display name.

    projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
name: "New Project Name"

  • Enable prebuilds with daily schedule:

    Configures prebuilds to run daily at 2 AM UTC.

    projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
prebuildConfiguration:
  enabled: true
  environmentClassIds:
    - "b0e12f6c-4c67-429d-a4a6-d9838b5da041"
  timeout: "3600s"
  trigger:
    dailySchedule:
      hourUtc: 2
post/gitpod.v1.ProjectService/UpdateProject

Request body

automationsFilePathstring nullable

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 nullable

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 — unresolved $ref
namestring nullable
projectIdstring uuid

project_id specifies the project identifier

technicalDescriptionstring nullable

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