Gitpod Documentation | Projects

Projects

projects

Methods

Create Project -> { project }

post/gitpod.v1.ProjectService/CreateProject

CreateProject creates a new Project.

Create Project From Environment -> { project }

post/gitpod.v1.ProjectService/CreateProjectFromEnvironment

CreateProject creates a new Project using an environment as template.

Delete Project -> unknown

post/gitpod.v1.ProjectService/DeleteProject

DeleteProject deletes the specified project.

List Projects -> ProjectsPage<{ environmentClass, id, automationsFilePath, 4 more... }>

post/gitpod.v1.ProjectService/ListProjects

ListProjects lists all projects the caller has access to.

Get Project -> { project }

post/gitpod.v1.ProjectService/GetProject

GetProject retrieves a single Project.

Update Project -> { project }

post/gitpod.v1.ProjectService/UpdateProject

UpdateProject updates the properties of a Project.

Security

Bearer Auth

Example: Authorization: Bearer My Bearer Token

Response fields

project: { environmentClass, id, automationsFilePath, 4 more... }

Optional

Request example

curl https://app.gitpod.io/api/gitpod.v1.ProjectService/UpdateProject \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{
      "automationsFilePath": "automationsFilePath"
    }'

200Example

{
  "project": {
    "environmentClass": {
      "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    },
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "automationsFilePath": "automationsFilePath",
    "devcontainerFilePath": "devcontainerFilePath",
    "initializer": {
      "specs": [
        {
          "contextUrl": {
            "url": "https://example.com"
          }
        }
      ]
    },
    "metadata": {
      "createdAt": "2019-12-27T18:11:19.117Z",
      "creator": {
        "id": "id",
        "principal": "PRINCIPAL_UNSPECIFIED"
      },
      "name": "x",
      "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updatedAt": "2019-12-27T18:11:19.117Z"
    },
    "usedBy": {
      "subjects": [
        {
          "id": "id",
          "principal": "PRINCIPAL_UNSPECIFIED"
        }
      ],
      "totalSubjects": 0
    }
  }
}

Projects

Policies

projects.policies

Methods

Create Project Policy -> { policy }

post/gitpod.v1.ProjectService/CreateProjectPolicy

CreateProjectPolicy creates a Project Policy.

Delete Project Policy -> unknown

post/gitpod.v1.ProjectService/DeleteProjectPolicy

DeleteProjectPolicy deletes a Project Policy.

List Project Policies -> PoliciesPage<{ groupId, role }>

post/gitpod.v1.ProjectService/ListProjectPolicies

ListProjectPolicies lists policies for a project.

Update Project Policy -> { policy }

post/gitpod.v1.ProjectService/UpdateProjectPolicy

UpdateProjectPolicy updates a Project Policy.