Skip to content
Ona API Reference
Ona Docs
API Reference
Editors

GetEditor

editors.retrieve(EditorRetrieveParams**kwargs) -> EditorRetrieveResponse
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
id: str

id is the ID of the editor to get

ReturnsExpand Collapse
class EditorRetrieveResponse: …
editor: Editor

editor contains the editor

id: str
formatuuid
installation_instructions: str
name: str
url_template: str
alias: Optional[str]
icon_url: Optional[str]
short_description: Optional[str]
versions: Optional[List[EditorVersion]]

versions contains the list of available versions for this editor

version: str

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

GetEditor

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
editor = client.editors.retrieve(
    id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(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"
      }
    ]
  }
}