GetEditor

client.Editors.Get(ctx, body) (*EditorGetResponse, error)

POST/gitpod.v1.EditorService/GetEditor

Gets details about a specific editor.

Use this method to:

View editor information
Get editor configuration

Examples

Get editor details:

Retrieves information about a specific editor.
```
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

ParametersExpand Collapse

body EditorGetParams

ID param.Field[string]

id is the ID of the editor to get

ReturnsExpand Collapse

type EditorGetResponse struct{…}

Editor Editor

editor contains the editor

ID string

formatuuid

InstallationInstructions string

Name string

URLTemplate string

Alias stringOptional

IconURL stringOptional

ShortDescription stringOptional

Versions []EditorVersionOptional

versions contains the list of available versions for this editor

Version string

version is the version string of the editor Examples for JetBrains: 2025.2

GetEditor

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  editor, err := client.Editors.Get(context.TODO(), gitpod.EditorGetParams{
    ID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", editor.Editor)
}

{
  "editor": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "installationInstructions": "installationInstructions",
    "name": "name",
    "urlTemplate": "urlTemplate",
    "alias": "alias",
    "iconUrl": "iconUrl",
    "shortDescription": "shortDescription",
    "versions": [
      {
        "version": "version"
      }
    ]
  }
}

Returns Examples

{
  "editor": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "installationInstructions": "installationInstructions",
    "name": "name",
    "urlTemplate": "urlTemplate",
    "alias": "alias",
    "iconUrl": "iconUrl",
    "shortDescription": "shortDescription",
    "versions": [
      {
        "version": "version"
      }
    ]
  }
}