GetEditor

client.editors.retrieve(, ?): EditorRetrieveResponse { editor }

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: EditorRetrieveParams { id }

id: string

id is the ID of the editor to get

ReturnsExpand Collapse

EditorRetrieveResponse { editor }

editor: Editor { id, installationInstructions, name, 5 more }

editor contains the editor

id: string

formatuuid

installationInstructions: string

name: string

urlTemplate: string

alias?: string

iconUrl?: string

shortDescription?: string

versions?: Array<EditorVersion { version } >

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

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const editor = await client.editors.retrieve({ id: 'd2c94c27-3b76-4a42-b88c-95a85e392c68' });

console.log(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"
      }
    ]
  }
}