Gitpod · Example Payload

Gitpod Create Environment Example

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 classe

Developer ToolsCloud Development EnvironmentsWorkspacesAI AgentsDevOps

Gitpod Create Environment Example is an example object payload from Gitpod, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationdescriptionrequest_example_namerequest_examplerequest_schema

Example Payload

{
  "operation": "gitpod.v1.EnvironmentService.CreateEnvironment",
  "description": "Creates a development environment from a context URL (e.g. Git repository) and starts it.\n\n The `class` field must be a valid environment class ID. You can find a list of\n available environment classe",
  "request_example_name": "create_from_context_url",
  "request_example": {
    "spec": {
      "content": {
        "initializer": {
          "specs": [
            {
              "contextUrl": {
                "url": "https://github.com/gitpod-io/gitpod"
              }
            }
          ]
        }
      },
      "machine": {
        "class": "d2c94c27-3b76-4a42-b88c-95a85e392c68"
      }
    }
  },
  "request_schema": {
    "$ref": "#/components/schemas/gitpod.v1.CreateEnvironmentRequest"
  }
}